SST  13.1.0
Structural Simulation Toolkit
Public Types | Public Member Functions | Static Public Member Functions
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 *statName, const char *fieldName, fieldType_t fieldType)
 Construct a StatisticFieldInfo. More...
 
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 &FieldInfo1)
 Compare two field info structures. More...
 
void setFieldHandle (fieldHandle_t handle)
 Set the field handle. More...
 
fieldHandle_t getFieldHandle ()
 Get the field handle. More...
 

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 *  statName,
const char *  fieldName,
fieldType_t  fieldType 
)

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.

Member Function Documentation

◆ getFieldHandle()

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

Get the field handle.

Returns
The assigned field handle.

◆ operator==()

bool SST::Statistics::StatisticFieldInfo::operator== ( StatisticFieldInfo &  FieldInfo1)

Compare two field info structures.

Parameters
FieldInfo1- a FieldInfo to compare against.
Returns
True if the Field Info structures are the same.

References getFieldName(), and getFieldType().

◆ 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: