YANE-Framework 1.1.0
Public Member Functions | Protected Attributes

yane::Utils::StatisticsClientAverage Class Reference

StatisticsClientAverage class. More...

Inheritance diagram for yane::Utils::StatisticsClientAverage:
[legend]
Collaboration diagram for yane::Utils::StatisticsClientAverage:
[legend]

List of all members.

Public Member Functions

void addValue (double value)
 Function to add an double value to the statistical data.
virtual std::string formattedData ()
 Output format of the statistical data.
virtual std::string name ()
 Function returning the name of the client.
virtual void reset ()
 Function to reset the client.
 StatisticsClientAverage (StatisticsMaster *master, const std::string &group, const std::string &name, int prec, bool displaymin, bool displayavg, bool displaymax)
 Constructor.
virtual ~StatisticsClientAverage ()
 Destructor.

Protected Attributes

int _amount
 Number of added values to statistical data.
bool _displayavg
 Decision variable whether average value shall be displayed.
bool _displaymax
 Decision variable whether maximal occuring value shall be displayed.
bool _displaymin
 Decision variable whether minimal occuring value shall be displayed.
std::string _group
 Name of the group the client belongs to.
StatisticsMaster_master
 Pointer of the StatisticsMaster object to which the client is connected to.
double _maxvalue
 Maximal occuring value.
double _minvalue
 Minimal occuring value.
std::string _name
 Name of client.
int _prec
 Precision of output.
double _value
 Averaged value.

Detailed Description

See also:
StatisticsMaster This class uses a StatisticsMaster to gather averaged statistical information.

Constructor & Destructor Documentation

LIB_EXPORT yane::Utils::StatisticsClientAverage::StatisticsClientAverage ( StatisticsMaster master,
const std::string &  group,
const std::string &  name,
int  prec,
bool  displaymin,
bool  displayavg,
bool  displaymax 
)

Constructor

Parameters:
masterPointer of the StatisticsMaster class the client belongs to
groupGroup of clients the client belongs to
nameName of the client prec Precision of output
displayminDecision variable whether minimal occuring value shall be displayed
displayavgDecision variable whether average value shall be displayed
displaymaxDecision variable whether maximal occuring value shall be displayed

Member Function Documentation

LIB_EXPORT void yane::Utils::StatisticsClientAverage::addValue ( double  value)

Function to add an double value to the statistical data

Parameters:
valueValue to add to the data