DtSimIndividualLocalEntityNetInterface Class Reference

Class Description: DtSimIndividualLocalEntityNetInterface. More...

Inheritance diagram for DtSimIndividualLocalEntityNetInterface:

Public Member Functions
	DtSimIndividualLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtSimIndividualLocalEntityNetInterface (const DtSimIndividualLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimIndividualLocalEntityNetInterface &	operator= (const DtSimIndividualLocalEntityNetInterface &orig)
	assignment operator
virtual	~DtSimIndividualLocalEntityNetInterface ()
	destructor
virtual void	updateNet ()
	Ticks the publisher, then calls base class version.
virtual void	updatePublisher ()
	Override of base class updatePublisher().
virtual bool	createPublisher ()
	Override of base class createPublisher().
void	destroyPublisher ()
	Deletes a DtVrfEntityPublisher.
virtual bool	setEntityPublisher (DtVrfEntityPublisher *publisher)
	If the user needs to supply a publisher other than the one created by the network interface, this call call be used.
virtual void	setupNetworkRepository ()
	Override of base class setupNetworkRepository().
virtual DtVrfEntityPublisher *	entityPublisher () const
	Returns a pointer to the DtVrfEntityPublisher created.
virtual DtExtEntityStateRepository *	individualNetworkState () const
	Returns a pointer to the DtExtEntityStateRepository created by the DtVrfEntityPublisher.
virtual DtVrfObjectStateRepository *	individualLocalState () const
	Returns a pointer to the local state repository from which the network state is updated.
virtual bool	isAggregate () const
virtual DtString	type () const
	Returns the type of net interface object.
Public Member Functions inherited from DtSimLocalEntityNetInterface
	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().
DtVrfObject *	vrfObject () const
virtual bool	isLocal () const
	This network interface is for local entities.
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 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 DtSimIndividualLocalEntityNetInterface *	isIndividualLocalEntityNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimIndividualLocalEntityNetInterface*, provided the objNetInterface is indeed an individual local entity network interface.
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Static Public Member Functions inherited from DtSimLocalEntityNetInterface
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
	DtSimIndividualLocalEntityNetInterface ()
	default constructor
virtual bool	updateVrfDataAsSeenByRemote ()
virtual DtVector	calculateWorldVelocityFromPosition (const DtVector &currentWorldPos, const DtVector &currentLocalPos, const DtVector &localVelocityworldVelocity)
	If the database is in a projected system, error is introduced in the velocity when converting it to geocentric.
virtual void	updateArtPartsNetState ()
	Updates VR-Link art parts list with values from the entity's VR-Forces state repository (specifically, the tree of DtArticulatedPartStateRepositories contained within its state repository).
virtual void	updateDIGuyState ()
virtual void	updateCharacterType (const DtString &appear)
virtual void	updateCharacterAppearance (const DtString &appear)
virtual void	updateCharacterAnimation (const DtString &animation, bool paused)
Protected Member Functions inherited from DtSimLocalEntityNetInterface
	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
DtVrfEntityPublisher *	myEntityPublisher
DtTime	myTimeLastCharacterTypeSent
DtTime	myTimeLastAnimationSent
bool	myFirstTick
bool	myPublishDIGuy
Protected Attributes inherited from DtSimLocalEntityNetInterface
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 DtTime	theDiGuyCustomPduThreshold
Static Protected Attributes inherited from DtSimLocalEntityNetInterface
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

Class Description: DtSimIndividualLocalEntityNetInterface.

Derived from DtSimLocalEntityNetInterface, this class provides an interface between an individual local entity (such as a single truck, tank, soldier, etc.) and its network (VR-Link) representation (A DtVrfEntityPublisher).

Examples

• Local Net Interface

Constructor & Destructor Documentation

DtSimIndividualLocalEntityNetInterface::DtSimIndividualLocalEntityNetInterface ( )

protected

default constructor

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

read/writable contructor

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

copy constructor

virtual DtSimIndividualLocalEntityNetInterface::~DtSimIndividualLocalEntityNetInterface ( )

virtual

destructor

Member Function Documentation

const DtSimIndividualLocalEntityNetInterface& DtSimIndividualLocalEntityNetInterface::operator=

(

const DtSimIndividualLocalEntityNetInterface &

orig

)

assignment operator

virtual void DtSimIndividualLocalEntityNetInterface::updateNet ( )

virtual

Ticks the publisher, then calls base class version.

Reimplemented from DtSimLocalEntityNetInterface.

virtual void DtSimIndividualLocalEntityNetInterface::updatePublisher ( )

virtual

Override of base class updatePublisher().

Fills in the DtVrfEntityPublisher with values from the local entity state repository. Called by tick().

Implements DtSimLocalEntityNetInterface.

Reimplemented in MyIndividualLocalEntityNetInterface.

virtual bool DtSimIndividualLocalEntityNetInterface::createPublisher ( )

virtual

Override of base class createPublisher().

Creates a DtVrfEntityPublisher. Sets the DtVrfEntityIdentifier to the next available identifier from the exerciseConnection. Sets the myNetworkState member to the state repository of the publisher. Sets the vrfObject's global ID to the entity publisher's global ID. Sets the myPublisherUserSupplied member to false.

Implements DtSimLocalEntityNetInterface.

void DtSimIndividualLocalEntityNetInterface::destroyPublisher ( )

virtual

Deletes a DtVrfEntityPublisher.

Implements DtSimLocalEntityNetInterface.

virtual bool DtSimIndividualLocalEntityNetInterface::setEntityPublisher ( DtVrfEntityPublisher *  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 void DtSimIndividualLocalEntityNetInterface::setupNetworkRepository ( )

virtual

Override of base class setupNetworkRepository().

Initializes the DtExtEntityStateRepository created by the DtVrfEntityPublisher (which this class creates).

Implements DtSimLocalEntityNetInterface.

virtual DtVrfEntityPublisher* DtSimIndividualLocalEntityNetInterface::entityPublisher ( ) const

virtual

Returns a pointer to the DtVrfEntityPublisher created.

virtual DtExtEntityStateRepository* DtSimIndividualLocalEntityNetInterface::individualNetworkState ( ) const

virtual

Returns a pointer to the DtExtEntityStateRepository created by the DtVrfEntityPublisher.

virtual DtVrfObjectStateRepository* DtSimIndividualLocalEntityNetInterface::individualLocalState ( ) const

virtual

Returns a pointer to the local state repository from which the network state is updated.

This method checks to make sure the local state repository is indeed a DtSimIndividualLocalStateRepository, and returns 0 if it isn't.

virtual bool DtSimIndividualLocalEntityNetInterface::isAggregate ( ) const

inlinevirtual

Implements DtSimLocalEntityNetInterface.

virtual DtString DtSimIndividualLocalEntityNetInterface::type ( ) const

virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Implements DtSimObjectNetInterface.

Reimplemented in MyIndividualLocalEntityNetInterface.

static DtSimIndividualLocalEntityNetInterface* DtSimIndividualLocalEntityNetInterface::isIndividualLocalEntityNetInterface ( const DtSimObjectNetInterface *  objNetInterface )

static

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

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

static

Reimplemented in MyIndividualLocalEntityNetInterface.

virtual bool DtSimIndividualLocalEntityNetInterface::updateVrfDataAsSeenByRemote ( )

protectedvirtual

virtual DtVector DtSimIndividualLocalEntityNetInterface::calculateWorldVelocityFromPosition ( const DtVector &  currentWorldPos, const DtVector &  currentLocalPos, const DtVector &  localVelocityworldVelocity  )

protectedvirtual

If the database is in a projected system, error is introduced in the velocity when converting it to geocentric.

To avoid this problem, use the current geocentric position and then using local velocity create a projected point 1 sec in the future. Convert it to geocentric and subract the 2 to get the geocentric velocity.

virtual void DtSimIndividualLocalEntityNetInterface::updateArtPartsNetState ( )

protectedvirtual

Updates VR-Link art parts list with values from the entity's VR-Forces state repository (specifically, the tree of DtArticulatedPartStateRepositories contained within its state repository).

Called by updatePublisher().

virtual void DtSimIndividualLocalEntityNetInterface::updateDIGuyState ( )

protectedvirtual

virtual void DtSimIndividualLocalEntityNetInterface::updateCharacterType ( const DtString &  appear )

protectedvirtual

virtual void DtSimIndividualLocalEntityNetInterface::updateCharacterAppearance ( const DtString &  appear )

protectedvirtual

virtual void DtSimIndividualLocalEntityNetInterface::updateCharacterAnimation ( const DtString &  animation, bool  paused  )

protectedvirtual

Member Data Documentation

DtVrfEntityPublisher* DtSimIndividualLocalEntityNetInterface::myEntityPublisher

protected

DtTime DtSimIndividualLocalEntityNetInterface::myTimeLastCharacterTypeSent

protected

DtTime DtSimIndividualLocalEntityNetInterface::myTimeLastAnimationSent

protected

DtTime DtSimIndividualLocalEntityNetInterface::theDiGuyCustomPduThreshold

staticprotected

bool DtSimIndividualLocalEntityNetInterface::myFirstTick

protected

bool DtSimIndividualLocalEntityNetInterface::myPublishDIGuy

protected

---

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

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