Derived from DtSimEntityNetInterface, DtSimRemoteEntityNetInterface provides an interface between the local representation of a remote entity and it's network (VR-Link) representation. More...

Inheritance diagram for DtSimRemoteEntityNetInterface:

[legend]

Public Member Functions
	DtSimRemoteEntityNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtSimRemoteEntityNetInterface (const DtSimRemoteEntityNetInterface &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 DtSimRemoteEntityNetInterface &	operator= (const DtSimRemoteEntityNetInterface &orig)
	assignment operator; see note on copy constructor above
virtual	~DtSimRemoteEntityNetInterface ()
	destructor; calls destroyPublisher()
virtual bool	init ()
	override of base class init().
virtual void	onTick ()
	override of base class onTick(), calls updateFromReflectedObject()
virtual void	updateFromReflectedObject ()=0
	this will copy from whatever type of reflected object and associated network state repository the deriving class uses to the local state repository
virtual void	setupFromNetworkRepository ()
	initializes parts of the local repository from the network state rep.
virtual void	setReflectedObject (DtReflectedObject *reflectedObject)
	For local entities, a publisher can be created or supplied via a set<>Publisher call.
virtual const DtReflectedObject *	reflectedObject () const
virtual DtReflectedObject *	reflectedObject ()
virtual bool	isLocal () const
	This network interface is for local entities.
virtual bool	isAggregate () const =0
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.
virtual void	updateUUIDIfNeeded ()
	Upon setting of reflected object see if UUID needs to be updated.
virtual RTI::ObjectClassHandle	objectClassHandle () const
	Returns the HLA object class handle of the reflected object.
Public Member Functions inherited from DtSimEntityNetInterface
	DtSimEntityNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimEntityNetInterface (const DtSimEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimEntityNetInterface &	operator= (const DtSimEntityNetInterface &orig)
	assignment operator
virtual	~DtSimEntityNetInterface ()
	destructor
virtual DtBaseEntityStateRepository *	baseEntityNetworkState () const
virtual bool	isEntity () const
	This network interface is for entities, in the DIS - HLA/RPR sense.
virtual bool	isEnvironmental () const
Public Member Functions inherited from DtSimObjectNetInterface
	DtSimObjectNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor 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 DtString	type () const =0
	Returns the type of net interface 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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static const DtSimRemoteEntityNetInterface *	isRemoteEntityNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimRemoteEntityNetInterface*, provided the objNetInterface is indeed an remote entity network interface.
static DtSimRemoteEntityNetInterface *	isRemoteEntityNetInterface (DtSimObjectNetInterface *objNetInterface)
static void	reflectedObjectUpdateCallbackFunction (DtReflectedObject obj, void userData)
Static Public Member Functions inherited from DtSimEntityNetInterface
static DtSimEntityNetInterface *	isEntityNetInterface (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	setNonVrfUUIDResolver (DtNonVrfUUIDResolver *)
	Sets the resolver that is to be used when resolving non-VR-Forces uuids.
static DtNonVrfUUIDResolver *	nonVrfUUIDResolver ()
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 void	setNonVrfObjectsUUIDScheme (const DtString &)
	Sets the UUID scheme for non vrf objects.
static DtString	nonVrfObjectsUUIDScheme ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
	DtSimRemoteEntityNetInterface ()
	default constructor
Protected Member Functions inherited from DtSimEntityNetInterface
	DtSimEntityNetInterface ()
	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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtReflectedObject *	myReflectedObject
	Pointer to the VR-Link Reflected Object (may be a DtReflectedEntity, DtReflectedExtAggregate, etc.
bool	myUpdateReceived
	Set to true by post-update callback; set to false after update has been processed.
Protected Attributes inherited from DtSimEntityNetInterface
DtDeadReckonTypes	myDeadReckoningAlgorithm
Protected Attributes inherited from DtSimObjectNetInterface
DtVrfObject *	mySimObject
DtStateRepository *	myNetworkState
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory
static DtNonVrfUUIDResolver *	theNonVrfUUIDResolver

Detailed Description

Derived from DtSimEntityNetInterface, DtSimRemoteEntityNetInterface provides an interface between the local representation of a remote entity and it's network (VR-Link) representation.

This is an abstract class whose deriving classes will represent different types of entities, such as individual, aggregate, and eventually, environmental

Constructor & Destructor Documentation

DtSimRemoteEntityNetInterface::DtSimRemoteEntityNetInterface ( )

protected

default constructor

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

read/writable constructor

DtSimRemoteEntityNetInterface::DtSimRemoteEntityNetInterface	(	const DtSimRemoteEntityNetInterface &	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 DtSimRemoteEntityNetInterface::~DtSimRemoteEntityNetInterface ( )

virtual

destructor; calls destroyPublisher()

Member Function Documentation

const DtSimRemoteEntityNetInterface& DtSimRemoteEntityNetInterface::operator= ( const DtSimRemoteEntityNetInterface & orig )

assignment operator; see note on copy constructor above

virtual bool DtSimRemoteEntityNetInterface::init ( )

virtual

override of base class init().

Registers for post update callbacks on reflected object.

Reimplemented from DtSimObjectNetInterface.

Reimplemented in DtVrfAggregateRemoteEntityNetInterface, and DtVrfIndividualRemoteEntityNetInterface.

virtual void DtSimRemoteEntityNetInterface::onTick ( )

virtual

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

Implements DtSimObjectNetInterface.

Reimplemented in DtVrfAggregateRemoteEntityNetInterface, and DtVrfIndividualRemoteEntityNetInterface.

virtual void DtSimRemoteEntityNetInterface::updateFromReflectedObject ( )

pure virtual

this will copy from whatever type of reflected object and associated network state repository the deriving class uses to the local state repository

Implemented in DtRemoteExtendedPropertiesNetInterface< DtVrfIndividualRemoteEntityNetInterface, DtExtEntityStateRepository >, DtRemoteExtendedPropertiesNetInterface< DtVrfAggregateRemoteEntityNetInterface, DtExtAggregateStateRepository >, DtVrfIndividualRemoteEntityNetInterface, DtSimAggregateRemoteEntityNetInterface, and DtSimIndividualRemoteEntityNetInterface.

virtual void DtSimRemoteEntityNetInterface::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 DtSimRemoteEntityNetInterface::setReflectedObject ( DtReflectedObject * reflectedObject )

virtual

For local entities, a publisher can be created or supplied via a set<>Publisher call.

For remote entities a reflected object is used instead, and must always be supplied (there is no create equivalent to the local entity network interface). This function also sets the network state repository pointer (myBaseNetworkState) to the repository created by this reflected object

virtual const DtReflectedObject* DtSimRemoteEntityNetInterface::reflectedObject ( ) const

virtual

Returns: The pointer to the VR-Link reflected object being used to represent this remote entity

virtual DtReflectedObject* DtSimRemoteEntityNetInterface::reflectedObject ( )

virtual

virtual bool DtSimRemoteEntityNetInterface::isLocal ( ) const

inlinevirtual

This network interface is for local entities.

Implements DtSimObjectNetInterface.

virtual bool DtSimRemoteEntityNetInterface::isAggregate ( ) const

pure virtual

Implemented in DtSimAggregateRemoteEntityNetInterface, and DtSimIndividualRemoteEntityNetInterface.

virtual void DtSimRemoteEntityNetInterface::setUpdateReceived ( bool updateReceived )

virtual

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

virtual bool DtSimRemoteEntityNetInterface::updateReceived ( ) const

virtual

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

static const DtSimRemoteEntityNetInterface* DtSimRemoteEntityNetInterface::isRemoteEntityNetInterface ( const DtSimObjectNetInterface * objNetInterface )

static

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

static DtSimRemoteEntityNetInterface* DtSimRemoteEntityNetInterface::isRemoteEntityNetInterface ( DtSimObjectNetInterface * objNetInterface )

static

static void DtSimRemoteEntityNetInterface::reflectedObjectUpdateCallbackFunction	(	DtReflectedObject *	obj,
		void *	userData
	)

static

virtual void DtSimRemoteEntityNetInterface::updateUUIDIfNeeded ( )

virtual

Upon setting of reflected object see if UUID needs to be updated.

Reimplemented in DtSimIndividualRemoteEntityNetInterface, and DtSimAggregateRemoteEntityNetInterface.

virtual RTI::ObjectClassHandle DtSimRemoteEntityNetInterface::objectClassHandle ( ) const

virtual

Returns the HLA object class handle of the reflected object.

Implements DtSimObjectNetInterface.

Member Data Documentation

DtReflectedObject* DtSimRemoteEntityNetInterface::myReflectedObject

protected

Pointer to the VR-Link Reflected Object (may be a DtReflectedEntity, DtReflectedExtAggregate, etc.

).

bool DtSimRemoteEntityNetInterface::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.vrf4-6-branch/include/vrfobjcore/simRemoteEntityNetInterface.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation