SST::Statistics::AccumulatorStatistic< NumberBase > Class Template Reference
Allows the online gathering of statistical information about a single quantity. More...
#include <stataccumulator.h>
Inheritance diagram for SST::Statistics::AccumulatorStatistic< NumberBase >:
Protected Member Functions | |
| void | addData_impl (NumberBase value) |
| Present a new value to the class to be included in the statistics. More... | |
 Protected Member Functions inherited from SST::Statistics::Statistic< NumberBase > | |
| Statistic (Component *comp, std::string &statName, std::string &statSubId, Params &statParams) | |
| Construct a Statistic. More... | |
| Protected Member Functions inherited from SST::Statistics::StatisticBase | |
| StatisticBase (Component *comp, std::string &statName, 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. | |
Friends | |
| class | SST::Component |
Additional Inherited Members | |
| Public Types inherited from SST::Statistics::StatisticBase | |
| enum | StatMode_t { STAT_MODE_UNDEFINED, STAT_MODE_COUNT, STAT_MODE_PERIODIC } |
| Statistic collection mode. | |
| Public Member Functions inherited from SST::Statistics::Statistic< NumberBase > | |
| void | addData (NumberBase data) |
| Add data to the Statistic This will call the addData_impl() routine in the derived Statistic. | |
| Public Member Functions inherited from SST::Statistics::StatisticBase | |
| void | enable () |
| Enable Statistic for collections. | |
| void | disable () |
| Disable Statistic for collections. | |
| virtual void | resetCollectionCount () |
| Set the current collection count to 0. | |
| virtual void | incrementCollectionCount () |
| 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. | |
| Component * | 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. | |
Detailed Description
template<typename NumberBase>
class SST::Statistics::AccumulatorStatistic< NumberBase >
Allows the online gathering of statistical information about a single quantity.
The basic statistics are captured online removing the need to keep a copy of the values of interest.
- Template Parameters
-
NumberBase A template for the basic numerical type of values
Member Function Documentation
template<typename NumberBase>
|
inlineprotectedvirtual |
Present a new value to the class to be included in the statistics.
- Parameters
-
value New value to be presented
Implements SST::Statistics::Statistic< NumberBase >.
The documentation for this class was generated from the following file:
- src/sst/core/statapi/stataccumulator.h
