SST  15.1.0
StructuralSimulationToolkit
SST::Statistics::NullStatistic< void > Class Template Reference
Inheritance diagram for SST::Statistics::NullStatistic< void >:
SST::Statistics::Statistic< void > SST::Statistics::StatisticBase

Public Member Functions

 SST_ELI_REGISTER_DERIVED (Statistic< void >, NullStatistic< void >, "sst", "NullStatistic", SST_ELI_ELEMENT_VERSION(1, 0, 0), "Null statistic for custom (void) stats") NullStatistic(BaseComponent *comp
 
- Public Member Functions inherited from SST::Statistics::Statistic< void >
 SST_ELI_DECLARE_INFO (ELI::ProvidesInterface, ELI::ProvidesParams) void registerOutputFields(StatisticFieldsOutput *stat_output) override
 
void outputStatisticFields (StatisticFieldsOutput *stat_output, bool end_of_sim_flag) override
 Called by the system to tell the Statistic to send its data to the StatisticOutput to be output. More...
 
- Public Member Functions inherited from SST::Statistics::StatisticBase
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 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.
 
virtual 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.
 
BaseComponentgetComponent () 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.
 
virtual void serialize_order (SST::Core::Serialization::serializer &ser)
 Serialization.
 
void serializeStat (SST::Core::Serialization::serializer &ser)
 
BaseComponentdeserializeComponentPtr (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 Paramsstat_params: Statistic<void>(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
 

Additional Inherited Members

- Static Public Member Functions inherited from SST::Statistics::StatisticBase
static const std::vector< ElementInfoParam > & ELI_getParams ()
 
- Protected Member Functions inherited from SST::Statistics::Statistic< void >
 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)
 

Field Documentation

◆ stat_params

const std::string const std::string Params SST::Statistics::NullStatistic< void >::stat_params
Initial value:
{}
virtual std::string getELIName() const override { return "sst.NullStatistic"; }
virtual const std::string& getStatTypeName() const override { return stat_type_; }
private:
inline static const std::string stat_type_ = "NULL"

The documentation for this class was generated from the following file: