#include <statistics.hh>

Inheritance diagram for gem5::statistics::DataWrap< Derived, InfoProxyType >:

Public Types
typedef InfoProxyType< Derived >	Info

Public Member Functions
const Info *	info () const

	DataWrap ()=delete

	DataWrap (const DataWrap &)=delete

DataWrap &	operator= (const DataWrap &)=delete

	DataWrap (Group parent, const char name, const units::Base unit, const char desc)

Derived &	name (const std::string &name)
	Set the name and marks this stat to print at the end of simulation.

const std::string &	name () const

Derived &	setSeparator (const std::string &_sep)
	Set the character(s) used between the name and vector number on vectors, dist, etc.

const std::string &	setSeparator () const

Derived &	unit (const units::Base *_unit)
	Set the unit of the stat.

Derived &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation.

Derived &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation.

Derived &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation.

template<class Stat>
Derived &	prereq (const Stat &prereq)
	Set the prerequisite stat and marks this stat to print at the end of simulation.

Public Member Functions inherited from gem5::statistics::InfoAccess
	InfoAccess ()

void	reset ()
	Reset the stat to the default state.

bool	zero () const

bool	check () const
	Check that this stat has been set up properly and is ready for use.

Protected Member Functions
Derived &	self ()

Info *	info ()

Protected Member Functions inherited from gem5::statistics::InfoAccess
void	setInfo (Group parent, Info info)
	Set up an info class for this statistic.

void	setParams (const StorageParams *params)
	Save Storage class parameters if any.

void	setInit ()
	Save Storage class parameters if any.

Info *	info ()
	Grab the information class for this statistic.

const Info *	info () const
	Grab the information class for this statistic.

bool	newStyleStats () const
	Check if the info is new style stats.

Detailed Description

template<class Derived, template< class > class InfoProxyType>
class gem5::statistics::DataWrap< Derived, InfoProxyType >

Definition at line 227 of file statistics.hh.

Member Typedef Documentation

◆ Info

template<class Derived, template< class > class InfoProxyType>

typedef InfoProxyType<Derived> gem5::statistics::DataWrap< Derived, InfoProxyType >::Info

Definition at line 230 of file statistics.hh.

Constructor & Destructor Documentation

◆ DataWrap() [1/3]

template<class Derived, template< class > class InfoProxyType>

gem5::statistics::DataWrap< Derived, InfoProxyType >::DataWrap ( )

delete

Referenced by DataWrap(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::DataWrapVec(), and operator=().

◆ DataWrap() [2/3]

template<class Derived, template< class > class InfoProxyType>

gem5::statistics::DataWrap< Derived, InfoProxyType >::DataWrap ( const DataWrap< Derived, InfoProxyType > & )

delete

References DataWrap().

◆ DataWrap() [3/3]

template<class Derived, template< class > class InfoProxyType>

gem5::statistics::DataWrap< Derived, InfoProxyType >::DataWrap	(	Group *	parent,
		const char *	name,
		const units::Base *	unit,
		const char *	desc )

inline

Definition at line 254 of file statistics.hh.

References gem5::statistics::Group::addStat(), gem5::csprintf(), desc(), gem5::statistics::display, info(), name(), gem5::statistics::InfoAccess::newStyleStats(), self(), gem5::statistics::InfoAccess::setInfo(), unit(), warn, and warn_once.

Member Function Documentation

◆ desc()

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::desc ( const std::string & _desc )

inline

Set the description and marks this stat to print at the end of simulation.

Parameters

desc	The new description.

Returns: A reference to this stat.

Definition at line 333 of file statistics.hh.

References info(), and self().

Referenced by DataWrap(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::DataWrapVec(), gem5::statistics::DataWrapVec2d< Derived, InfoProxyType >::DataWrapVec2d(), and gem5::statistics::DataWrapVec< Derived, InfoProxyType >::subdesc().

◆ flags()

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::flags ( Flags _flags )

inline

Set the flags and marks this stat to print at the end of simulation.

Parameters

f	The new flags.

Returns: A reference to this stat.

Definition at line 357 of file statistics.hh.

References info(), and self().

◆ info() [1/2]

template<class Derived, template< class > class InfoProxyType>

Info * gem5::statistics::DataWrap< Derived, InfoProxyType >::info ( )

inlineprotected

◆ info() [2/2]

template<class Derived, template< class > class InfoProxyType>

const Info * gem5::statistics::DataWrap< Derived, InfoProxyType >::info ( ) const

inline

Definition at line 244 of file statistics.hh.

References gem5::statistics::InfoAccess::info(), and gem5::safe_cast().

◆ name() [1/2]

template<class Derived, template< class > class InfoProxyType>

const std::string & gem5::statistics::DataWrap< Derived, InfoProxyType >::name ( ) const

inline

Definition at line 295 of file statistics.hh.

References info().

◆ name() [2/2]

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::name ( const std::string & name )

inline

Set the name and marks this stat to print at the end of simulation.

Parameters

name	The new name.

Returns: A reference to this stat.

Definition at line 288 of file statistics.hh.

References gem5::statistics::display, info(), name(), gem5::statistics::InfoAccess::newStyleStats(), and self().

Referenced by DataWrap(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::DataWrapVec(), gem5::statistics::DataWrapVec2d< Derived, InfoProxyType >::DataWrapVec2d(), name(), gem5::ruby::garnet::GarnetNetwork::regStats(), and gem5::statistics::DataWrapVec< Derived, InfoProxyType >::subname().

◆ operator=()

template<class Derived, template< class > class InfoProxyType>

DataWrap & gem5::statistics::DataWrap< Derived, InfoProxyType >::operator= ( const DataWrap< Derived, InfoProxyType > & )

delete

References DataWrap().

◆ precision()

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::precision ( int _precision )

inline

Set the precision and marks this stat to print at the end of simulation.

Parameters

_precision The new precision

Returns: A reference to this stat.

Definition at line 345 of file statistics.hh.

References info(), and self().

◆ prereq()

template<class Derived, template< class > class InfoProxyType>

template<class Stat>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::prereq ( const Stat & prereq )

inline

Set the prerequisite stat and marks this stat to print at the end of simulation.

Parameters

prereq The prerequisite stat.

Returns: A reference to this stat.

Definition at line 371 of file statistics.hh.

References info(), prereq(), and self().

Referenced by prereq().

◆ self()

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::self ( )

inlineprotected

Definition at line 233 of file statistics.hh.

Referenced by DataWrap(), desc(), flags(), name(), precision(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::prepare(), prereq(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::reset(), setSeparator(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::subdesc(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::subname(), unit(), gem5::statistics::DataWrapVec2d< Derived, InfoProxyType >::ysubname(), and gem5::statistics::DataWrapVec2d< Derived, InfoProxyType >::ysubnames().

◆ setSeparator() [1/2]

template<class Derived, template< class > class InfoProxyType>

const std::string & gem5::statistics::DataWrap< Derived, InfoProxyType >::setSeparator ( ) const

inline

Definition at line 309 of file statistics.hh.

References info().

◆ setSeparator() [2/2]

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::setSeparator ( const std::string & _sep )

inline

Set the character(s) used between the name and vector number on vectors, dist, etc.

Parameters

_sep	The new separator string

Returns: A reference to this stat.

Definition at line 304 of file statistics.hh.

References info(), and self().

◆ unit()

template<class Derived, template< class > class InfoProxyType>

Derived & gem5::statistics::DataWrap< Derived, InfoProxyType >::unit ( const units::Base * _unit )

inline

Set the unit of the stat.

Parameters

unit	The new unit.

Returns: A reference to this stat.

Definition at line 320 of file statistics.hh.

References info(), and self().

Referenced by DataWrap(), gem5::statistics::DataWrapVec< Derived, InfoProxyType >::DataWrapVec(), and gem5::statistics::DataWrapVec2d< Derived, InfoProxyType >::DataWrapVec2d().

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

base/statistics.hh

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Info

Constructor & Destructor Documentation

◆ DataWrap() [1/3]

◆ DataWrap() [2/3]

◆ DataWrap() [3/3]

Member Function Documentation

◆ desc()

◆ flags()

◆ info() [1/2]

◆ info() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ operator=()

◆ precision()

◆ prereq()

◆ self()

◆ setSeparator() [1/2]

◆ setSeparator() [2/2]

◆ unit()