A message that is sent out on event traversal. More...

#include <MessageEventTraversal.h>

Inheritance diagram for trCore::MessageEventTraversal:

Collaboration diagram for trCore::MessageEventTraversal:

Public Types
using	BaseClass = trManager::MessageTick

Public Types inherited from trManager::MessageTick
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
	MessageEventTraversal (const trBase::UniqueId *fromActorID, const trManager::TimingStructure &timeStruct)
	Holds the class/message type name for efficient comparisons. More...

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

Public Member Functions inherited from trManager::MessageTick
	MessageTick (const trBase::UniqueId *fromActorID, const trManager::TimingStructure &timeStruct)
	Holds the class/message type name for efficient comparisons. More...

const int &	GetFrameNumber (void) const
	Gets frame number. More...

const double &	GetDeltaSimTime (void) const
	Access the DeltaSimTime. More...

const double &	GetDeltaRealTime (void) const
	Access the DeltaRealTime. More...

const double &	GetSimTime (void) const
	Access the SimTime. More...

const double &	GetRealTime (void) const
	Access the RealTime. More...

const double &	GetTimeScale (void) const
	Access the TimeScale. 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::MessageTick
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
	~MessageEventTraversal ()
	Destructor. More...

Protected Member Functions inherited from trManager::MessageTick
	~MessageTick ()
	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 ()

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 is sent out on event traversal.

Definition at line 40 of file MessageEventTraversal.h.

Member Typedef Documentation

◆ BaseClass

using trCore::MessageEventTraversal::BaseClass = trManager::MessageTick

Definition at line 43 of file MessageEventTraversal.h.

Constructor & Destructor Documentation

◆ MessageEventTraversal()

trCore::MessageEventTraversal::MessageEventTraversal	(	const trBase::UniqueId *	fromActorID,
		const trManager::TimingStructure &	timeStruct
	)

Holds the class/message type name for efficient comparisons.

Constructor.

Parameters

fromActorID	Id of the actor that is sending the message.
timeStruct	The time structure.

Definition at line 29 of file MessageEventTraversal.cpp.

◆ ~MessageEventTraversal()

trCore::MessageEventTraversal::~MessageEventTraversal ( )

protected

Destructor.

Definition at line 35 of file MessageEventTraversal.cpp.

Member Function Documentation

◆ GetMessageType()

const std::string & trCore::MessageEventTraversal::GetMessageType ( ) const

overridevirtual

Returns the Message type.

Returns: The message type.

Reimplemented from trManager::MessageTick.

Definition at line 40 of file MessageEventTraversal.cpp.

References MESSAGE_TYPE.

Member Data Documentation

◆ MESSAGE_TYPE

const trUtil::RefStr trCore::MessageEventTraversal::MESSAGE_TYPE

static

Adds an easy and swappable access to the base class.

Definition at line 45 of file MessageEventTraversal.h.

Referenced by GetMessageType().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members