This is the base class for all the messages in TR. More...

#include <MessageBase.h>

Inheritance diagram for trManager::MessageBase:

Collaboration diagram for trManager::MessageBase:

Public Types
using	BaseClass = trBase::SmrtClass

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

Public Member Functions
	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 std::string &	GetMessageType () const =0
	Returns the Message type. More...

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...

Protected Member Functions
	~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
trBase::ObsrvrPtr< const trBase::UniqueId >	mFromActorID

trBase::ObsrvrPtr< const trBase::UniqueId >	mAboutActorID

bool	mIsDirect

const std::string *	mMessageFilter

trBase::UniqueId	mId

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

This is the base class for all the messages in TR.

It is immutable, and all messages derived from it should keep that tradition.

Definition at line 40 of file MessageBase.h.

Member Typedef Documentation

◆ BaseClass

using trManager::MessageBase::BaseClass = trBase::SmrtClass

Definition at line 44 of file MessageBase.h.

Constructor & Destructor Documentation

◆ MessageBase()

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.

ctor.

Parameters

fromActorID	Id of the actor this message is being sent from.
aboutActorID	(Optional) Id of the actor this message is being sent to, or is about.
isDirect	(Optional) If TRUE, this message will skip all the Directors.
messageFilter	(Optional) A custom filter for developer use.

Definition at line 32 of file MessageBase.cpp.

References LOG_D, mAboutActorID, mFromActorID, mId, mIsDirect, mMessageFilter, and trBase::UniqueId::ToString().

Here is the call graph for this function: