This message carries all the inter-frame timing information. More...

#include <MessageTick.h>

Inheritance diagram for trManager::MessageTick:

Collaboration diagram for trManager::MessageTick:

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

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::MessageBase
static const trUtil::RefStr	MESSAGE_TYPE
	Adds an easy and swappable access to the base class. More...

Protected Member Functions
	~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 ()

Private Attributes
const int *	mFrameNumber

const double *	mDeltaSimTime

const double *	mDeltaRealTime

const double *	mSimTime

const double *	mRealTime

const double *	mTimeScale

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 message carries all the inter-frame timing information.

Register for this message to receive frame times.

Definition at line 40 of file MessageTick.h.

Member Typedef Documentation

◆ BaseClass

using trManager::MessageTick::BaseClass = trManager::MessageBase

Definition at line 43 of file MessageTick.h.

Constructor & Destructor Documentation

◆ MessageTick()

trManager::MessageTick::MessageTick	(	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 MessageTick.cpp.

References trManager::TimingStructure::deltaRealTime, trManager::TimingStructure::deltaSimTime, trManager::TimingStructure::frameNumber, mDeltaRealTime, mDeltaSimTime, mFrameNumber, mRealTime, mSimTime, mTimeScale, trManager::TimingStructure::realTime, trManager::TimingStructure::simTime, and trManager::TimingStructure::timeScale.

◆ ~MessageTick()

trManager::MessageTick::~MessageTick ( )

protected

Destructor.

Definition at line 41 of file MessageTick.cpp.

Member Function Documentation

◆ GetDeltaRealTime()

const double & trManager::MessageTick::GetDeltaRealTime ( void ) const

inline

Access the DeltaRealTime.

Returns: The delta real time.

Definition at line 91 of file MessageTick.h.

◆ GetDeltaSimTime()

const double & trManager::MessageTick::GetDeltaSimTime ( void ) const

inline

Access the DeltaSimTime.

Returns: The delta simulation time.

Definition at line 82 of file MessageTick.h.

◆ GetFrameNumber()

const int & trManager::MessageTick::GetFrameNumber ( void ) const

inline

Gets frame number.

Returns: The frame number.

Definition at line 73 of file MessageTick.h.

◆ GetMessageType()

const std::string & trManager::MessageTick::GetMessageType ( ) const

overridevirtual

Returns the Message type.

Returns: The message type.

Implements trManager::MessageBase.

Reimplemented in trCore::MessageCameraSynch, trCore::MessageEventTraversal, trCore::MessageFrame, trCore::MessageFrameSynch, trCore::MessagePostEventTraversal, and trCore::MessagePostFrame.

Definition at line 46 of file MessageTick.cpp.

References MESSAGE_TYPE.

◆ GetRealTime()

const double & trManager::MessageTick::GetRealTime ( void ) const

inline

Access the RealTime.

Returns: The real time.

Definition at line 109 of file MessageTick.h.

◆ GetSimTime()

const double & trManager::MessageTick::GetSimTime ( void ) const

inline

Access the SimTime.

Returns: The simulation time.

Definition at line 100 of file MessageTick.h.

◆ GetTimeScale()

const double & trManager::MessageTick::GetTimeScale ( void ) const

inline

Access the TimeScale.

Returns: The time scale.

Definition at line 118 of file MessageTick.h.

Member Data Documentation

◆ mDeltaRealTime

const double* trManager::MessageTick::mDeltaRealTime

private

Definition at line 133 of file MessageTick.h.

Referenced by MessageTick().

◆ mDeltaSimTime

const double* trManager::MessageTick::mDeltaSimTime

private

Definition at line 132 of file MessageTick.h.

Referenced by MessageTick().

◆ MESSAGE_TYPE

const trUtil::RefStr trManager::MessageTick::MESSAGE_TYPE

static

Adds an easy and swappable access to the base class.

Definition at line 45 of file MessageTick.h.

Referenced by GetMessageType().

◆ mFrameNumber

const int* trManager::MessageTick::mFrameNumber

private

Definition at line 131 of file MessageTick.h.

Referenced by MessageTick().

◆ mRealTime

const double* trManager::MessageTick::mRealTime

private

Definition at line 135 of file MessageTick.h.

Referenced by MessageTick().

◆ mSimTime

const double* trManager::MessageTick::mSimTime

private

Definition at line 134 of file MessageTick.h.

Referenced by MessageTick().

◆ mTimeScale

const double* trManager::MessageTick::mTimeScale

private

Definition at line 136 of file MessageTick.h.

Referenced by MessageTick().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ MessageTick()

◆ ~MessageTick()

Member Function Documentation

◆ GetDeltaRealTime()

◆ GetDeltaSimTime()

◆ GetFrameNumber()

◆ GetMessageType()

◆ GetRealTime()

◆ GetSimTime()

◆ GetTimeScale()

Member Data Documentation

◆ mDeltaRealTime

◆ mDeltaSimTime

◆ MESSAGE_TYPE

◆ mFrameNumber

◆ mRealTime

◆ mSimTime

◆ mTimeScale