SST  13.0.0
StructuralSimulationToolkit
SST::Statistics::StatisticProcessingEngine Class Reference

An SST core component that handles timing and event processing informing all registered Statistics to generate their outputs at desired rates. More...

#include <statengine.h>

Public Member Functions

void performStatisticOutput (StatisticBase *stat, bool endOfSimFlag=false)
 Called by the Components and Subcomponent to perform a statistic Output. More...
 
void performGlobalStatisticOutput (bool endOfSimFlag=false)
 Called by the Components and Subcomponent to perform a global statistic Output. More...
 
template<class T >
Statistic< T > * createStatistic (BaseComponent *comp, const std::string &type, const std::string &statName, const std::string &statSubId, Params &params)
 
bool registerStatisticWithEngine (StatisticBase *stat)
 
uint8_t statLoadLevel () const
 

Static Public Member Functions

static const std::vector< StatisticOutput * > & getStatOutputs ()
 
static void static_setup (ConfigGraph *graph)
 Called to setup the StatOutputs, which are shared across all the StatEngines on the same MPI rank.
 
static void stat_outputs_simulation_start ()
 Called to nofiy StatOutputs that simulation has started.
 
static void stat_outputs_simulation_end ()
 Called to nofiy StatOutputs that simulation has ended.
 

Friends

class SST::Simulation_impl
 

Detailed Description

An SST core component that handles timing and event processing informing all registered Statistics to generate their outputs at desired rates.

Member Function Documentation

◆ performGlobalStatisticOutput()

void SST::Statistics::StatisticProcessingEngine::performGlobalStatisticOutput ( bool  endOfSimFlag = false)

Called by the Components and Subcomponent to perform a global statistic Output.

This routine will force ALL Components and Subcomponents to output their statistic information. This may lead to unexpected results if the statistic counts or data is reset on output.

Parameters
endOfSimFlag- Indicates that the output is occurring at the end of simulation.

Referenced by SST::BaseComponent::performGlobalStatisticOutput().

◆ performStatisticOutput()

void SST::Statistics::StatisticProcessingEngine::performStatisticOutput ( StatisticBase stat,
bool  endOfSimFlag = false 
)

Called by the Components and Subcomponent to perform a statistic Output.

Parameters
stat- Pointer to the statistic.
EndOfSimFlag- Indicates that the output is occurring at the end of simulation.

Referenced by SST::BaseComponent::performStatisticOutput().


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