SST  6.0.0
StructuralSimulationToolkit
SST::Statistics::BaseStatistic Class Reference
Inheritance diagram for SST::Statistics::BaseStatistic:
SST::Statistics::Accumulator SST::Statistics::Histogram< HistoBinType, HistoCountType >

Public Member Functions

 BaseStatistic (std::string statName)
 Constructor for the BaseStatistics class. More...
 
 BaseStatistic (char *statName)
 Constructor for the BaseStatistic class. More...
 
const char * getName ()
 Get the name of the statistic. More...
 
void enable ()
 Enable the statistic for collection.
 
void disable ()
 Disable the statistic collection.
 
bool isEnabled ()
 Query whether the statistic is currently enabled. More...
 

Protected Attributes

char * name
 
bool enabled
 

Constructor & Destructor Documentation

SST::Statistics::BaseStatistic::BaseStatistic ( std::string  statName)
inline

Constructor for the BaseStatistics class.

In this for the string provided is copied into a buffer within the class (which consumes memory, for statistics with many components callers may want to use the alternative constructor which provides a pointer that is not copied). Default is for the statistic to be created enabled for use

Parameters
SST::Statistics::BaseStatistic::BaseStatistic ( char *  statName)
inline

Constructor for the BaseStatistic class.

This form of the constructor takes a pointer and does NOT perform a copy of the string (i.e. assumes that the pointer will remain live for the duration of the statistic's use). Default is for the statistic to be created enabled for use

Parameters

Member Function Documentation

const char* SST::Statistics::BaseStatistic::getName ( )
inline

Get the name of the statistic.

Returns
The name of the statistic
bool SST::Statistics::BaseStatistic::isEnabled ( )
inline

Query whether the statistic is currently enabled.

Returns
true if the statistics collection is currently enabled, otherwise false

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