PEARL
Parallel Event Access and Replay Library
Public Types | List of all members
pearl::Metric Class Reference

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

#include <pearl/Metric.h>

Public Types

typedef uint32_t IdType
 Metric definition identifier type. More...
 

Public Member Functions

Constructors & destructor
 Metric (IdType id, const std::string &name, const std::string &description, const std::string &type, const std::string &mode, const std::string &interval)
 
Get metric information
IdType getId () const
 
std::string get_name () const
 
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].

Member Typedef Documentation

◆ IdType

typedef uint32_t pearl::Metric::IdType

Constructor & Destructor Documentation

◆ Metric()

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

Member Function Documentation

◆ get_description()

std::string pearl::Metric::get_description ( ) const

◆ get_interval()

std::string pearl::Metric::get_interval ( ) const

◆ get_mode()

std::string pearl::Metric::get_mode ( ) const

◆ get_name()

std::string pearl::Metric::get_name ( ) const

◆ get_type()

std::string pearl::Metric::get_type ( ) const

◆ getId()

IdType pearl::Metric::getId ( ) const

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

Scalasca    Copyright © 1998–2019 Forschungszentrum Jülich GmbH, Jülich Supercomputing Centre
Copyright © 2009–2015 German Research School for Simulation Sciences GmbH, Laboratory for Parallel Programming