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

#include <statoutputcsv.h>

Inheritance diagram for SST::Statistics::StatisticOutputCSV:

Public Member Functions
	SST_ELI_REGISTER_DERIVED (StatisticOutput, StatisticOutputCSV, "sst", "statoutputcsv", SST_ELI_ELEMENT_VERSION(1, 0, 0), "Output directly to console screen") explicit StatisticOutputCSV(Params &outputParameters)
	Construct a StatOutputCSV.

void	serialize_order (SST::Core::Serialization::serializer &ser) override

ImplementSerializable(SST::Statistics::StatisticOutputCSV) protected void	printUsage () override
	Perform a check of provided parameters.

void	startOfSimulation () override
	Indicate to Statistic Output that simulation started.

void	endOfSimulation () override
	Indicate to Statistic Output that simulation ended.

void	implStartOutputEntries (StatisticBase *statistic) override
	Implementation function for the start of output.

void	implStopOutputEntries () override
	Implementation function for the end of output.

void	outputField (fieldHandle_t fieldHandle, int32_t data) override
	Implementation functions for output.

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

virtual bool	acceptsGroups () const override
	True if this StatOutput can handle StatisticGroups.

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

StatisticFieldInfo *	getRegisteredField (fieldHandle_t fieldHandle)
	Adjust the hierarchy of the fields (FUTURE SUPPORT)

template<typename T>
StatisticFieldInfo *	getRegisteredField (const char statisticName, const char fieldName)
	Return the information on a registered field via known names.

FieldInfoArray_t &	getFieldInfoArray ()
	Return the array of registered field infos.

template<typename T>
fieldHandle_t	registerField (const char *fieldName)
	Register a field to be output (templated function)

const char *	getFieldTypeShortName (fieldType_t type)
	Output field data.

ImplementVirtualSerializable(SST::Statistics::StatisticFieldsOutput) protected	StatisticFieldsOutput ()
	Construct a base StatisticOutput.

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	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.

Output &	getSimulationOutput ()
	Gets the Output object for the Simulation object associeted with this StatOutput.

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.

SimTime_t	getCurrentSimCycle ()
	Gets the current simulstion cycle.

std::string	getAbsolutePathForOutputFile (const std::string &filename)
	Get the absolute path for the specified file taking into account the specified output directory.

	StatisticOutput (Params &outputParameters)
	Construct a base StatisticOutput.

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)

Detailed Description

The class for statistics output to a comma separated file.

Member Function Documentation

◆ acceptsGroups()

virtual bool SST::Statistics::StatisticOutputCSV::acceptsGroups ( ) const

inlineoverridevirtual

True if this StatOutput can handle StatisticGroups.

Reimplemented from SST::Statistics::StatisticOutput.

References acceptsGroups().

Referenced by acceptsGroups().

◆ endOfSimulation()

void SST::Statistics::StatisticOutputCSV::endOfSimulation ( )

overridevirtual

Indicate to Statistic Output that simulation ended.

Statistic output may perform any shutdown code here as necessary.

Implements SST::Statistics::StatisticOutput.

References endOfSimulation().

Referenced by endOfSimulation(), and SST_ELI_REGISTER_DERIVED().

◆ implStartOutputEntries()

void SST::Statistics::StatisticOutputCSV::implStartOutputEntries ( StatisticBase * statistic )

overridevirtual

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::StatisticFieldsOutput.

References SST::Statistics::StatisticBase::getCompName(), SST::Statistics::StatisticFieldsOutput::getFieldInfoArray(), SST::Statistics::StatisticBase::getStatName(), SST::Statistics::StatisticBase::getStatSubId(), SST::Statistics::StatisticBase::getStatTypeName(), and implStartOutputEntries().

Referenced by implStartOutputEntries(), and SST_ELI_REGISTER_DERIVED().

◆ implStopOutputEntries()

void SST::Statistics::StatisticOutputCSV::implStopOutputEntries ( )

overridevirtual

Implementation function for the end of output.

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

Implements SST::Statistics::StatisticFieldsOutput.

References SST::Statistics::StatisticOutput::getCurrentSimCycle(), SST::Statistics::StatisticOutput::getRank(), and implStopOutputEntries().

Referenced by implStopOutputEntries(), and SST_ELI_REGISTER_DERIVED().

◆ outputField() [1/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		double	data )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ outputField() [2/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		float	data )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ outputField() [3/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		int32_t	data )

overridevirtual

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.

Reimplemented from SST::Statistics::StatisticFieldsOutput.

References outputField().

Referenced by outputField(), and SST_ELI_REGISTER_DERIVED().

◆ outputField() [4/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		int64_t	data )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ outputField() [5/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		uint32_t	data )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ outputField() [6/6]

void SST::Statistics::StatisticOutputCSV::outputField	(	fieldHandle_t	fieldHandle,
		uint64_t	data )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ printUsage()

void SST::Statistics::StatisticOutputCSV::printUsage ( )

overridevirtual

Perform a check of provided parameters.

Returns: True if all required parameters and options are acceptable Print out usage for this Statistic Output

Implements SST::Statistics::StatisticOutput.

References SST::Output::output(), printUsage(), and SST::Output::STDOUT.

Referenced by printUsage(), and SST_ELI_REGISTER_DERIVED().

◆ serialize_order()

void SST::Statistics::StatisticOutputCSV::serialize_order ( SST::Core::Serialization::serializer & ser )

overridevirtual

Reimplemented from SST::Statistics::StatisticFieldsOutput.

◆ SST_ELI_REGISTER_DERIVED()

SST::Statistics::StatisticOutputCSV::SST_ELI_REGISTER_DERIVED	(	StatisticOutput	,
		StatisticOutputCSV	,
		"sst"	,
		"statoutputcsv"	,
		SST_ELI_ELEMENT_VERSION(1, 0, 0)	,
		"Output directly to console screen"	) &

Construct a StatOutputCSV.

Parameters

outputParameters - Parameters used for this Statistic Output

References SST::Statistics::StatisticOutput::checkOutputParameters(), endOfSimulation(), implStartOutputEntries(), implStopOutputEntries(), outputField(), printUsage(), and startOfSimulation().

◆ startOfSimulation()

void SST::Statistics::StatisticOutputCSV::startOfSimulation ( )

overridevirtual

Indicate to Statistic Output that simulation started.

Statistic output may perform any startup code here as necessary.

Implements SST::Statistics::StatisticOutput.

References SST::Statistics::StatisticFieldsOutput::getFieldInfoArray(), SST::Statistics::StatisticFieldInfo::getFieldName(), SST::Statistics::StatisticFieldInfo::getFieldType(), SST::Statistics::StatisticFieldsOutput::getFieldTypeShortName(), and startOfSimulation().

Referenced by SST_ELI_REGISTER_DERIVED(), and startOfSimulation().

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

src/sst/core/statapi/statoutputcsv.h
src/sst/core/statapi/statoutputcsv.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ acceptsGroups()

◆ endOfSimulation()

◆ implStartOutputEntries()

◆ implStopOutputEntries()

◆ outputField() [1/6]

◆ outputField() [2/6]

◆ outputField() [3/6]

◆ outputField() [4/6]

◆ outputField() [5/6]

◆ outputField() [6/6]

◆ printUsage()

◆ serialize_order()

◆ SST_ELI_REGISTER_DERIVED()

◆ startOfSimulation()