DtSimLocalEnvironmentalNetInterface Class Reference

Class Description: DtSimLocalEnvironmentalNetInterface. More...

Inheritance diagram for DtSimLocalEnvironmentalNetInterface:

Public Member Functions
	DtSimLocalEnvironmentalNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimLocalEnvironmentalNetInterface (const DtSimLocalEnvironmentalNetInterface &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 DtSimLocalEnvironmentalNetInterface &	operator= (const DtSimLocalEnvironmentalNetInterface &orig)
	assignment operator; see note on copy constructor above.
virtual	~DtSimLocalEnvironmentalNetInterface ()
	destructor; calls destroyPublisher()
virtual bool	init ()
	Override of base class init(), calls createPublisher().
virtual DtString	type () const =0
	Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")
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.
virtual void	onTick ()
	Override of base class onTick() Checks if VR-Forces-specific data has changed.
virtual bool	publisherUserSupplied () const
	A true return indicates that the publisher currently used by the interface was supplied by the user rather than created by init().
virtual void	updatePublisher ()=0
	This will copy from the local state repository to the specific type of publisher created in deriving classes.
virtual bool	createPublisher ()
	Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type.
virtual void	destroyPublisher ()
	Called by the destructor (and also by setPublisher() in some cases, deletes a publisher.
virtual bool	setEntityPublisher (DtEnvironmentProcessPublisher *publisher)
	If the user needs to supply a publisher other than the one created by the network interface, this call call be used.
virtual DtEnvironmentProcessPublisher *	environmentalPublisher () const
virtual void	setupNetworkRepository ()
	Initializes parts of the network repository created by the publisher This needs to be done after the local state repository has been intialized.
DtVrfObject *	vrfObject () const
virtual bool	isLocal () const
	This network interface is for local entities.
virtual bool	isEnvironmental () const
virtual void	processVerticesChanged (DtVrfObject *)
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.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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 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 DtSimLocalEnvironmentalNetInterface *	isLocalEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimLocalEntityNetInterface*, provided the objNetInterface is indeed an local entity network interface.
static void	verticesChanged (DtVrfObject *, void *usr)
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.

Protected Member Functions
	DtSimLocalEnvironmentalNetInterface ()
	default constructor
virtual DtEnvironmentProcessPublisher *	_createPublisher () const
	Override this functions to use a subclass of DtEnvironmentProcessPublisher.
virtual DtEnvironmentProcessRepository *	_createSR () const
	Override this functions to use a subclass of DtEnvironmentProcessStateRepository.
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
bool	myPublisherUserSupplied
DtEnvironmentProcessPublisher *	myEnvironmentalPublisher
bool	myPublishObject
DtSimManager *	mySimManager
	Obtained from our DtVrfObject, and cached for use in sendVrfObject().
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
bool	myVerticesChanged

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
Static Protected Attributes inherited from DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory

Detailed Description

Class Description: DtSimLocalEnvironmentalNetInterface.

Derived from DtSimEnvironmentalNetInterface, DtSimLocalEnvironmentalNetInterface provides an interface between a local environmental object and it's network (VR-Link) representation.

Constructor & Destructor Documentation

DtSimLocalEnvironmentalNetInterface::DtSimLocalEnvironmentalNetInterface ( )

protected

default constructor

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

read/writable contructor

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

virtual

destructor; calls destroyPublisher()

Member Function Documentation

const DtSimLocalEnvironmentalNetInterface& DtSimLocalEnvironmentalNetInterface::operator=

(

const DtSimLocalEnvironmentalNetInterface &

orig

)

assignment operator; see note on copy constructor above.

virtual bool DtSimLocalEnvironmentalNetInterface::init ( )

virtual

Override of base class init(), calls createPublisher().

Reimplemented from DtSimEnvironmentalNetInterface.

Reimplemented in DtGlobalEnvironmentLocalNetInterface.

virtual DtString DtSimLocalEnvironmentalNetInterface::type ( ) const

pure virtual

Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")

Implements DtSimObjectNetInterface.

Implemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.

virtual void DtSimLocalEnvironmentalNetInterface::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 DtSimLocalEnvironmentalNetInterface::setMinTickPeriod ( double  minTickPeriod )

virtual

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

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

virtual double DtSimLocalEnvironmentalNetInterface::minTickPeriod ( ) const

virtual

access the minimum tick period

virtual void DtSimLocalEnvironmentalNetInterface::setMinTickPeriodVariance ( double  minTickPeriodVariance )

virtual

set the variance in the minimum tick time

virtual double DtSimLocalEnvironmentalNetInterface::minTickPeriodVariance ( ) const

virtual

access the variance in the minimum tick period

virtual void DtSimLocalEnvironmentalNetInterface::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 DtSimLocalEnvironmentalNetInterface::nextTickTime ( ) const

virtual

access the next tick time

virtual double DtSimLocalEnvironmentalNetInterface::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.

virtual void DtSimLocalEnvironmentalNetInterface::onTick ( )

virtual

Override of base class onTick() Checks if VR-Forces-specific data has changed.

If it has, sets the object changed flag. Calls updatePublisher().

Implements DtSimObjectNetInterface.

virtual bool DtSimLocalEnvironmentalNetInterface::publisherUserSupplied ( ) const

virtual

A true return indicates that the publisher currently used by the interface was supplied by the user rather than created by init().

virtual void DtSimLocalEnvironmentalNetInterface::updatePublisher ( )

pure virtual

This will copy from the local state repository to the specific type of publisher created in deriving classes.

Implemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.

virtual bool DtSimLocalEnvironmentalNetInterface::createPublisher ( )

virtual

Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type.

virtual void DtSimLocalEnvironmentalNetInterface::destroyPublisher ( )

virtual

Called by the destructor (and also by setPublisher() in some cases, deletes a publisher.

virtual bool DtSimLocalEnvironmentalNetInterface::setEntityPublisher ( DtEnvironmentProcessPublisher *  publisher )

virtual

If the user needs to supply a publisher other than the one created by the network interface, this call call be used.

If the myPublisher pointer is not null and it myPublisherUserSupplied flag is false then the interface will first destroy the current publisher; otherwise a warning is generated and false is returned. The interface's destructor will not destroy a user supplied publisher - that is the responsibility of the publisher's creator. If you need to change a user-supplied publisher to a different one, first call setPublisher with a value of 0 (Null). This will set the myPublisherUserSupplied flag to false.

virtual DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::environmentalPublisher ( ) const

virtual

virtual void DtSimLocalEnvironmentalNetInterface::setupNetworkRepository ( )

virtual

Initializes parts of the network repository created by the publisher This needs to be done after the local state repository has been intialized.

Details depend upon which type of publisher (and therefore network state repository) is actually created.

DtVrfObject* DtSimLocalEnvironmentalNetInterface::vrfObject

(

)

const

virtual bool DtSimLocalEnvironmentalNetInterface::isLocal ( ) const

inlinevirtual

This network interface is for local entities.

Implements DtSimObjectNetInterface.

virtual bool DtSimLocalEnvironmentalNetInterface::isEnvironmental ( ) const

inlinevirtual

Reimplemented from DtSimEnvironmentalNetInterface.

static DtSimLocalEnvironmentalNetInterface* DtSimLocalEnvironmentalNetInterface::isLocalEnvironmentalNetInterface ( const DtSimObjectNetInterface *  objNetInterface )

static

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

static void DtSimLocalEnvironmentalNetInterface::verticesChanged ( DtVrfObject *  , void *  usr  )

static

virtual void DtSimLocalEnvironmentalNetInterface::processVerticesChanged ( DtVrfObject *  )

virtual

virtual DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::_createPublisher ( ) const

protectedvirtual

Override this functions to use a subclass of DtEnvironmentProcessPublisher.

Reimplemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.

virtual DtEnvironmentProcessRepository* DtSimLocalEnvironmentalNetInterface::_createSR ( ) const

protectedvirtual

Override this functions to use a subclass of DtEnvironmentProcessStateRepository.

Reimplemented in DtSimLocalControlObjectNetInterface.

Member Data Documentation

bool DtSimLocalEnvironmentalNetInterface::myPublisherUserSupplied

protected

DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::myEnvironmentalPublisher

protected

bool DtSimLocalEnvironmentalNetInterface::myPublishObject

protected

DtSimManager* DtSimLocalEnvironmentalNetInterface::mySimManager

protected

Obtained from our DtVrfObject, and cached for use in sendVrfObject().

double DtSimLocalEnvironmentalNetInterface::myMinTickPeriod

protected

double DtSimLocalEnvironmentalNetInterface::myMinTickPeriodVariance

protected

double DtSimLocalEnvironmentalNetInterface::myNextTickTime

protected

bool DtSimLocalEnvironmentalNetInterface::myVerticesChanged

protected

---

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

• include/vrfobjcore/lclEnvNetIf.h