SST::Statistics::HistogramStatistic< BinDataType > Class Template Reference
Holder of data grouped into pre-determined width bins.More...
#include <stathistogram.h>
Inheritance diagram for SST::Statistics::HistogramStatistic< BinDataType >:
Public Member Functions | |
| HistogramStatistic (BaseComponent *comp, const std::string &statName, const std::string &statSubId, Params &statParams) | |
 Public Member Functions inherited from SST::Statistics::Statistic< BinDataType > | |
| void | addData (BinDataType 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. | |
| 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. | |
Protected Member Functions | |
| void | addData_impl (BinDataType value) override |
| Adds a new value to the histogram. More... | |
| Protected Member Functions inherited from SST::Statistics::Statistic< BinDataType > | |
| Statistic (BaseComponent *comp, const std::string &statName, const std::string &statSubId, Params &statParams) | |
| Construct a Statistic. More... | |
| Protected Member Functions inherited from SST::Statistics::StatisticBase | |
| 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. | |
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. | |
Detailed Description
template<class BinDataType>
class SST::Statistics::HistogramStatistic< BinDataType >
Holder of data grouped into pre-determined width bins.
- Template Parameters
-
BinDataType is the type of the data held in each bin (i.e. what data type described the width of the bin)
Member Function Documentation
template<class BinDataType>
|
inlineoverrideprotectedvirtual |
Adds a new value to the histogram.
The correct bin is identified and then incremented. If no bin can be found to hold the value then a new bin is created.
Implements SST::Statistics::Statistic< BinDataType >.
The documentation for this class was generated from the following file:
- src/sst/core/statapi/stathistogram.h
