SST::Statistics::StatisticOutputTxt Class Reference
The class for statistics output to a text file. More...
#include <statoutputtxt.h>
Inheritance diagram for SST::Statistics::StatisticOutputTxt:
Public Member Functions | |
| SST_ELI_REGISTER_DERIVED (StatisticOutput, StatisticOutputTxt, "sst", "statoutputtxt", SST_ELI_ELEMENT_VERSION(1, 0, 0), "Output to text file") StatisticOutputTxt(Params &outputParameters) | |
| Construct a StatOutputTxt. More... | |
 Public Member Functions inherited from SST::Statistics::StatisticOutputTextBase | |
| StatisticOutputTextBase (Params &outputParameters) | |
| Construct a StatOutputTxt. More... | |
| 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 |
| virtual void | implStartOutputEntries (StatisticBase *statistic)=0 |
| Indicate to Statistic Output that a statistic is about to send data to be output Allows object to perform any initialization before output. More... | |
| virtual void | implStopOutputEntries ()=0 |
| Indicate to Statistic Output that a statistic is finished sending data to be output Allows object to perform any cleanup. More... | |
| StatisticFieldInfo * | getRegisteredField (fieldHandle_t fieldHandle) |
| Return the information on a registered field via the field handle. More... | |
| template<typename T > | |
| StatisticFieldInfo * | getRegisteredField (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. | |
| 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... | |
| Public Member Functions inherited from SST::Statistics::StatisticOutput | |
| 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. More... | |
| virtual void | output (StatisticBase *statistic, bool endOfSimFlag)=0 |
| virtual bool | supportsDynamicRegistration () const |
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 Member Functions inherited from SST::Statistics::StatisticOutput | |
| static const std::vector< SST::ElementInfoParam > & | ELI_getParams () |
| Protected Member Functions inherited from SST::Statistics::StatisticOutputTextBase | |
| bool | checkOutputParameters () override |
| Perform a check of provided parameters. More... | |
| void | printUsage () override |
| Print out usage for this Statistic Output. 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 |
| Protected Member Functions inherited from SST::Statistics::StatisticFieldsOutput | |
| StatisticFieldsOutput (Params &outputParameters) | |
| Construct a base StatisticOutput. More... | |
| 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... | |
| 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... | |
| StatisticOutput (Params &outputParameters) | |
| Construct a base StatisticOutput. More... | |
| void | setStatisticOutputName (const std::string &name) |
| void | lock () |
| void | unlock () |
| 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 a text file.
Member Function Documentation
◆ SST_ELI_REGISTER_DERIVED()
| SST::Statistics::StatisticOutputTxt::SST_ELI_REGISTER_DERIVED | ( | StatisticOutput | , |
| StatisticOutputTxt | , | ||
| "sst" | , | ||
| "statoutputtxt" | , | ||
| SST_ELI_ELEMENT_VERSION(1, 0, 0) | , | ||
| "Output to text file" | |||
| ) | & |
The documentation for this class was generated from the following files:
- src/sst/core/statapi/statoutputtxt.h
- src/sst/core/statapi/statoutputtxt.cc
