Stats::Scalar Class Reference

This is a simple scalar statistic, like a counter. More...

#include <statistics.hh>

Inheritance diagram for Stats::Scalar:

Public Member Functions
	Scalar (Group *parent=nullptr)
	Scalar (Group *parent, const char *name, const char *desc=nullptr)
	Scalar (Group *parent, const char *name, const Units::Base *unit, const char *desc=nullptr)
Public Member Functions inherited from Stats::ScalarBase< Scalar, StatStor >
	ScalarBase (Group *parent=nullptr, const char *name=nullptr, const Units::Base *unit=UNIT_UNSPECIFIED, const char *desc=nullptr)
void	operator++ ()
	Increment the stat by 1. More...
void	operator++ (int)
	Increment the stat by 1. More...
void	operator-- ()
	Decrement the stat by 1. More...
void	operator-- (int)
	Decrement the stat by 1. More...
void	operator= (const U &v)
	Set the data value to the given value. More...
void	operator+= (const U &v)
	Increment the stat by the given value. More...
void	operator-= (const U &v)
	Decrement the stat by the given value. More...
size_type	size () const
	Return the number of elements, always 1 for a scalar. More...
Counter	value () const
	Return the current value of this stat as its base type. More...
Result	result () const
Result	total () const
bool	zero () const
void	reset ()
void	prepare ()
Public Member Functions inherited from Stats::DataWrap< Scalar, ScalarInfoProxy >
const Info *	info () const
	DataWrap ()=delete
	DataWrap (const DataWrap &)=delete
	DataWrap (Group *parent, const char *name, const Units::Base *unit, const char *desc)
DataWrap &	operator= (const DataWrap &)=delete
Scalar &	name (const std::string &name)
	Set the name and marks this stat to print at the end of simulation. More...
const std::string &	name () const
Scalar &	setSeparator (const std::string &_sep)
	Set the character(s) used between the name and vector number on vectors, dist, etc. More...
const std::string &	setSeparator () const
Scalar &	unit (const Units::Base *_unit)
	Set the unit of the stat. More...
Scalar &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation. More...
Scalar &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation. More...
Scalar &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation. More...
Scalar &	prereq (const Stat &prereq)
	Set the prerequisite stat and marks this stat to print at the end of simulation. More...
Public Member Functions inherited from Stats::InfoAccess
	InfoAccess ()
void	reset ()
	Reset the stat to the default state. More...
bool	zero () const
bool	check () const
	Check that this stat has been set up properly and is ready for use. More...

Additional Inherited Members
Public Types inherited from Stats::ScalarBase< Scalar, StatStor >
typedef StatStor	Storage
typedef StatStor ::Params	Params
Public Types inherited from Stats::DataWrap< Scalar, ScalarInfoProxy >
typedef ScalarInfoProxy< Scalar >	Info
Protected Member Functions inherited from Stats::ScalarBase< Scalar, StatStor >
	M5_ALIGNED (8) char storage[sizeof(Storage)]
	The storage of this stat. More...
Storage *	data ()
	Retrieve the storage. More...
const Storage *	data () const
	Retrieve a const pointer to the storage. More...
void	doInit ()
Protected Member Functions inherited from Stats::DataWrap< Scalar, ScalarInfoProxy >
Scalar &	self ()
Info *	info ()
Protected Member Functions inherited from Stats::InfoAccess
void	setInfo (Group *parent, Info *info)
	Set up an info class for this statistic. More...
void	setParams (const StorageParams *params)
	Save Storage class parameters if any. More...
void	setInit ()
	Save Storage class parameters if any. More...
Info *	info ()
	Grab the information class for this statistic. More...
const Info *	info () const
	Grab the information class for this statistic. More...

Detailed Description

This is a simple scalar statistic, like a counter.

See also

Stat, ScalarBase, StatStor

Definition at line 1933 of file statistics.hh.

Constructor & Destructor Documentation

Scalar() [1/3]

Stats::Scalar::Scalar ( Group *  parent = nullptr )

inline

Definition at line 1938 of file statistics.hh.

Scalar() [2/3]

Stats::Scalar::Scalar ( Group *  parent, const char *  name, const char *  desc = nullptr  )

inline

Definition at line 1944 of file statistics.hh.

Scalar() [3/3]

Stats::Scalar::Scalar ( Group *  parent, const char *  name, const Units::Base *  unit, const char *  desc = nullptr  )

inline

Definition at line 1949 of file statistics.hh.

---

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

• base/statistics.hh