7.0 (revision 7784de1c)
Data Fields
SCOREP_Metric_Plugin_MetricProperties Struct Reference

Properties describing a metric. Provided by the get_event_info function. More...

#include <SCOREP_MetricPlugins.h>

Data Fields

SCOREP_MetricBase base
 
char * description
 
int64_t exponent
 
SCOREP_MetricMode mode
 
char * name
 
char * unit
 
SCOREP_MetricValueType value_type
 

Detailed Description

Properties describing a metric. Provided by the get_event_info function.

Examples:
hello_world.c.

Field Documentation

SCOREP_MetricBase SCOREP_Metric_Plugin_MetricProperties::base

Base of metric: decimal, binary

Examples:
hello_world.c.
char* SCOREP_Metric_Plugin_MetricProperties::description

Additional information about the metric

Examples:
hello_world.c.
int64_t SCOREP_Metric_Plugin_MetricProperties::exponent

Exponent to scale metric: e.g., 3 for kilo

Examples:
hello_world.c.
SCOREP_MetricMode SCOREP_Metric_Plugin_MetricProperties::mode

Metric mode: valid combination of ACCUMULATED|ABSOLUTE|RELATIVE + POINT|START|LAST|NEXT

See also
SCOREP_MetricMode
Examples:
hello_world.c.
char* SCOREP_Metric_Plugin_MetricProperties::name

Plugin name

Examples:
hello_world.c.
char* SCOREP_Metric_Plugin_MetricProperties::unit

Unit string of recorded metric

Examples:
hello_world.c.
SCOREP_MetricValueType SCOREP_Metric_Plugin_MetricProperties::value_type

Value type: signed 64 bit integer, unsigned 64 bit integer, double

Examples:
hello_world.c.

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