SST  14.0.0
StructuralSimulationToolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends
SST::Statistics::StatisticOutput Class Referenceabstract

Forms the base class for statistics output generation within the SST core. More...

#include <statoutput.h>

Inheritance diagram for SST::Statistics::StatisticOutput:
SST::Statistics::StatisticFieldsOutput SST::Statistics::StatisticOutputCSV SST::Statistics::StatisticOutputHDF5 SST::Statistics::StatisticOutputJSON SST::Statistics::StatisticOutputTextBase SST::Statistics::StatisticOutputConsole SST::Statistics::StatisticOutputTxt

Public Types

using fieldType_t = StatisticFieldInfo::fieldType_t
 
using fieldHandle_t = StatisticFieldInfo::fieldHandle_t
 
using FieldInfoArray_t = std::vector< StatisticFieldInfo * >
 
using FieldNameMap_t = std::unordered_map< std::string, fieldHandle_t >
 

Public Member Functions

std::string & getStatisticOutputName ()
 Return the Statistic Output name.
 
Params & getOutputParameters ()
 Return the parameters for the StatisticOutput.
 
virtual bool acceptsGroups () const
 True if this StatOutput can handle StatisticGroups.
 
virtual void output (StatisticBase *statistic, bool endOfSimFlag)=0
 
virtual bool supportsDynamicRegistration () const
 

Static Public Member Functions

static const std::vector< SST::ElementInfoParam > & ELI_getParams ()
 

Protected Member Functions

virtual bool checkOutputParameters ()=0
 Have the Statistic Output check its parameters. More...
 
virtual void printUsage ()=0
 Have Statistic Object print out its usage and parameter info. More...
 
virtual void startOfSimulation ()=0
 Indicate to Statistic Output that simulation has started. More...
 
virtual void endOfSimulation ()=0
 Indicate to Statistic Output that simulation has ended. More...
 
Output & getSimulationOutput ()
 Gets the Output object for the Simulation object associeted with this StatOutput. More...
 
RankInfo getNumRanks ()
 Gets the number of ranks for the simulation.
 
RankInfo getRank ()
 Gets the Rank (MPI rank and thread) that this StatisticOutput is associated with. More...
 
SimTime_t getCurrentSimCycle ()
 Gets the current simulstion cycle.
 
 StatisticOutput (Params &outputParameters)
 Construct a base StatisticOutput. More...
 
void setStatisticOutputName (const std::string &name)
 
void lock ()
 
void unlock ()
 

Friends

class SST::Simulation
 
class SST::Statistics::StatisticProcessingEngine
 

Detailed Description

Forms the base class for statistics output generation within the SST core.

Statistics are gathered by the statistic objects and then processed sent to the derived output object either periodically or by event and/or also at the end of the simulation. A single statistic output will be created by the simulation (per node) and will collect the data per its design.

Constructor & Destructor Documentation

◆ StatisticOutput()

SST::Statistics::StatisticOutput::StatisticOutput ( Params &  outputParameters)
protected

Construct a base StatisticOutput.

Parameters
outputParameters- The parameters for the statistic Output.

Member Function Documentation

◆ checkOutputParameters()

virtual bool SST::Statistics::StatisticOutput::checkOutputParameters ( )
protectedpure virtual

Have the Statistic Output check its parameters.

Returns
True if all parameters are ok; False if a parameter is missing or incorrect.

Implemented in SST::Statistics::StatisticOutputCSV, SST::Statistics::StatisticOutputJSON, and SST::Statistics::StatisticOutputTextBase.

◆ endOfSimulation()

virtual void SST::Statistics::StatisticOutput::endOfSimulation ( )
protectedpure virtual

Indicate to Statistic Output that simulation has ended.

Allows object to perform any shutdown required.

Implemented in SST::Statistics::StatisticOutputCSV, SST::Statistics::StatisticOutputJSON, and SST::Statistics::StatisticOutputTextBase.

◆ getRank()

RankInfo SST::Statistics::StatisticOutput::getRank ( )
protected

Gets the Rank (MPI rank and thread) that this StatisticOutput is associated with.

References SST::Simulation_impl::getRank(), and SST::Simulation_impl::getSimulation().

Referenced by SST::Statistics::StatisticOutputTextBase::implStartOutputEntries(), SST::Statistics::StatisticOutputCSV::implStopOutputEntries(), SST::Statistics::StatisticOutputTextBase::startOfSimulation(), SST::Statistics::StatisticOutputJSON::startOfSimulation(), and SST::Statistics::StatisticOutputCSV::startOfSimulation().

◆ getSimulationOutput()

Output & SST::Statistics::StatisticOutput::getSimulationOutput ( )
protected

Gets the Output object for the Simulation object associeted with this StatOutput.

References SST::Simulation_impl::getSimulationOutput().

◆ printUsage()

virtual void SST::Statistics::StatisticOutput::printUsage ( )
protectedpure virtual

Have Statistic Object print out its usage and parameter info.

Called when checkOutputParameters() returns false

Implemented in SST::Statistics::StatisticOutputCSV, SST::Statistics::StatisticOutputJSON, and SST::Statistics::StatisticOutputTextBase.

◆ startOfSimulation()

virtual void SST::Statistics::StatisticOutput::startOfSimulation ( )
protectedpure virtual

Indicate to Statistic Output that simulation has started.

Allows object to perform any setup required.

Implemented in SST::Statistics::StatisticOutputCSV, SST::Statistics::StatisticOutputJSON, and SST::Statistics::StatisticOutputTextBase.

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