Stats::Units Namespace Reference

Units for Stats. More...

Classes
class	Base
	The Base class is the parent class of all unit classes. More...
class	Bit
class	Byte
class	Count
class	Cycle
class	DegreeCelsius
class	Joule
class	Rate
class	Ratio
class	Second
class	Tick
class	Unspecified
class	Volt
class	Watt

Detailed Description

Units for Stats.

This header file provides an ability to associate a stat object with a specific unit.

The supported units are:

• Cycle: represents clock cycles.
• Tick: represents the count of gem5's Tick.
• Second: represents the base unit of time defined by SI.
• Bit: represents the number of computer bits.
• Byte: represents 8 bits.
• Volt: a SI derived unit measuring potential difference.
• Joule: represents joule, a unit of energy, as defined by SI.
• Watt: represents 1 watt, where 1 watt = 1 joule / second.
• Celsius: represents 1 Celsius degree as defined by SI.
• Rate(T1, T2): represents the unit of a quantity of T1 divided by a quantity of T2.
• Ratio: represents the unit of a quantity of unit T divided by a quantity of T.
• Count: represents the count of a quantity that is not defined above.
• Unspecified: the unit of the stat is unspecified.

Each unit class is intended to be a singleton, which means only each unit class has at most one object of that class exist throughout the program. Therefore, copy constructors and assignment operators are deleted functions.

When any of the following criteria is met, a new unit should be added,

• The new unit is significant enough to be not included in Count unit. (e.g. Cycle unit, Tick unit)