DtSimLocalEntityNetInterface Class Reference

File: lclEntNetIf.h. More...

Inheritance diagram for DtSimLocalEntityNetInterface:

Public Member Functions
	DtSimLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimLocalEntityNetInterface (const DtSimLocalEntityNetInterface &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 DtSimLocalEntityNetInterface &	operator= (const DtSimLocalEntityNetInterface &orig)
	assignment operator; see note on copy constructor above.
virtual	~DtSimLocalEntityNetInterface ()
	destructor; calls destroyPublisher().
virtual bool	init ()
	Override of base class init(), calls createPublisher().
virtual void	onTick ()
	Checks if VR-Forces-specific data has changed.
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 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 ()=0
	Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type.
virtual void	destroyPublisher ()=0
	Called by the destructor (and also by setPublisher() in some cases), deletes a publisher.
virtual void	updateNet ()
	Cause any necessary data to be send to the network.
virtual void	setupNetworkRepository ()=0
	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	isAggregate () const =0
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 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 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)
	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 bool	isVrfGlobalId (const DtGlobalObjectDesignator &identifier)
	Returns true if given global object Id is a VR-Forces encoded global Id and false if it is not.
static DtSimLocalEntityNetInterface *	isLocalEntityNetInterface (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	setVrfDataTimeThreshold (DtTime time)
	Sets the time to update the vrf data message.
static void	setHeartbeatVariance (double variance)
	Variance to use for setting heartbeat thresholds.
static double	heartbeatVariance ()
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	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
	DtSimLocalEntityNetInterface ()
	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.
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
bool	myPublishObject
DtSimManager *	mySimManager
	Obtained from our DtVrfObject, and cached for use in sendVrfObject().
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
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
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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 double	theHeartbeatVariance

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

Detailed Description

File: lclEntNetIf.h.

Class: DtSimLocalEntityNetInterface Class Description: DtSimLocalEntityNetInterface

Derived from DtSimEntityNetInterface, DtSimLocalEntityNetInterface provides an interface between a local entity and its 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

DtSimLocalEntityNetInterface::DtSimLocalEntityNetInterface ( )

protected

default constructor

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

read/writable contructor

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

virtual

destructor; calls destroyPublisher().

Member Function Documentation

const DtSimLocalEntityNetInterface& DtSimLocalEntityNetInterface::operator=

(

const DtSimLocalEntityNetInterface &

orig

)

assignment operator; see note on copy constructor above.

virtual bool DtSimLocalEntityNetInterface::init ( )

virtual

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

Reimplemented from DtSimObjectNetInterface.

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::onTick ( )

virtual

Checks if VR-Forces-specific data has changed.

If it has, sets the object changed flag.

Implements DtSimObjectNetInterface.

virtual void DtSimLocalEntityNetInterface::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.

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::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.

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual double DtSimLocalEntityNetInterface::minTickPeriod ( ) const

virtual

access the minimum tick period

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::setMinTickPeriodVariance ( double  minTickPeriodVariance )

virtual

set the variance in the minimum tick time

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual double DtSimLocalEntityNetInterface::minTickPeriodVariance ( ) const

virtual

access the variance in the minimum tick period

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::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())

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual double DtSimLocalEntityNetInterface::nextTickTime ( ) const

virtual

access the next tick time

Reimplemented in DtSimAggregateLocalEntityNetInterface.

virtual double DtSimLocalEntityNetInterface::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 bool DtSimLocalEntityNetInterface::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 DtSimLocalEntityNetInterface::updatePublisher ( )

pure virtual

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

Implemented in DtSimAggregateLocalEntityNetInterface, DtSimPseudoAggregateLocalEntityNetInterface, DtSimIndividualLocalEntityNetInterface, and MyIndividualLocalEntityNetInterface.

virtual bool DtSimLocalEntityNetInterface::createPublisher ( )

pure virtual

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

Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::destroyPublisher ( )

pure virtual

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

Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::updateNet ( )

virtual

Cause any necessary data to be send to the network.

Called by onTick. Base class implementation causes a VrfData message to be sent if necessary.

Reimplemented in DtSimIndividualLocalEntityNetInterface, and DtSimAggregateLocalEntityNetInterface.

virtual void DtSimLocalEntityNetInterface::setupNetworkRepository ( )

pure 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.

Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.

DtVrfObject* DtSimLocalEntityNetInterface::vrfObject

(

)

const

static bool DtSimLocalEntityNetInterface::isVrfGlobalId ( const DtGlobalObjectDesignator &  identifier )

static

Returns true if given global object Id is a VR-Forces encoded global Id and false if it is not.

Calls down to DtVrfObjectIdGenerator to make the check

virtual bool DtSimLocalEntityNetInterface::isLocal ( ) const

inlinevirtual

This network interface is for local entities.

Implements DtSimObjectNetInterface.

virtual bool DtSimLocalEntityNetInterface::isAggregate ( ) const

pure virtual

Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.

static DtSimLocalEntityNetInterface* DtSimLocalEntityNetInterface::isLocalEntityNetInterface ( 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 DtSimLocalEntityNetInterface::setVrfDataTimeThreshold ( DtTime  time )

static

Sets the time to update the vrf data message.

The message will be sent on this time (default is five seconds) or if the data as seen by remote is different that the current time. If time is set to be -1, it will only be sent if the data is different

static void DtSimLocalEntityNetInterface::setHeartbeatVariance ( double  variance )

static

Variance to use for setting heartbeat thresholds.

The actual threshold used will be heartbeat +/- a random value up to the variance. The default value is 2.5s.

static double DtSimLocalEntityNetInterface::heartbeatVariance ( )

static

Member Data Documentation

bool DtSimLocalEntityNetInterface::myPublisherUserSupplied

protected

bool DtSimLocalEntityNetInterface::myPublishObject

protected

DtSimManager* DtSimLocalEntityNetInterface::mySimManager

protected

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

double DtSimLocalEntityNetInterface::myMinTickPeriod

protected

double DtSimLocalEntityNetInterface::myMinTickPeriodVariance

protected

double DtSimLocalEntityNetInterface::myNextTickTime

protected

double DtSimLocalEntityNetInterface::theHeartbeatVariance

staticprotected

---

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

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