Struct MetricDesc

Defined in File metrics/types.h

Struct Documentation

struct MetricDesc

Structure that contains general information about a metric.

Public Types

enum StringLength

Values:

enumerator kUriLength

enumerator kNameLength

enumerator kDescriptionLength

enumerator kUnitsLength

enumerator kSymbolicNameLength

enumerator kGroupLength

enumerator kSymbolicName

Public Functions

inline bool IsNormalizedUnits() const

Public Members

uint32_t index: Global metric index, within associated IMetricsSource object. For an uninstantiated metric prototype or an unprepared instantiated one, it will be kInvalidMetricIndex.

uint32_t groupId: Associated group index, within associated IMetricsSource object. For an uninstantiated metric prototype or an unprepared instantiated one, it will be kInvalidGroupIndex.

Type type: Logical type of metric data.

char uri[StringLength::kUriLength]: Uniform Resource Identifier.

char name[StringLength::kNameLength]: User-friendly name.

char description[StringLength::kDescriptionLength]

char units[StringLength::kUnitsLength]: Units used by this metric.

char symbolicName[StringLength::kSymbolicNameLength]

char group[StringLength::kGroupLength]: Metric group for organizing metrics in the user interface.

Category category: Metric categorization.

uint32_t optionCount: Number of initialized elements in pOptionArray.

MetricOption *pOptionArray: Array of MetricOption structures.