EMANE  1.2.1
EMANE::StatisticInfo Class Reference

Holds name, type, property and description of a Statistic. More...

#include <statisticinfo.h>

Public Member Functions

 StatisticInfo (const std::string &sName, Any::Type type, const StatisticProperties &properties, const std::string &sDescription)
 
const std::string & getName () const
 
Any::Type getType () const
 
const std::string & getDescription () const
 
bool isClearable () const
 

Detailed Description

Holds name, type, property and description of a Statistic.

Definition at line 50 of file statisticinfo.h.

Constructor & Destructor Documentation

◆ StatisticInfo()

EMANE::StatisticInfo::StatisticInfo ( const std::string &  sName,
Any::Type  type,
const StatisticProperties properties,
const std::string &  sDescription 
)
inline

Creates a StatisticInfo object to hold information about a registered statistic

Parameters
sNameStatistic name
typeStatistic Any type
propertiesStatistic properties
sDescriptionStatsitci description

Definition at line 34 of file statisticinfo.inl.

Member Function Documentation

◆ getDescription()

const std::string & EMANE::StatisticInfo::getDescription ( ) const
inline

Gets the stastitic description

Returns
Returns a const reference description

Definition at line 56 of file statisticinfo.inl.

◆ getName()

const std::string & EMANE::StatisticInfo::getName ( ) const
inline

Gets the statistic name

Returns
Returns a const reference statistic name reference

Definition at line 44 of file statisticinfo.inl.

◆ getType()

EMANE::Any::Type EMANE::StatisticInfo::getType ( ) const
inline

Get the statistic Any type

Returns
Statistic Any type

Definition at line 50 of file statisticinfo.inl.

◆ isClearable()

bool EMANE::StatisticInfo::isClearable ( ) const
inline

Is the statistic clearable

Returns
boolean flag

Definition at line 62 of file statisticinfo.inl.


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