DtSimRemoteEnvironmentalNetInterface Class Reference

File: remEnvNetIf.h. More...

Inheritance diagram for DtSimRemoteEnvironmentalNetInterface:

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.
Public Member Functions inherited from DtSimEnvironmentalNetInterface
	DtSimEnvironmentalNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimEnvironmentalNetInterface (const DtSimEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimEnvironmentalNetInterface &	operator= (const DtSimEnvironmentalNetInterface &orig)
	assignment operator
virtual	~DtSimEnvironmentalNetInterface ()
	destructor
virtual DtControlObjectRepository *	environmentalNetworkState () const
virtual bool	isEntity () const
	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
Public Member Functions inherited from 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.
	DtSimObjectNetInterface (const DtSimObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimObjectNetInterface &	operator= (const DtSimObjectNetInterface &orig)
	assignment operator
virtual	~DtSimObjectNetInterface ()
	destructor
virtual void	tick ()
	Clears the changed flag for the tick, then calls onTick().
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 int	maxNameLength () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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)
Static Public Member Functions inherited from DtSimEnvironmentalNetInterface
static DtSimEnvironmentalNetInterface *	isEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimEntityNetInterface*, provided the objNetInterface is indeed an entity network interface.
Static Public Member Functions inherited from DtSimObjectNetInterface
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)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

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 Member Functions inherited from DtSimEnvironmentalNetInterface
	DtSimEnvironmentalNetInterface ()
	default constructor
Protected Member Functions inherited from DtSimObjectNetInterface
	DtSimObjectNetInterface ()
	default constructor
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory

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

inlinevirtual

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 )

protectedvirtual

put the data INTO the local state repository

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalBoundingGeometry ( DtVrfObjectStateRepository *  localState )

protectedvirtual

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalObjectState ( DtVrfObjectStateRepository *  localState )

protectedvirtual

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalObjectType ( DtVrfObjectStateRepository *  localState )

protectedvirtual

virtual void DtSimRemoteEnvironmentalNetInterface::updateLocalModelType ( DtVrfObjectStateRepository *  localState )

protectedvirtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/remEnvNetIf.h