DtSimObjectNetInterface Class Reference

Class Description: DtSimObjectNetInterface. More...

Inheritance diagram for DtSimObjectNetInterface:

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
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 iriginal 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 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 &)
	Restires 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 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
	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
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.

Static Protected Attributes
static DtSimObjectNetInterfaceFactory *	theFactory
static DtNonVrfUUIDResolver *	theNonVrfUUIDResolver
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

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 )()

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 ( void  )

inlinevirtual

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

Reimplemented in DtVrfRemoteEnvironmentalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, DtSimRemoteEntityNetInterface, and DtSimEnvironmentalNetInterface.

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, DtVrfAggregateRemoteEntityNetInterface, DtSimLocalEnvironmentalNetInterface, 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, DtVrfIndividualRemoteEntityNetInterface, DtSimLocalEntityNetInterface, DtRemoteTacticalSmokeNetInterface, DtSimRemoteEnvironmentalNetInterface, 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 DtGlobalEnvironmentLocalNetInterface, DtSimAggregateLocalEntityNetInterface, DtSimIndividualLocalEntityNetInterface, DtSimAggregateRemoteEntityNetInterface, DtSimRemoteEnvironmentalNetInterface, DtSimPseudoAggregateLocalEntityNetInterface, DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, DtSimLocalEnvironmentalNetInterface, DtSimIndividualRemoteEntityNetInterface, DtVrfRemoteEnvironmentalNetInterface, DtVrfAggregateRemoteEntityNetInterface, DtRemoteTacticalSmokeNetInterface, DtVrfIndividualRemoteEntityNetInterface, DtWeatherLocalNetInterface, DtLocalEngineeringObjectNetInterface, DtSimPseudoAggregateWithPropertiesLocalEntityNetInterface, DtVrfAggregateWithPropertiesRemoteEntityNetInterface, DtRemoteEngineeringObjectNetInterface, DtGlobalEnvironmentRemoteNetInterface, DtWeatherRemoteNetInterface, 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::setNonVrfObjectsUUIDScheme ( const DtString &  )

static

Sets the UUID scheme for non vrf objects.

The default is entity-identifier. Options are: entity-identifier global-identifier marking-text

static DtString DtSimObjectNetInterface::nonVrfObjectsUUIDScheme ( )

static

static void DtSimObjectNetInterface::setNonVrfUUIDResolver ( DtNonVrfUUIDResolver *  )

static

Sets the resolver that is to be used when resolving non-VR-Forces uuids.

If one exists, and is owned by VRF, it will be deleted. The current scheme will not be applied to the newly set resolver

static DtNonVrfUUIDResolver* DtSimObjectNetInterface::nonVrfUUIDResolver ( )

static

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

staticprotected

DtNonVrfUUIDResolver* DtSimObjectNetInterface::theNonVrfUUIDResolver

staticprotected

---

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

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