DtSimLocalControlObjectNetInterface Class Reference

Class Description: DtSimLocalEnvironmentalNetInterface. More...

Inheritance diagram for DtSimLocalControlObjectNetInterface:

List of all members.

Public Member Functions
	DtSimLocalControlObjectNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimLocalControlObjectNetInterface (const DtSimLocalEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor; NOTE: The publisher is not copied, because VR-Link does not provide a copy constructor (or clone or assignment function) for a publisher.
const DtSimLocalControlObjectNetInterface &	operator= (const DtSimLocalControlObjectNetInterface &orig)
	assignment operator; see note on copy constructor above.
virtual	~DtSimLocalControlObjectNetInterface ()
	destructor; calls destroyPublisher()
virtual DtControlObjectRepository *	controlObjectNetworkState () const
	Get the control object publisher for this object.
virtual void	updatePublisher ()
	UPdate this publisher's contents.
virtual DtString	type () const
	Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")
Static Public Member Functions
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Protected Member Functions
	DtSimLocalControlObjectNetInterface ()
	default constructor
virtual bool	updateGeometry (DtVrfOverlayObjectStateRepository *localState)
	Builds a DtList of env.
virtual bool	updateBoundingGeometry (DtVrfOverlayObjectStateRepository *localState)
	Fills in bounding sphere, bounding rect records.
virtual bool	updateObjectState (DtVrfOverlayObjectStateRepository *localState)
	Fills in object state record.
virtual bool	updateEnvModelType (DtVrfOverlayObjectStateRepository *localState)
virtual bool	updateVrfDataAsSeenByRemote ()
	Update contents of our environmental state with data from our DtVrfObject.
virtual DtEnvironmentProcessPublisher *	_createPublisher () const
	Override this functions to use a subclass of DtEnvironmentProcessPublisher.
virtual DtEnvironmentProcessRepository *	_createSR () const
	Override this functions to use a subclass of DtEnvironmentProcessStateRepository.

---

Detailed Description

Class Description: DtSimLocalEnvironmentalNetInterface.

Derived from DtSimEnvironmentalNetInterface, DtSimLocalEnvironmentalNetInterface provides an interface between a local environmental object and it's network (VR-Link) representation.

---

Constructor & Destructor Documentation

DtSimLocalControlObjectNetInterface::DtSimLocalControlObjectNetInterface

(

)

[protected]

default constructor

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

read/writable contructor

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

copy constructor; NOTE: The publisher is not copied, because VR-Link does not provide a copy constructor (or clone or assignment function) for a publisher.

Therefore, you must call init() on the copy after construction, or call setPublisher() with a user constructed publisher.

virtual DtSimLocalControlObjectNetInterface::~DtSimLocalControlObjectNetInterface

(

)

[virtual]

destructor; calls destroyPublisher()

---

Member Function Documentation

const DtSimLocalControlObjectNetInterface& DtSimLocalControlObjectNetInterface::operator=

(

const DtSimLocalControlObjectNetInterface &

orig

)

assignment operator; see note on copy constructor above.

virtual DtControlObjectRepository* DtSimLocalControlObjectNetInterface::controlObjectNetworkState

(

)

const [virtual]

Get the control object publisher for this object.

virtual void DtSimLocalControlObjectNetInterface::updatePublisher

(

)

[virtual]

UPdate this publisher's contents.

Implements DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

virtual DtString DtSimLocalControlObjectNetInterface::type

(

)

const [virtual]

Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")

Implements DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

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

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

virtual bool DtSimLocalControlObjectNetInterface::updateGeometry

(

DtVrfOverlayObjectStateRepository *

localState

)

[protected, virtual]

Builds a DtList of env.

geometry records. Deriving classes can override and create different kinds of geometry records if desired.

virtual bool DtSimLocalControlObjectNetInterface::updateBoundingGeometry

(

DtVrfOverlayObjectStateRepository *

localState

)

[protected, virtual]

Fills in bounding sphere, bounding rect records.

virtual bool DtSimLocalControlObjectNetInterface::updateObjectState

(

DtVrfOverlayObjectStateRepository *

localState

)

[protected, virtual]

Fills in object state record.

virtual bool DtSimLocalControlObjectNetInterface::updateEnvModelType

(

DtVrfOverlayObjectStateRepository *

localState

)

[protected, virtual]

virtual bool DtSimLocalControlObjectNetInterface::updateVrfDataAsSeenByRemote

(

)

[protected, virtual]

Update contents of our environmental state with data from our DtVrfObject.

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

virtual DtEnvironmentProcessPublisher* DtSimLocalControlObjectNetInterface::_createPublisher

(

)

const [protected, virtual]

Override this functions to use a subclass of DtEnvironmentProcessPublisher.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

virtual DtEnvironmentProcessRepository* DtSimLocalControlObjectNetInterface::_createSR

(

)

const [protected, virtual]

Override this functions to use a subclass of DtEnvironmentProcessStateRepository.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

---

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

• include/vrfobjcore/ctlrObjLclNetIf.h