Class Description: DtVrfRemoteEnvironmentalNetInterface. More...

Inheritance diagram for DtVrfRemoteEnvironmentalNetInterface:

Public Member Functions
	DtVrfRemoteEnvironmentalNetInterface (const DtString &name, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtVrfRemoteEnvironmentalNetInterface (const DtVrfRemoteEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtVrfRemoteEnvironmentalNetInterface &	operator= (const DtVrfRemoteEnvironmentalNetInterface &orig)
	assignment operator
virtual	~DtVrfRemoteEnvironmentalNetInterface ()
	destructor
virtual DtString	type () const
	Returns the type of net interface object.
virtual bool	init ()
	override of base class init().
virtual void	onTick ()
	onTick is being overriden so the net interface isn't ticked before the reflected object has been setup.
virtual void	tick ()
	Override base class tick.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
DtVrfObject *	vrfObject () const
Public Member Functions inherited from DtSimRemoteEnvironmentalNetInterface
	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 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 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 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)
	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 (FILE *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 (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 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 (FILE *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)
	Deriving class overrides these to get/put class specific data.
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.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
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 DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry, bool publishObject)
Static Public Member Functions inherited from DtSimRemoteEnvironmentalNetInterface
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 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 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 &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	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
	DtVrfRemoteEnvironmentalNetInterface ()
	default constructor
Protected Member Functions inherited from DtSimRemoteEnvironmentalNetInterface
	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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtInterfaceMessageExecutive *	myMessageExec
DtSimManager *	mySimManager
	Obtained from our DtVrfObject.
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
Protected Attributes inherited from DtSimRemoteEnvironmentalNetInterface
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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory

Detailed Description

Class Description: DtVrfRemoteEnvironmentalNetInterface.

Derived from DtSimRemoteEnvironmentalNetInterface, DtVrfRemoteEnvironmentalNetInterface overrides updateGeometry() to flag the object geometry that conversion to local coords needs to be redone.

Constructor & Destructor Documentation

DtVrfRemoteEnvironmentalNetInterface::DtVrfRemoteEnvironmentalNetInterface ( )

protected

default constructor

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

read/writable contructor

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

copy constructor

virtual DtVrfRemoteEnvironmentalNetInterface::~DtVrfRemoteEnvironmentalNetInterface ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual DtString DtVrfRemoteEnvironmentalNetInterface::type ( ) const

virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteTacticalSmokeNetInterface, DtRemoteEngineeringObjectNetInterface, DtGlobalEnvironmentRemoteNetInterface, and DtWeatherRemoteNetInterface.

virtual bool DtVrfRemoteEnvironmentalNetInterface::init ( )

virtual

override of base class init().

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::onTick ( )

virtual

onTick is being overriden so the net interface isn't ticked before the reflected object has been setup.

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteTacticalSmokeNetInterface, and DtGlobalEnvironmentRemoteNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::tick ( )

virtual

Override base class tick.

This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()-> approximateElapsedRealTime()). If it has, it will then call the base class tick (which in turn calls onTick()), and recalculate the next tick time

Reimplemented from DtSimObjectNetInterface.

virtual void DtVrfRemoteEnvironmentalNetInterface::setMinTickPeriod ( double minTickPeriod )

virtual

specifies a minimum tick period (which can also be thought of as

/ maximum tick rate). This is specified in seconds.

virtual double DtVrfRemoteEnvironmentalNetInterface::minTickPeriod ( ) const

virtual

access the minimum tick period

virtual void DtVrfRemoteEnvironmentalNetInterface::setMinTickPeriodVariance ( double minTickPeriodVariance )

virtual

set the variance in the minimum tick time

virtual double DtVrfRemoteEnvironmentalNetInterface::minTickPeriodVariance ( ) const

virtual

access the variance in the minimum tick period

virtual void DtVrfRemoteEnvironmentalNetInterface::setNextTickTime ( double nextTickTime )

virtual

The next tick time is normally calculated internally.

setNextTickTime can be used to force a tick (set nextTickTime to exerciseClock()-> approximateElapsedRealTime())

virtual double DtVrfRemoteEnvironmentalNetInterface::nextTickTime ( ) const

virtual

access the next tick time

virtual double DtVrfRemoteEnvironmentalNetInterface::calculateNextTickTime ( ) const

virtual

The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.

and +myMinTickPeriodVariance/2. If the exercise clock is paused, the variance is always set to zero to insure that the extra calls to DtFRand() don't prevent repeatability.

DtVrfObject* DtVrfRemoteEnvironmentalNetInterface::vrfObject ( ) const

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

static

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

Reimplemented in DtRemoteExtendedPropertiesNetInterface< DtVrfRemoteEnvironmentalNetInterface, DtControlObjectRepository >, DtRemoteTacticalSmokeNetInterface, DtRemoteEngineeringObjectNetInterface, DtGlobalEnvironmentRemoteNetInterface, and DtWeatherRemoteNetInterface.

Member Data Documentation

DtInterfaceMessageExecutive* DtVrfRemoteEnvironmentalNetInterface::myMessageExec

protected

DtSimManager* DtVrfRemoteEnvironmentalNetInterface::mySimManager

protected

Obtained from our DtVrfObject.

double DtVrfRemoteEnvironmentalNetInterface::myMinTickPeriod

protected

double DtVrfRemoteEnvironmentalNetInterface::myMinTickPeriodVariance

protected

double DtVrfRemoteEnvironmentalNetInterface::myNextTickTime

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfRemoteEnvironmentalNetInterface.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