Statistics Class Reference

#include <Statistics.h>

List of all members.

---

Detailed Description

This class implemtnes a container that contains all the statistics for a Borealis node.

Public Types
enum	Error { STATISTICS_NAME_NOT_FOUND }
Public Member Functions
TSStats &	getTSStats (StatisticsName name)
	Return all statistics with given name.
bool	hasTSStats (StatisticsName name)
	checks if a given statistics name is defined.
const FixLenTimeSeries &	getStatistics (StatisticsName name, IDType id) const throw ( Error, TSStats::Error )
	Return statistics with given name and ID.
FixLenTimeSeries &	getStatistics (StatisticsName name, IDType id) throw ( Error, TSStats::Error )
	Return statistics with given name and ID.
Statistics	copy ()
	Returns a copy of the Stats.
TSStats	copyTSStats (StatisticsName name, int32 window_size=0, TimeSec precision=0, TimeStamp time_stamp=0) throw ( Error )
	Copy TSStats.
TSStats	copyTSStats (StatisticsName name, IDVect ids, int32 window_size=0, TimeSec precision=0, TimeStamp time_stamp=0) throw ( Error )
	Copy TSStats with given object names.
FixLenTimeSeries	copyStatistics (StatisticsName name, IDType id, int32 window_size=0, TimeSec precision=0, TimeStamp time_stamp=0) throw ( Error )
	Copy statistics of an given object.
void	outputStatisticsNames (ostream &os)
	Output the names of all statistics.
Friends
ostream &	operator<< (ostream &os, const Statistics &stats)
	Output the Stats.

---

Member Enumeration Documentation

enum Statistics::Error

Enumeration values: STATISTICS_NAME_NOT_FOUND

---

Member Function Documentation

Statistics Statistics::copy (   )

Returns a copy of the Stats.

FixLenTimeSeries Statistics::copyStatistics (  StatisticsName  name, IDType  id, int32  window_size = 0, TimeSec  precision = 0, TimeStamp  time_stamp = 0 )  throw ( Error )

Copy statistics of an given object. If window_size/precision/time_stamp is zero, then the default value is used. Otherwise, the returned data are resamples according to the given parameters. Parameters: name  name of the statistics id  the id of the object window_size  the window_size of the returned statistics precision  the precision of the returned statistics time_stamp  the time_stamp of the returned statistics Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid TSStats::ID_NOT_FOUND  if the given id is not valid

TSStats Statistics::copyTSStats (  StatisticsName  name, IDVect  ids, int32  window_size = 0, TimeSec  precision = 0, TimeStamp  time_stamp = 0 )  throw ( Error )

Copy TSStats with given object names. Only the statistis data of the objects in the given list are returned. If window_size/precision/time_stamp is zero, then the default value is used. Otherwise, the returned data are resamples according to the given parameters. Parameters: name  name of the statistics ids  the ids of the objects window_size  the window_size of the returned statistics precision  the precision of the returned statistics time_stamp  the time_stamp of the returned statistics Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid

TSStats Statistics::copyTSStats (  StatisticsName  name, int32  window_size = 0, TimeSec  precision = 0, TimeStamp  time_stamp = 0 )  throw ( Error )

Copy TSStats. If window_size/precision/time_stamp is zero, then the default value is used. Otherwise, the returned data are resamples according to the given parameters. Parameters: name  name of the statistics window_size  the window_size of the returned statistics precision  the precision of the returned statistics time_stamp  the time_stamp of the returned statistics Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid

FixLenTimeSeries & Statistics::getStatistics (  StatisticsName  name, IDType  id )  throw ( Error, TSStats::Error )

Return statistics with given name and ID. Parameters: name  name of the statistics id  id of the object Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid TSStats::ID_NOT_FOUND  if the given id is not valid

const FixLenTimeSeries & Statistics::getStatistics (  StatisticsName  name, IDType  id )  const throw ( Error, TSStats::Error )

Return statistics with given name and ID. Parameters: name  name of the statistics id  id of the object Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid TSStats::ID_NOT_FOUND  if the given id is not valid

TSStats & Statistics::getTSStats (  StatisticsName  name  )

Return all statistics with given name. Parameters: name  name of the statistics Exceptions: STATISTICS_NAME_NOT_FOUND  if the given name is not valid

bool Statistics::hasTSStats (  StatisticsName  name  )

checks if a given statistics name is defined. Parameters: name  name of the statistics returns true if statistics name exists.

void Statistics::outputStatisticsNames (  ostream &  os  )

Output the names of all statistics. Parameters: os  the output stream

---

Friends And Related Function Documentation

ostream& operator<< (  ostream &  os, const Statistics &  stats )  [friend]

Output the Stats. Parameters: os  the output stream stats  the statistics to be outputted

---

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

• Statistics.h
• Statistics.cc

---