A message that lets the system know what state to enable and setup. More...

#include <MessageSystemControl.h>

Inheritance diagram for trCore::MessageSystemControl:

Collaboration diagram for trCore::MessageSystemControl:

Public Types
using	BaseClass = trManager::MessageBase

Public Types inherited from trManager::MessageBase
using	BaseClass = trBase::SmrtClass

Public Types inherited from trBase::SmrtClass
using	BaseClass = osg::Referenced

Public Member Functions
	MessageSystemControl (const trBase::UniqueId *fromActorID, const trCore::SystemControls &systemControl, double systemValue=0)
	Holds the class/message type name for efficient comparisons. More...

virtual const std::string &	GetMessageType () const override
	Returns the Message type. More...

virtual const trCore::SystemControls &	GetSysControlType () const
	Gets system control type. More...

virtual double	GetSystemValue () const
	Gets system value. More...

Public Member Functions inherited from trManager::MessageBase
	MessageBase (const trBase::UniqueId fromActorID, const trBase::UniqueId aboutActorID=NULL, const bool isDirect=false, const std::string &messageFilter=trUtil::StringUtils::STR_BLANK)
	Holds the class/message type name for efficient comparisons. More...

bool	operator== (const MessageBase &msg) const

bool	operator!= (const MessageBase &msg) const

virtual const trBase::UniqueId *	GetFromActorID () const
	Returns the ID of the actor the message was sent from. More...

virtual const trBase::UniqueId *	GetAboutActorID () const
	Returns the ID of the actor this message is about, or sent to. More...

virtual const bool &	GetIsDirect () const
	Returns True if this message is a direct message and skips all Directors. More...

virtual const std::string &	GetMessageFilter ()
	Returns the custom Filter string. More...

Public Member Functions inherited from trBase::SmrtClass
	SmrtClass ()
	Adds an easy and swappable access to the base class. More...

	SmrtClass (bool threadSafeRefUnref)
	Constructor. More...

	SmrtClass (const SmrtClass &inst)
	Copy constructor. More...

virtual bool	GetThreadSafeRefUnref ()
	Get whether a mutex is used to ensure Ref() and UnRef() are thread safe. More...

OpenThreads::Mutex *	GetRefMutex () const
	Get the mutex used to ensure thread safety of Ref()/UnRef(). More...

int	Ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

int	Unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	UnRefNoDelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...

int	ReferenceCount () const
	Return the number of pointers currently referencing this object. More...

Static Public Attributes
static const trUtil::RefStr	MESSAGE_TYPE
	Adds an easy and swappable access to the base class. More...

Static Public Attributes inherited from trManager::MessageBase
static const trUtil::RefStr	MESSAGE_TYPE
	Adds an easy and swappable access to the base class. More...

Protected Member Functions
	~MessageSystemControl ()
	Destructor. More...

Protected Member Functions inherited from trManager::MessageBase
	~MessageBase ()
	dtor. More...

virtual const std::string &	GetType () const override
	Returns the class type Made protected to hide it. More...

Protected Member Functions inherited from trBase::SmrtClass
	~SmrtClass ()

Private Attributes
const trCore::SystemControls *	mSystemControl

double	mSystemValue

Additional Inherited Members
Static Public Member Functions inherited from trBase::SmrtClass
static OpenThreads::Mutex *	GetGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all trBase::SmrtClass. More...

Detailed Description

A message that lets the system know what state to enable and setup.

Definition at line 37 of file MessageSystemControl.h.

Member Typedef Documentation

◆ BaseClass

using trCore::MessageSystemControl::BaseClass = trManager::MessageBase

Definition at line 40 of file MessageSystemControl.h.

Constructor & Destructor Documentation

◆ MessageSystemControl()

trCore::MessageSystemControl::MessageSystemControl	(	const trBase::UniqueId *	fromActorID,
		const trCore::SystemControls &	systemControl,
		double	systemValue = `0`
	)

Holds the class/message type name for efficient comparisons.

Constructor.

Parameters

fromActorID	Identifier for from actor.
systemControl	The system control.
systemValue	(Optional) The system value is used to pass data for specific Controls. Not all Controls need one.

Definition at line 29 of file MessageSystemControl.cpp.

References mSystemControl, and mSystemValue.