ENUM specifying various system control states. More...

#include <SystemControls.h>

Inheritance diagram for trCore::SystemControls:

Collaboration diagram for trCore::SystemControls:

Static Public Attributes
static const SystemControls	PAUSE
	Pauses the system. More...

static const SystemControls	UNPAUSE
	Unpauses the system. More...

static const SystemControls	SPEED_UP
	Speeds up the system. More...

static const SystemControls	SPEED_DOWN
	Slows down the system. More...

static const SystemControls	SET_TIME_SCALE
	The set speed of the system. More...

static const SystemControls	SHUT_DOWN
	Shuts down the system loop and exits the program. More...

Protected Member Functions
	SystemControls (const std::string &name, unsigned int id)
	Constructor. More...

Protected Member Functions inherited from trUtil::EnumerationNumeric
	EnumerationNumeric (const std::string &name, unsigned int orderId)
	ctor Protected to prevent creation of an instance. More...

	~EnumerationNumeric ()
	dtor. More...

Protected Member Functions inherited from trUtil::EnumerationString
virtual int	Compare (const std::string &nameString) const
	Virtual string compare method to used by the operators that take a string. More...

virtual	~EnumerationString ()
	Private virtual destructor to get rid of compile warning. More...

	EnumerationString (const std::string &name)
	Construct the EnumerationString. More...

Additional Inherited Members
Public Types inherited from trUtil::EnumerationNumeric
using	BaseClass = EnumerationString
	/ Adds an easy and swappable access to the base class. More...

Public Member Functions inherited from trUtil::EnumerationNumeric
unsigned int	GetID () const
	Returns the Numeric value of the Enum. More...

bool	operator== (const unsigned int &id) const
	Equality test for an EnumerationNumeric. More...

bool	operator!= (const unsigned int &id) const
	Inequality test for an EnumerationNumeric. More...

bool	operator> (const unsigned int &id) const
	Greater than test for an EnumerationNumeric. More...

bool	operator< (const unsigned int &id) const
	Less than test for an EnumerationNumeric. More...

bool	operator> (const EnumerationNumeric &e) const
	Greater than test for an EnumerationNumeric. More...

bool	operator< (const EnumerationNumeric &e) const
	Less than test for an EnumerationNumeric. More...

bool	operator== (const EnumerationNumeric &e) const
	Equality test for an EnumerationNumeric. More...

bool	operator!= (const EnumerationNumeric &e) const
	Inequality test for an EnumerationNumeric. More...

bool	operator== (const std::string &rhs) const
	Overloaded string compare operator for the EnumerationNumeric. More...

bool	operator!= (const std::string &rhs) const
	Overloaded inequality test for this EnumerationNumeric's string value. More...

bool	operator< (const std::string &rhs) const
	Overloaded less than test for this EnumerationNumeric's string value. More...

bool	operator> (const std::string &rhs) const
	Overloaded greater than test for this EnumerationNumeric's string value. More...

Public Member Functions inherited from trUtil::EnumerationString
const std::string &	GetName () const
	Inlined because it's called frequently. More...

bool	operator== (const EnumerationString &rhs) const
	Equality test for an EnumerationString. More...

bool	operator!= (const EnumerationString &rhs) const
	Inequality test for an EnumerationString. More...

bool	operator== (const std::string &rhs) const
	Overloaded string compare operator for the EnumerationString. More...

bool	operator!= (const std::string &rhs) const
	Overloaded inequality test for this EnumerationString's string value. More...

bool	operator< (const std::string &rhs) const
	Overloaded less than test for this EnumerationString's string value. More...

bool	operator> (const std::string &rhs) const
	Overloaded greater than test for this EnumerationString's string value. More...

bool	operator< (const EnumerationString &rhs) const
	Overloaded less than operator. More...

Detailed Description

ENUM specifying various system control states.

Definition at line 35 of file SystemControls.h.

Constructor & Destructor Documentation

◆ SystemControls()

trCore::SystemControls::SystemControls	(	const std::string &	name,
		unsigned int	id
	)

protected

Constructor.

Protected to prevent creation of an instance.

Parameters

name	The name.
id	The identifier.

Definition at line 29 of file SystemControls.cpp.

References PAUSE, SET_TIME_SCALE, SHUT_DOWN, SPEED_DOWN, SPEED_UP, and UNPAUSE.

Member Data Documentation

◆ PAUSE

const SystemControls trCore::SystemControls::PAUSE

static

Pauses the system.

Definition at line 41 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), and SystemControls().

◆ SET_TIME_SCALE

const SystemControls trCore::SystemControls::SET_TIME_SCALE

static

The set speed of the system.

Needs to have a systemValue passed in with the MessageSystemControl for actual speed.

Definition at line 56 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), and SystemControls().

◆ SHUT_DOWN

const SystemControls trCore::SystemControls::SHUT_DOWN

static

Shuts down the system loop and exits the program.

Definition at line 59 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), trApp::AppBase::Quit(), and SystemControls().

◆ SPEED_DOWN

const SystemControls trCore::SystemControls::SPEED_DOWN

static

Slows down the system.

Definition at line 50 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), and SystemControls().

◆ SPEED_UP

const SystemControls trCore::SystemControls::SPEED_UP

static

Speeds up the system.

Definition at line 47 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), and SystemControls().

◆ UNPAUSE

const SystemControls trCore::SystemControls::UNPAUSE

static

Unpauses the system.

Definition at line 44 of file SystemControls.h.

Referenced by trCore::SystemDirector::OnMessage(), and SystemControls().

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

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SystemControls()

Member Data Documentation

◆ PAUSE

◆ SET_TIME_SCALE

◆ SHUT_DOWN

◆ SPEED_DOWN

◆ SPEED_UP

◆ UNPAUSE