MetroCollect::MetricsSource::FieldInfo Struct Reference

Object used to describe a field (or metric) More...

#include <SourceField.h>

Collaboration diagram for MetroCollect::MetricsSource::FieldInfo:

Classes
struct	IndexAndDescription

Public Member Functions
	FieldInfo ()
	Construct a new Field Info object. More...
	FieldInfo (FieldName aName, std::string aDescription, std::string aUnit)
	Construct a new Field Info object. More...
	FieldInfo (FieldName aName, std::string aDescription, std::string aUnit, size_t anIndex, std::string aDynamicDescription)
	Construct a new Field Info object. More...
bool	isDynamic ()
	Checks if the field name contains any dynamic part. More...

Public Attributes
FieldName	name
	Name of the field. More...
std::string	description
	Description of the field. More...
std::string	unit
	Unit of the field's metric. More...
std::vector< IndexAndDescription >	dynamicIndexes
	Indexes and descriptions of the dynamic parts of the field name. More...

Detailed Description

Object used to describe a field (or metric)

Definition at line 37 of file SourceField.h.

Constructor & Destructor Documentation

FieldInfo() [1/3]

MetroCollect::MetricsSource::FieldInfo::FieldInfo ( )

inline

Construct a new Field Info object.

Definition at line 54 of file SourceField.h.

FieldInfo() [2/3]

MetroCollect::MetricsSource::FieldInfo::FieldInfo ( FieldName  aName, std::string  aDescription, std::string  aUnit  )

inline

Construct a new Field Info object.

Parameters

aName	name of the field
aDescription	description of the field
aUnit	unit of the field

Definition at line 63 of file SourceField.h.

FieldInfo() [3/3]

MetroCollect::MetricsSource::FieldInfo::FieldInfo ( FieldName  aName, std::string  aDescription, std::string  aUnit, size_t  anIndex, std::string  aDynamicDescription  )

inline

Construct a new Field Info object.

Parameters

aName	name of the field
aDescription	description of the field
aUnit	unit of the field
anIndex	index of the dynamic part in the field name
aDynamicDescription	description of the dynamic field name part

Definition at line 75 of file SourceField.h.

Member Function Documentation

isDynamic()

bool MetroCollect::MetricsSource::FieldInfo::isDynamic ( )

inline

Checks if the field name contains any dynamic part.

Returns

true if the field name has at least one dynamic part

false otherwise

Definition at line 85 of file SourceField.h.

Member Data Documentation

description

std::string MetroCollect::MetricsSource::FieldInfo::description

Description of the field.

Definition at line 46 of file SourceField.h.

dynamicIndexes

std::vector<IndexAndDescription> MetroCollect::MetricsSource::FieldInfo::dynamicIndexes

Indexes and descriptions of the dynamic parts of the field name.

Definition at line 48 of file SourceField.h.

name

FieldName MetroCollect::MetricsSource::FieldInfo::name

Name of the field.

Definition at line 45 of file SourceField.h.

unit

std::string MetroCollect::MetricsSource::FieldInfo::unit

Unit of the field's metric.

Definition at line 47 of file SourceField.h.

---

The documentation for this struct was generated from the following file:

• MetroCollect/SourceField.h