SST  14.1.0
StructuralSimulationToolkit
SST::Statistics::StatisticOutputConsole Class Reference

The class for statistics output to the console. More...

#include <statoutputtxt.h>

Inheritance diagram for SST::Statistics::StatisticOutputConsole:
SST::Statistics::StatisticOutputTextBase SST::Statistics::StatisticFieldsOutput SST::Statistics::StatisticOutput SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base

Public Member Functions

 SST_ELI_REGISTER_DERIVED (StatisticOutput, StatisticOutputConsole, "sst", "statoutputconsole", SST_ELI_ELEMENT_VERSION(1, 0, 0), "Output to console") StatisticOutputConsole(Params &outputParameters)
 Construct a StatOutputTxt. More...
 
void serialize_order (SST::Core::Serialization::serializer &ser) override
 
 ImplementSerializable (SST::Statistics::StatisticOutputConsole) protected
 
- Public Member Functions inherited from SST::Statistics::StatisticOutputTextBase
 StatisticOutputTextBase (Params &outputParameters)
 Construct a StatOutputTxt. More...
 
ImplementVirtualSerializable(SST::Statistics::StatisticOutputTextBase) protected void printUsage () override
 Perform a check of provided parameters. More...
 
void startOfSimulation () override
 Indicate to Statistic Output that simulation started. More...
 
void endOfSimulation () override
 Indicate to Statistic Output that simulation ended. More...
 
void implStartOutputEntries (StatisticBase *statistic) override
 Implementation function for the start of output. More...
 
void implStopOutputEntries () override
 Implementation function for the end of output. More...
 
void outputField (fieldHandle_t fieldHandle, int32_t data) override
 Implementation functions for output. More...
 
void outputField (fieldHandle_t fieldHandle, uint32_t data) override
 
void outputField (fieldHandle_t fieldHandle, int64_t data) override
 
void outputField (fieldHandle_t fieldHandle, uint64_t data) override
 
void outputField (fieldHandle_t fieldHandle, float data) override
 
void outputField (fieldHandle_t fieldHandle, double data) override
 
- Public Member Functions inherited from SST::Statistics::StatisticFieldsOutput
void registerStatistic (StatisticBase *stat) override
 
void output (StatisticBase *statistic, bool endOfSimFlag) override
 
void startOutputGroup (StatisticGroup *group) override
 
void stopOutputGroup () override
 
void startRegisterGroup (StatisticGroup *group) override
 
void stopRegisterGroup () override
 
StatisticFieldInfogetRegisteredField (fieldHandle_t fieldHandle)
 Adjust the hierarchy 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...
 
virtual void outputField (fieldHandle_t fieldHandle, int32_t data)
 Output field data. More...
 
virtual void outputField (fieldHandle_t fieldHandle, uint32_t data)
 
virtual void outputField (fieldHandle_t fieldHandle, int64_t data)
 
virtual void outputField (fieldHandle_t fieldHandle, uint64_t data)
 
virtual void outputField (fieldHandle_t fieldHandle, float data)
 
virtual void outputField (fieldHandle_t fieldHandle, double data)
 
template<typename T >
fieldHandle_t registerField (const char *fieldName)
 Register a field to be output (templated function) More...
 
const char * getFieldTypeShortName (fieldType_t type)
 Output field data. More...
 
ImplementVirtualSerializable(SST::Statistics::StatisticFieldsOutput) protected StatisticFieldsOutput ()
 Construct a base StatisticOutput. More...
 
- Public Member Functions inherited from SST::Statistics::StatisticOutput
std::string & getStatisticOutputName ()
 Return the Statistic Output name.
 
ParamsgetOutputParameters ()
 Return the parameters for the StatisticOutput.
 
virtual bool supportsDynamicRegistration () const
 
 ImplementVirtualSerializable (SST::Statistics::StatisticOutput) public
 
- Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char * cls_name () const =0
 
virtual uint32_t cls_id () const =0
 
virtual std::string serialization_name () const =0
 

Additional Inherited Members

- Public Types inherited from SST::Statistics::StatisticOutput
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 >
 
- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Protected Types inherited from SST::Core::Serialization::serializable_base
enum  cxn_flag_t { ConstructorFlag }
 
- Protected Member Functions inherited from SST::Statistics::StatisticFieldsOutput
virtual void startRegisterFields (StatisticBase *statistic)
 These can be overriden, if necessary, but must be callable by the derived class.
 
virtual void stopRegisterFields ()
 
virtual void startOutputEntries (StatisticBase *statistic)
 
virtual void stopOutputEntries ()
 
- Protected Member Functions inherited from SST::Statistics::StatisticOutput
virtual bool checkOutputParameters ()=0
 Have the Statistic Output check its parameters. More...
 
OutputgetSimulationOutput ()
 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 ()
 
- Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)
 
- Protected Attributes inherited from SST::Statistics::StatisticOutputTextBase
bool m_outputTopHeader
 
bool m_outputInlineHeader
 
bool m_outputSimTime
 
bool m_outputRank
 
bool m_useCompression
 

Detailed Description

The class for statistics output to the console.

Member Function Documentation

◆ SST_ELI_REGISTER_DERIVED()

SST::Statistics::StatisticOutputConsole::SST_ELI_REGISTER_DERIVED ( StatisticOutput  ,
StatisticOutputConsole  ,
"sst"  ,
"statoutputconsole"  ,
SST_ELI_ELEMENT_VERSION(1, 0, 0)  ,
"Output to console"   
) &

Construct a StatOutputTxt.

Parameters
outputParameters- Parameters used for this Statistic Output

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