SST::Statistics::StatisticFieldInfo Class Reference

The class for representing Statistic Output Fields. More...

#include <statfieldinfo.h>

Public Types
using	fieldType_t = ::SST::Statistics::fieldType_t
using	fieldHandle_t = int32_t

Public Member Functions
	StatisticFieldInfo (const char *stat_name, const char *field_name, fieldType_t field_type)
	Construct a StatisticFieldInfo.
const std::string &	getStatName () const
	Return the statistic name related to this field info.
const std::string &	getFieldName () const
	Return the field name related to this field info.
fieldType_t	getFieldType () const
	Return the field type related to this field info.
std::string	getFieldUniqueName () const
	Return the field type related to this field info.
bool	operator== (StatisticFieldInfo &field_info_1)
	Compare two field info structures.
void	setFieldHandle (fieldHandle_t handle)
	Set the field handle.
fieldHandle_t	getFieldHandle ()
	Get the field handle.

Static Public Member Functions
static const char *	getFieldTypeShortName (fieldType_t type)
static const char *	getFieldTypeFullName (fieldType_t type)
template<typename T>
static fieldType_t	getFieldTypeFromTemplate ()

Detailed Description

The class for representing Statistic Output Fields.

Constructor & Destructor Documentation

StatisticFieldInfo()

SST::Statistics::StatisticFieldInfo::StatisticFieldInfo	(	const char *	stat_name,
		const char *	field_name,
		fieldType_t	field_type )

Construct a StatisticFieldInfo.

Parameters

statName	- Name of the statistic registering this field.
fieldName	- Name of the Field to be assigned.
fieldType	- Data type of the field.

Referenced by SST::Statistics::StatisticFieldsOutput::getRegisteredField(), and operator==().

Member Function Documentation

getFieldHandle()

fieldHandle_t SST::Statistics::StatisticFieldInfo::getFieldHandle ( )

inline

Get the field handle.

Returns

The assigned field handle.

getFieldName()

const std::string & SST::Statistics::StatisticFieldInfo::getFieldName ( ) const

inline

Return the field name related to this field info.

Referenced by getFieldUniqueName(), operator==(), SST::Statistics::StatisticOutputTextBase::outputField(), SST::Statistics::StatisticOutputCSV::startOfSimulation(), and SST::Statistics::StatisticOutputTextBase::startOfSimulation().

getFieldType()

fieldType_t SST::Statistics::StatisticFieldInfo::getFieldType ( ) const

inline

Return the field type related to this field info.

Referenced by getFieldUniqueName(), operator==(), SST::Statistics::StatisticOutputTextBase::outputField(), and SST::Statistics::StatisticOutputCSV::startOfSimulation().

getFieldUniqueName()

std::string SST::Statistics::StatisticFieldInfo::getFieldUniqueName

(

)

const

Return the field type related to this field info.

References getFieldName(), and getFieldType().

Referenced by SST::Statistics::StatisticFieldsOutput::getRegisteredField().

getStatName()

const std::string & SST::Statistics::StatisticFieldInfo::getStatName ( ) const

inline

Return the statistic name related to this field info.

Referenced by SST::Statistics::StatisticOutputTextBase::startOfSimulation().

operator==()

bool SST::Statistics::StatisticFieldInfo::operator==

(

StatisticFieldInfo &

field_info_1

)

Compare two field info structures.

Parameters

FieldInfo1

- a FieldInfo to compare against.

Returns

True if the Field Info structures are the same.

References getFieldName(), getFieldType(), and StatisticFieldInfo().

setFieldHandle()

void SST::Statistics::StatisticFieldInfo::setFieldHandle ( fieldHandle_t handle )

inline

Set the field handle.

Parameters

handle

- The assigned field handle for this FieldInfo

---

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

• src/sst/core/statapi/statfieldinfo.h
• src/sst/core/statapi/statfieldinfo.cc