SST
14.0.0
StructuralSimulationToolkit
|
Public Member Functions | |
NullStatisticBase (BaseComponent *comp, const std::string &statName, const std::string &statSubId, Params &statParams) | |
void | addData_impl (Args... UNUSED(data)) override |
void | addData_impl_Ntimes (uint64_t UNUSED(N), Args... UNUSED(data)) override |
![]() | |
SST_ELI_DECLARE_INFO (ELI::ProvidesInterface, ELI::ProvidesParams) using Datum | |
void | addData (InArgs &&... args) |
Add data to the Statistic This will call the addData_impl() routine in the derived Statistic. | |
void | addDataNTimes (uint64_t N, InArgs &&... args) |
![]() | |
void | enable () |
Enable Statistic for collections. | |
void | disable () |
Disable Statistic for collections. | |
virtual void | clearStatisticData () |
Inform the Statistic to clear its data. | |
virtual void | resetCollectionCount () |
Set the current collection count to 0. | |
virtual void | incrementCollectionCount (uint64_t increment) |
Increment current collection count. | |
virtual void | setCollectionCount (uint64_t newCount) |
Set the current collection count to a defined value. | |
virtual void | setCollectionCountLimit (uint64_t newLimit) |
Set the collection count limit to a defined value. | |
void | setFlagResetCountOnOutput (bool flag) |
Set the Reset Count On Output flag. More... | |
void | setFlagClearDataOnOutput (bool flag) |
Set the Clear Data On Output flag. More... | |
void | setFlagOutputAtEndOfSim (bool flag) |
Set the Output At End Of Sim flag. More... | |
const std::string & | getCompName () const |
Return the Component Name. | |
const std::string & | getStatName () const |
Return the Statistic Name. | |
const std::string & | getStatSubId () const |
Return the Statistic SubId. | |
const std::string & | getFullStatName () const |
Return the full Statistic name of Component.StatName.SubId. | |
const std::string & | getStatTypeName () const |
Return the Statistic type name. | |
const StatisticFieldInfo::fieldType_t & | getStatDataType () const |
Return the Statistic data type. | |
const char * | getStatDataTypeShortName () const |
Return the Statistic data type. | |
const char * | getStatDataTypeFullName () const |
Return the Statistic data type. | |
BaseComponent * | getComponent () const |
Return a pointer to the parent Component. | |
bool | isEnabled () const |
Return the enable status of the Statistic. | |
bool | isOutputEnabled () const |
Return the enable status of the Statistic's ability to output data. | |
uint64_t | getCollectionCountLimit () const |
Return the collection count limit. | |
uint64_t | getCollectionCount () const |
Return the current collection count. | |
bool | getFlagResetCountOnOutput () const |
Return the ResetCountOnOutput flag value. | |
bool | getFlagClearDataOnOutput () const |
Return the ClearDataOnOutput flag value. | |
bool | getFlagOutputAtEndOfSim () const |
Return the OutputAtEndOfSim flag value. | |
StatMode_t | getRegisteredCollectionMode () const |
Return the collection mode that is registered. | |
void | delayOutput (const char *delayTime) |
Delay the statistic from outputting data for a specified delay time. More... | |
void | delayCollection (const char *delayTime) |
Delay the statistic from collecting data for a specified delay time. More... | |
virtual bool | isReady () const |
Indicate that the Statistic is Ready to be used. | |
virtual bool | isNullStatistic () const |
Indicate if the Statistic is a NullStatistic. | |
Additional Inherited Members | |
![]() | |
enum | StatMode_t { STAT_MODE_UNDEFINED, STAT_MODE_COUNT, STAT_MODE_PERIODIC, STAT_MODE_DUMP_AT_END } |
Statistic collection mode. | |
![]() | |
static fieldType_t | fieldId () |
![]() | |
static const std::vector< ElementInfoParam > & | ELI_getParams () |
![]() | |
Statistic (BaseComponent *comp, const std::string &statName, const std::string &statSubId, Params &statParams) | |
Construct a Statistic. More... | |
![]() | |
StatisticBase (BaseComponent *comp, const std::string &statName, const std::string &statSubId, Params &statParams) | |
Construct a StatisticBase. More... | |
Params & | getParams () |
Return the Statistic Parameters. | |
void | setStatisticDataType (const StatisticFieldInfo::fieldType_t dataType) |
Set the Statistic Data Type. | |
void | setStatisticTypeName (const char *typeName) |
Set an optional Statistic Type Name. | |