DtVrfObjectDataMessenger Class Reference

DtVrfObjectDataMessenger sends DtVrfObjectData messages when attached to remote entities. More...

Inheritance diagram for DtVrfObjectDataMessenger:

List of all members.

Public Member Functions
	DtVrfObjectDataMessenger (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtVrfObjectDataMessenger ()
	Destructor.
virtual bool	init ()
	Init. Call immediately after construction.
virtual bool	prepMessage ()
	Set values in the message before sending.
virtual void	processEntityUpdated (DtReflectedEntity *pEnt)
	marks myNeedToSendUpdate = true;
virtual bool	sendMessage ()
	Send the outgoing message.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This components simulation tick.
DtTime	timeLastSent () const
DtTime	maxSendInterval () const
	Longest period of time to wait before resending message.
void	setMaxSendInterval (DtTime ival)
	Longest period of time to wait before resending message.
DtTime	minSendInterval () const
	Shortest period of time to wait before resending message.
void	setMinSendInterval (DtTime ival)
	Shortest period of time to wait before resending message.
Static Public Member Functions
static void	entityUpdatedCallback (DtReflectedEntity *pEnt, void *pUsr)
	registered with reflected entity, to drive message generation
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Attributes
DtTime	myMaxSendInterval
DtTime	myMinSendInterval
bool	myNeedToSendUpdate
DtTime	myTimeLastSent
DtVrfExtensions	myVrfExtensions
Private Member Functions
	DtVrfObjectDataMessenger ()
	Not Implemented.
	DtVrfObjectDataMessenger (const DtVrfObjectDataMessenger &orig)
	Not Implemented.
DtVrfObjectDataMessenger &	operator= (const DtVrfObjectDataMessenger &orig)
	Not Implemented.

---

Detailed Description

DtVrfObjectDataMessenger sends DtVrfObjectData messages when attached to remote entities.

---

Constructor & Destructor Documentation

DtVrfObjectDataMessenger::DtVrfObjectDataMessenger

(

)

[private]

Not Implemented.

DtVrfObjectDataMessenger::DtVrfObjectDataMessenger

(

const DtVrfObjectDataMessenger &

orig

)

[private]

Not Implemented.

DtVrfObjectDataMessenger::DtVrfObjectDataMessenger	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtVrfObjectDataMessenger::~DtVrfObjectDataMessenger

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtVrfObjectDataMessenger& DtVrfObjectDataMessenger::operator=

(

const DtVrfObjectDataMessenger &

orig

)

[private]

Not Implemented.

virtual bool DtVrfObjectDataMessenger::init

(

)

[virtual]

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

DtTime DtVrfObjectDataMessenger::maxSendInterval

(

)

const [inline]

Longest period of time to wait before resending message.

References myMaxSendInterval.

void DtVrfObjectDataMessenger::setMaxSendInterval

(

DtTime

ival

)

[inline]

Longest period of time to wait before resending message.

References myMaxSendInterval.

DtTime DtVrfObjectDataMessenger::minSendInterval

(

)

const [inline]

Shortest period of time to wait before resending message.

References myMinSendInterval.

void DtVrfObjectDataMessenger::setMinSendInterval

(

DtTime

ival

)

[inline]

Shortest period of time to wait before resending message.

References myMinSendInterval.

virtual bool DtVrfObjectDataMessenger::prepMessage

(

)

[virtual]

Set values in the message before sending.

Called from tick();

virtual void DtVrfObjectDataMessenger::processEntityUpdated

(

DtReflectedEntity *

pEnt

)

[virtual]

marks myNeedToSendUpdate = true;

virtual bool DtVrfObjectDataMessenger::sendMessage

(

)

[virtual]

Send the outgoing message.

Called from tick();

virtual void DtVrfObjectDataMessenger::setComponentDescriptor

(

DtComponentDescriptor *

componentDescriptor

)

[virtual]

The component descriptor specified in the order of battle file or parameter file that was used to create this component.

It may be derived from and hold component-specific parameter information.

Reimplemented from DtSimComponent.

virtual DtString DtVrfObjectDataMessenger::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtCustomReportSpotReportGeneratorControllerType

Reimplemented from DtControllerComponent.

virtual void DtVrfObjectDataMessenger::tick

(

)

[virtual]

This components simulation tick.

Periodically sends vrf object data messages

Reimplemented from DtSimComponent.

DtTime DtVrfObjectDataMessenger::timeLastSent

(

)

const [inline]

References myTimeLastSent.

static void DtVrfObjectDataMessenger::entityUpdatedCallback	(	DtReflectedEntity *	pEnt,
		void *	pUsr
	)		[static]

registered with reflected entity, to drive message generation

static DtSimComponent* DtVrfObjectDataMessenger::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

---

Member Data Documentation

DtTime DtVrfObjectDataMessenger::myMaxSendInterval [protected]

Referenced by maxSendInterval(), and setMaxSendInterval().

DtTime DtVrfObjectDataMessenger::myMinSendInterval [protected]

Referenced by minSendInterval(), and setMinSendInterval().

bool DtVrfObjectDataMessenger::myNeedToSendUpdate [protected]

DtTime DtVrfObjectDataMessenger::myTimeLastSent [protected]

Referenced by timeLastSent().

DtVrfExtensions DtVrfObjectDataMessenger::myVrfExtensions [protected]

---

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

• include/vrfmodel/vrfObjectDataMessenger.h