DtSimObjectNetInterface Class Reference

Class Description: DtSimObjectNetInterface. More...

Inheritance diagram for DtSimObjectNetInterface:

List of all members.

Public Member Functions
	DtSimObjectNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor Publish object flag indicate whether or not locally simulated objects should actually publish the object on the network.
	DtSimObjectNetInterface (const DtSimObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimObjectNetInterface &	operator= (const DtSimObjectNetInterface &orig)
	assignment operator
virtual	~DtSimObjectNetInterface ()
	destructor
virtual bool	init ()
	Derived classes that need to perform virtual construction my override this function as desired.
virtual void	tick ()
	Clears the changed flag for the tick, then calls onTick().
virtual void	onTick ()=0
	Depending on the whether or not the entity is local or remote, this will cause the VR-Link network repository info to be copied to the local state repository or vice versa.
virtual DtVrfObject *	simObject () const
	This is a pointer to the simulation object for which this interface was created.
virtual DtStateRepository *	networkState () const
	this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object
virtual bool	isEntity () const =0
	Is this network interface for a local (true) or remote (false) object? Deriving network interfaces should implement this function to return the appropriate value.
virtual bool	isEnvironmental () const =0
virtual bool	isLocal () const =0
	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 =0
	Returns the type of net interface object.
virtual int	maxNameLength () const
Static Public Member Functions
static void	addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn)
	Adds a net interface creator function to the net interface factory.
static void	setFactory (DtSimObjectNetInterfaceFactory *factory)
static DtSimObjectNetInterfaceFactory *	factory ()
static DtSimObjectNetInterface *	createNetInterface (const DtString &name, const DtString &type, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	Creates a new net interface object using the factory.
static int	maxNameLengthForInterfaceType (const DtString &interfaceTypeString)
Protected Member Functions
	DtSimObjectNetInterface ()
	default constructor
Protected Attributes
DtVrfObject *	mySimObject
DtStateRepository *	myNetworkState
Static Protected Attributes
static DtSimObjectNetInterfaceFactory *	theFactory

---

Detailed Description

Class Description: DtSimObjectNetInterface.

DtSimObjectNetInterface is an abstract base class that represents the interface between a simulation object's local representation in VR-Forces and its network (VR-Link) representation

---

Constructor & Destructor Documentation

DtSimObjectNetInterface::DtSimObjectNetInterface

(

)

[protected]

default constructor

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

read/writable contructor Publish object flag indicate whether or not locally simulated objects should actually publish the object on the network.

If flag is false, no PDUs/RPR interactions should be sent over the network for the object.

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

copy constructor

virtual DtSimObjectNetInterface::~DtSimObjectNetInterface

(

)

[virtual]

destructor

---

Member Function Documentation

const DtSimObjectNetInterface& DtSimObjectNetInterface::operator=

(

const DtSimObjectNetInterface &

orig

)

assignment operator

virtual bool DtSimObjectNetInterface::init

(

)

[inline, virtual]

Derived classes that need to perform virtual construction my override this function as desired.

Reimplemented in DtSimLocalEnvironmentalNetInterface, DtVrfRemoteEnvironmentalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtSimLocalEntityNetInterface, DtGlobalEnvironmentLocalNetInterface, DtSimRemoteEntityNetInterface, DtSimEnvironmentalNetInterface, and DtSimAggregateLocalEntityNetInterface.

virtual void DtSimObjectNetInterface::tick

(

)

[virtual]

Clears the changed flag for the tick, then calls onTick().

Derived classes override onTick() to perform the work of updating or retrieving data in the network state repository. If overridden, make sure to call down to this base class version first, to ensure that the object changed flag is cleared before any other functions are called.

Reimplemented in DtVrfRemoteEnvironmentalNetInterface, DtSimLocalEnvironmentalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtSimLocalEntityNetInterface, and DtSimAggregateLocalEntityNetInterface.

virtual void DtSimObjectNetInterface::onTick

(

)

[pure virtual]

Depending on the whether or not the entity is local or remote, this will cause the VR-Link network repository info to be copied to the local state repository or vice versa.

Implemented in DtSimLocalEnvironmentalNetInterface, DtVrfRemoteEnvironmentalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, DtRemoteTacticalSmokeNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtSimLocalEntityNetInterface, DtSimRemoteEntityNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual DtVrfObject* DtSimObjectNetInterface::simObject

(

)

const [virtual]

This is a pointer to the simulation object for which this interface was created.

virtual DtStateRepository* DtSimObjectNetInterface::networkState

(

)

const [virtual]

this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object

virtual bool DtSimObjectNetInterface::isEntity

(

)

const [pure virtual]

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

Implemented in DtSimEntityNetInterface, and DtSimEnvironmentalNetInterface.

virtual bool DtSimObjectNetInterface::isEnvironmental

(

)

const [pure virtual]

Implemented in DtSimLocalEnvironmentalNetInterface, DtSimEntityNetInterface, and DtSimEnvironmentalNetInterface.

virtual bool DtSimObjectNetInterface::isLocal

(

)

const [pure 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.

Implemented in DtSimLocalEnvironmentalNetInterface, DtSimLocalEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, and DtSimRemoteEntityNetInterface.

virtual DtString DtSimObjectNetInterface::type

(

)

const [pure virtual]

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Implemented in DtSimAggregateLocalEntityNetInterface, DtSimIndividualLocalEntityNetInterface, DtSimAggregateRemoteEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, DtSimLocalControlObjectNetInterface, DtSimPseudoAggregateLocalEntityNetInterface, DtSimLocalEnvironmentalNetInterface, DtSimLocalTacticalSmokeNetInterface, DtSimIndividualRemoteEntityNetInterface, DtVrfRemoteEnvironmentalNetInterface, DtRemoteTacticalSmokeNetInterface, DtGlobalEnvironmentLocalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtGlobalEnvironmentRemoteNetInterface, MyIndividualLocalEntityNetInterface, and MyIndividualRemoteEntityNetInterface.

virtual int DtSimObjectNetInterface::maxNameLength

(

)

const [virtual]

Deprecated:

To be removed after VR-Forces version 3.11 Calls maxNameLengthForInterfaceType(type()).

static void DtSimObjectNetInterface::addSimObjectNetInterfaceCreatorFcn	(	const DtString &	type,
		DtSimObjectNetIfaceCreatorFcn	fcn
	)		[static]

Adds a net interface creator function to the net interface factory.

Strings are defined in netIfTypes.h.

static void DtSimObjectNetInterface::setFactory

(

DtSimObjectNetInterfaceFactory *

factory

)

[static]

static DtSimObjectNetInterfaceFactory* DtSimObjectNetInterface::factory

(

)

[static]

Returns:

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static DtSimObjectNetInterface* DtSimObjectNetInterface::createNetInterface	(	const DtString &	name,
		const DtString &	type,
		DtVrfObject *	simObject,
		DtReaderWriterRegistry *	parentRegistry = 0,
		bool	publishObject = true
	)		[static]

Creates a new net interface object using the factory.

static int DtSimObjectNetInterface::maxNameLengthForInterfaceType

(

const DtString &

interfaceTypeString

)

[static]

Returns:

The maximum name length that will be transmitted by a network interface of the specified type.

Parameters:

interfaceTypeString

must be of a type specified in vrfNetIfTypes.h

---

Member Data Documentation

DtVrfObject* DtSimObjectNetInterface::mySimObject [protected]

DtStateRepository* DtSimObjectNetInterface::myNetworkState [protected]

DtSimObjectNetInterfaceFactory* DtSimObjectNetInterface::theFactory [static, protected]

Reimplemented from DtReaderWriter.

---

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

• include/vrfobjcore/netIface.h