SST  6.1.0
StructuralSimulationToolkit
SST::Statistics::StatisticOutputHDF5 Class Reference

The class for statistics output to a comma separated file.
More...

#include <statoutputhdf5.h>

Inheritance diagram for SST::Statistics::StatisticOutputHDF5:
SST::Statistics::StatisticOutput SST::Module

Public Member Functions

 StatisticOutputHDF5 (Params &outputParameters)
 Construct a StatOutputHDF5. More...
 
- Public Member Functions inherited from SST::Statistics::StatisticOutput
 StatisticOutput (Params &outputParameters)
 Construct a base StatisticOutput. More...
 
std::string & getStatisticOutputName ()
 Return the Statistic Output name.
 
uint8_t getStatisticLoadLevel ()
 Return the statistics load level for the system.
 
ParamsgetOutputParameters ()
 Return the parameters for the StatisticOutput.
 
template<typename T >
fieldHandle_t registerField (const char *fieldName)
 Register a field to be output (templated function) More...
 
StatisticFieldInfogetRegisteredField (fieldHandle_t fieldHandle)
 Adjust the heirarchy of the fields (FUTURE SUPPORT) More...
 
template<typename T >
StatisticFieldInfogetRegisteredField (const char *statisticName, const char *fieldName)
 Return the information on a registered field via known names. More...
 
FieldInfoArray_t & getFieldInfoArray ()
 Return the array of registered field infos. More...
 
void outputField (fieldHandle_t fieldHandle, int32_t data)
 Output field data. More...
 
void outputField (fieldHandle_t fieldHandle, uint32_t data)
 
void outputField (fieldHandle_t fieldHandle, int64_t data)
 
void outputField (fieldHandle_t fieldHandle, uint64_t data)
 
void outputField (fieldHandle_t fieldHandle, float data)
 
void outputField (fieldHandle_t fieldHandle, double data)
 
const char * getFieldTypeShortName (fieldType_t type)
 Output field data. More...
 

Protected Member Functions

bool checkOutputParameters ()
 Perform a check of provided parameters. More...
 
void printUsage ()
 Print out usage for this Statistic Output.
 
void implStartRegisterFields (StatisticBase *stat)
 
void implRegisteredField (fieldHandle_t fieldHandle)
 
void implStopRegisterFields ()
 
void startOfSimulation ()
 Indicate to Statistic Output that simulation started. More...
 
void endOfSimulation ()
 Indicate to Statistic Output that simulation ended. More...
 
void implStartOutputEntries (StatisticBase *statistic)
 Implementation function for the start of output. More...
 
void implStopOutputEntries ()
 Implementation function for the end of output. More...
 
void implOutputField (fieldHandle_t fieldHandle, int32_t data)
 Implementation functions for output. More...
 
void implOutputField (fieldHandle_t fieldHandle, uint32_t data)
 
void implOutputField (fieldHandle_t fieldHandle, int64_t data)
 
void implOutputField (fieldHandle_t fieldHandle, uint64_t data)
 
void implOutputField (fieldHandle_t fieldHandle, float data)
 
void implOutputField (fieldHandle_t fieldHandle, double data)
 
- Protected Member Functions inherited from SST::Statistics::StatisticOutput
friend int::main (int argc, char **argv)
 
void setStatisticOutputName (std::string name)
 
void lock ()
 
void unlock ()
 

Additional Inherited Members

- Public Types inherited from SST::Statistics::StatisticOutput
typedef StatisticFieldInfo::fieldType_t fieldType_t
 
typedef StatisticFieldInfo::fieldHandle_t fieldHandle_t
 
typedef std::vector< StatisticFieldInfo * > FieldInfoArray_t
 
typedef std::unordered_map< std::string, fieldHandle_t > FieldNameMap_t
 

Detailed Description

The class for statistics output to a comma separated file.

Constructor & Destructor Documentation

SST::Statistics::StatisticOutputHDF5::StatisticOutputHDF5 ( Params outputParameters)

Construct a StatOutputHDF5.

Parameters
outputParameters- Parameters used for this Statistic Output

References SST::Simulation::getSimulationOutput(), and SST::Output::verbose().

Member Function Documentation

bool SST::Statistics::StatisticOutputHDF5::checkOutputParameters ( )
protectedvirtual

Perform a check of provided parameters.

Returns
True if all required parameters and options are acceptable

Implements SST::Statistics::StatisticOutput.

References SST::Params::find(), and SST::Statistics::StatisticOutput::getOutputParameters().

void SST::Statistics::StatisticOutputHDF5::endOfSimulation ( )
protectedvirtual

Indicate to Statistic Output that simulation ended.

Statistic output may perform any shutdown code here as necessary.

Implements SST::Statistics::StatisticOutput.

void SST::Statistics::StatisticOutputHDF5::implOutputField ( fieldHandle_t  fieldHandle,
int32_t  data 
)
protectedvirtual

Implementation functions for output.

These will be called by the statistic to provide Statistic defined data to be output.

Parameters
fieldHandle- The handle to the registered statistic field.
data- The data related to the registered field to be output.

Implements SST::Statistics::StatisticOutput.

void SST::Statistics::StatisticOutputHDF5::implStartOutputEntries ( StatisticBase statistic)
protectedvirtual

Implementation function for the start of output.

This will be called by the Statistic Processing Engine to indicate that a Statistic is about to send data to the Statistic Output for processing.

Parameters
statistic- Pointer to the statistic object than the output can retrieve data from.

Implements SST::Statistics::StatisticOutput.

void SST::Statistics::StatisticOutputHDF5::implStopOutputEntries ( )
protectedvirtual

Implementation function for the end of output.

This will be called by the Statistic Processing Engine to indicate that a Statistic is finished sendind data to the Statistic Output for processing. The Statisic Output can perform any output related functions here.

Implements SST::Statistics::StatisticOutput.

void SST::Statistics::StatisticOutputHDF5::startOfSimulation ( )
protectedvirtual

Indicate to Statistic Output that simulation started.

Statistic output may perform any startup code here as necessary.

Implements SST::Statistics::StatisticOutput.


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