Metric Class Reference
[PEARL.base]

Stores information related to additional performance metrics. More...

#include <Metric.h>

Inheritance diagram for Metric:

NamedObject IdObject

List of all members.

Public Member Functions

Constructors & destructor
 Metric (ident_t id, const std::string &name, const std::string &description, const std::string &type, const std::string &mode, const std::string &interval)
Get metric information
std::string get_description () const
std::string get_type () const
std::string get_mode () const
std::string get_interval () const


Detailed Description

The instances of the Metric class provide information about additional performance metrics, such as event counts, event rates, or sample values. Please also read the section on performance metrics in the EPILOG specification for further information.

The numerical identifiers of the individual metrics are globally defined and continuously enumerated, i.e., the ID is element of [0,#metrics-1].


Constructor & Destructor Documentation

Metric ( ident_t  id,
const std::string &  name,
const std::string &  description,
const std::string &  type,
const std::string &  mode,
const std::string &  interval 
)

Creates a new instance and initializes the data with the given values.

Parameters:
id Metric identifier
name Metric name
description Description text of the performance metric
type Metric type, either "INTEGER" or "FLOAT"
mode Metric mode, either "COUNTER", "RATE", or "SAMPLE"
interval Measurement interval semantics, either "START", "LAST", "NEXT", or "NONE"
Exceptions:
FatalError if one of the parameters type, mode, or interval contains an invalid value


Member Function Documentation

string get_description (  )  const

Returns the description text given for this performance metric.

Returns:
Description

string get_interval (  )  const

Returns the measurement interval semantics, which is either "START", "LAST", "NEXT", or "NONE".

Returns:
Measurement interval semantics

string get_mode (  )  const

Returns the metric mode, which is either "COUNTER", "RATE", or "SAMPLE".

Returns:
Metric mode

string get_type (  )  const

Returns the metric type, which is either "INTEGER" or "FLOAT".

Returns:
Metric type


SCALASCA    Copyright © 1998–2009 Forschungszentrum Jülich, Jülich Supercomputing Centre