SST::Statistics::UniqueCountStatistic< T > Class Template Reference
Creates a Statistic which counts unique values provided to it. More...
#include <statuniquecount.h>
Inheritance diagram for SST::Statistics::UniqueCountStatistic< T >:
Public Member Functions | |
| SST_ELI_DECLARE_STATISTIC_TEMPLATE (UniqueCountStatistic, "sst", "UniqueCountStatistic", SST_ELI_ELEMENT_VERSION(1, 0, 0), "Track unique occurrences of statistic", "SST::Statistic<T>") UniqueCountStatistic(BaseComponent *comp | |
| virtual const std::string & | getStatTypeName () const override |
| Return the Statistic type name. | |
| void | serialize_order (SST::Core::Serialization::serializer &ser) override |
| Serialization. | |
 Public Member Functions inherited from SST::Statistics::Statistic< T > | |
| SST_ELI_DECLARE_INFO (ELI::ProvidesInterface, ELI::ProvidesParams) SST_ELI_DOCUMENT_PARAMS( | |
| template<class... InArgs> | |
| void | addData (InArgs &&... args) |
| Add data to the Statistic This will call the addData_impl() routine in the derived Statistic. | |
| template<class... InArgs> | |
| void | addDataNTimes (uint64_t N, InArgs &&... args) |
| 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 (uint64_t increment) |
| Increment current collection count. | |
| virtual void | setCollectionCount (uint64_t new_count) |
| Set the current collection count to a defined value. | |
| virtual void | setCollectionCountLimit (uint64_t new_limit) |
| 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... | |
| void | setPortModName (std::string &port, size_t index) |
| Set port name if stat is owned by a port module Temporary field until a common base class for elements with stats is created. | |
| 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.stat_name.sub_id. | |
| virtual std::string | getELIName () const =0 |
| Return the ELI type of the statistic The ELI registration macro creates this function automatically for child classes. | |
| 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 | getStartAtFlag () |
| Return the rate at which the statistic should be output. More... | |
| void | setStartAtFlag () |
| void | unsetStartAtFlag () |
| bool | getStopAtFlag () |
| Manage StopAt flag. | |
| void | setStopAtFlag () |
| void | unsetStopAtFlag () |
| bool | getOutputRateFlag () |
| Manage OutputRate flag. | |
| void | setOutputRateFlag () |
| void | unsetOutputRateFlag () |
| SimTime_t | getStartAtFactor () |
| SimTime_t | getStopAtFactor () |
| SimTime_t | getOutputRateFactor () |
| 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. | |
| bool | isOutputPeriodic () const |
| Return the collection mode that is registered. | |
| bool | isOutputEventBased () const |
| virtual bool | isReady () const |
| Indicate that the Statistic is Ready to be used. | |
| virtual bool | isNullStatistic () const |
| Indicate if the Statistic is a NullStatistic. | |
| void | serializeStat (SST::Core::Serialization::serializer &ser) |
| BaseComponent * | deserializeComponentPtr (SST::Core::Serialization::serializer &ser) |
Data Fields | |
| const std::string & | stat_name |
| const std::string const std::string & | stat_sub_id |
| const std::string const std::string Params & | stat_params: Statistic<T>(comp |
| const std::string const std::string Params | stat_name |
| const std::string const std::string Params | stat_sub_id |
| const std::string const std::string Params | stat_params |
Protected Member Functions | |
| void | addData_impl (T data) override |
Present a new value to the Statistic to be included in the unique set More... | |
| Protected Member Functions inherited from SST::Statistics::Statistic< T > | |
| Statistic (BaseComponent *comp, const std::string &stat_name, const std::string &stat_sub_id, Params &stat_params) | |
| Construct a Statistic. More... | |
| Protected Member Functions inherited from SST::Statistics::StatisticBase | |
| StatisticBase (BaseComponent *comp, const std::string &stat_name, const std::string &stat_sub_id, Params &stat_params) | |
| Construct a StatisticBase. More... | |
| void | setStatisticDataType (const StatisticFieldInfo::fieldType_t data_type) |
| Set the Statistic Data Type. | |
| void | setStatisticTypeName (const char *type_name) |
| Set an optional Statistic Type Name (for output) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SST::Statistics::Statistic< T > | |
| static fieldType_t | fieldId () |
| Static Public Member Functions inherited from SST::Statistics::StatisticBase | |
| static const std::vector< ElementInfoParam > & | ELI_getParams () |
Detailed Description
template<typename T>
class SST::Statistics::UniqueCountStatistic< T >
Creates a Statistic which counts unique values provided to it.
- Template Parameters
-
T A template for holding the main data type of this statistic
Member Function Documentation
◆ addData_impl()
template<typename T >
|
inlineoverrideprotected |
Present a new value to the Statistic to be included in the unique set
- Parameters
-
data New data item to be included in the unique set
Field Documentation
◆ stat_params
template<typename T >
| const std::string const std::string Params SST::Statistics::UniqueCountStatistic< T >::stat_params |
Initial value:
{}
~UniqueCountStatistic() {}
The documentation for this class was generated from the following file:
- src/sst/core/statapi/statuniquecount.h
