DtSimRemoteEnvironmentalNetInterface Class Reference

File: remEnvNetIf.h. More...

Inheritance diagram for DtSimRemoteEnvironmentalNetInterface:

List of all members.

Public Member Functions
	DtSimRemoteEnvironmentalNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimRemoteEnvironmentalNetInterface (const DtSimRemoteEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimRemoteEnvironmentalNetInterface &	operator= (const DtSimRemoteEnvironmentalNetInterface &orig)
	assignment operator
virtual	~DtSimRemoteEnvironmentalNetInterface ()
	destructor
virtual bool	init ()
	override of base class init().
virtual void	onTick ()
	override of base class onTick(), calls updateFromReflectedObject()
virtual void	updateFromReflectedObject ()
	this will copy from the reflected environment process and associated network state repository to the local state repository
virtual DtReflectedEnvironmentProcess *	reflectedObject () const
	returns the pointer to the VR-Link reflected entity being used to represent this remote entity
virtual void	setupFromNetworkRepository ()
	initializes parts of the local repository from the network state rep.
virtual void	setReflectedObject (DtReflectedEnvironmentProcess *reflectedObject)
	A reflected object must always be supplied.
virtual bool	isLocal () const
	Is this network interface for a local (true) or remote (false) object? Local network interfaces should implement this function to return true.
virtual DtString	type () const
	Returns the type of net interface object.
virtual void	setUpdateReceived (bool updateReceived)
	Setting update received to true will cause updateFromRemoteObject() to be called on the next tick.
virtual bool	updateReceived () const
	Check to see if an update has been received from the network.
Static Public Member Functions
static DtSimRemoteEnvironmentalNetInterface *	isRemoteEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimIndividualRemoteEntityNetInterface*, provided the objNetInterface is indeed an individual remote entity network interface.
static void	reflectedObjectUpdateCallbackFunction (DtReflectedObject *obj, void *userData)
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Protected Member Functions
	DtSimRemoteEnvironmentalNetInterface ()
	default constructor
virtual void	updateLocalGeometry (DtVrfObjectStateRepository *localState)
	put the data INTO the local state repository
virtual void	updateLocalBoundingGeometry (DtVrfObjectStateRepository *localState)
virtual void	updateLocalObjectState (DtVrfObjectStateRepository *localState)
virtual void	updateLocalObjectType (DtVrfObjectStateRepository *localState)
virtual void	updateLocalModelType (DtVrfObjectStateRepository *localState)
Protected Attributes
DtReflectedEnvironmentProcess *	myReflectedObject
	Pointer to the VR-Link Reflected Object.
bool	myUpdateReceived
	Set to true by post-update callback; set to false after update has been processed.

---

Detailed Description

File: remEnvNetIf.h.

Class: DtSimRemoteEnvironmentalNetInterface Class Description: DtSimRemoteEnvironmentalNetInterface

Derived from DtSimEnvironmentalNetInterface, DtSimRemoteEnvironmentalNetInterface provides an interface between the local representation of a remote environmental object and it's network (VR-Link) representation (DtReflectedEnvironmentProcess and DtEnvironmentProcessRepository).

---

Constructor & Destructor Documentation

DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface

(

)

[protected]

default constructor

DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface	(	const DtString &	name,
		DtVrfObject *	simObject,
		DtReaderWriterRegistry *	parentRegistry = 0,
		bool	publishObject = true
	)

read/writable contructor

DtSimRemoteEnvironmentalNetInterface::DtSimRemoteEnvironmentalNetInterface	(	const DtSimRemoteEnvironmentalNetInterface &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSimRemoteEnvironmentalNetInterface::~DtSimRemoteEnvironmentalNetInterface

(

)

[virtual]

destructor

---

Member Function Documentation

const DtSimRemoteEnvironmentalNetInterface& DtSimRemoteEnvironmentalNetInterface::operator=

(

const DtSimRemoteEnvironmentalNetInterface &

orig

)

assignment operator

virtual bool DtSimRemoteEnvironmentalNetInterface::init

(

)

[virtual]

override of base class init().

Registers for post update callbacks on reflected object.

Reimplemented from DtSimEnvironmentalNetInterface.

Reimplemented in DtVrfRemoteEnvironmentalNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::onTick

(

)

[virtual]

override of base class onTick(), calls updateFromReflectedObject()

Implements DtSimObjectNetInterface.

Reimplemented in DtVrfRemoteEnvironmentalNetInterface, DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateFromReflectedObject

(

)

[virtual]

this will copy from the reflected environment process and associated network state repository to the local state repository

virtual DtReflectedEnvironmentProcess* DtSimRemoteEnvironmentalNetInterface::reflectedObject

(

)

const [virtual]

returns the pointer to the VR-Link reflected entity being used to represent this remote entity

virtual void DtSimRemoteEnvironmentalNetInterface::setupFromNetworkRepository

(

)

[virtual]

initializes parts of the local repository from the network state rep.

This needs to be done after the call to setReflectedObject()

virtual void DtSimRemoteEnvironmentalNetInterface::setReflectedObject

(

DtReflectedEnvironmentProcess *

reflectedObject

)

[virtual]

A reflected object must always be supplied.

This function also sets the network state repository pointer (myBaseNetworkState) to the repository created by this reflected object

virtual bool DtSimRemoteEnvironmentalNetInterface::isLocal

(

)

const [inline, virtual]

Is this network interface for a local (true) or remote (false) object? Local network interfaces should implement this function to return true.

Remote network interfaces should implement this to return true.

Implements DtSimObjectNetInterface.

virtual DtString DtSimRemoteEnvironmentalNetInterface::type

(

)

const [virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Implements DtSimObjectNetInterface.

Reimplemented in DtVrfRemoteEnvironmentalNetInterface, DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::setUpdateReceived

(

bool

updateReceived

)

[virtual]

Setting update received to true will cause updateFromRemoteObject() to be called on the next tick.

virtual bool DtSimRemoteEnvironmentalNetInterface::updateReceived

(

)

const [virtual]

Check to see if an update has been received from the network.

static DtSimRemoteEnvironmentalNetInterface* DtSimRemoteEnvironmentalNetInterface::isRemoteEnvironmentalNetInterface

(

const DtSimObjectNetInterface *

objNetInterface

)

[static]

This function will return the objNetInterface passed in, cast to a DtSimIndividualRemoteEntityNetInterface*, provided the objNetInterface is indeed an individual remote entity network interface.

static void DtSimRemoteEnvironmentalNetInterface::reflectedObjectUpdateCallbackFunction	(	DtReflectedObject *	obj,
		void *	userData
	)		[static]

static DtSimObjectNetInterface* DtSimRemoteEnvironmentalNetInterface::creator	(	const DtString &	name,
		DtVrfObject *	simObject,
		DtReaderWriterRegistry *	parentRegistry,
		bool	publishObject
	)		[static]

Reimplemented in DtVrfRemoteEnvironmentalNetInterface, DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalGeometry

(

DtVrfObjectStateRepository *

localState

)

[protected, virtual]

put the data INTO the local state repository

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalBoundingGeometry

(

DtVrfObjectStateRepository *

localState

)

[protected, virtual]

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalObjectState

(

DtVrfObjectStateRepository *

localState

)

[protected, virtual]

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalObjectType

(

DtVrfObjectStateRepository *

localState

)

[protected, virtual]

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalModelType

(

DtVrfObjectStateRepository *

localState

)

[protected, virtual]

---

Member Data Documentation

DtReflectedEnvironmentProcess* DtSimRemoteEnvironmentalNetInterface::myReflectedObject [protected]

Pointer to the VR-Link Reflected Object.

bool DtSimRemoteEnvironmentalNetInterface::myUpdateReceived [protected]

Set to true by post-update callback; set to false after update has been processed.

---

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

• include/vrfobjcore/remEnvNetIf.h