Class Description: DtVrfIndividualRemoteEntityNetInterfacee. More...

Inheritance diagram for DtVrfIndividualRemoteEntityNetInterface:

Public Member Functions
	DtVrfIndividualRemoteEntityNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable contructor
	DtVrfIndividualRemoteEntityNetInterface (const DtVrfIndividualRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtVrfIndividualRemoteEntityNetInterface &	operator= (const DtVrfIndividualRemoteEntityNetInterface &orig)
	assignment operator
virtual	~DtVrfIndividualRemoteEntityNetInterface ()
	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	updateFromReflectedObject ()
	Override to update DI-Guy Information.
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 DtSimIndividualRemoteEntityNetInterface
	DtSimIndividualRemoteEntityNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtSimIndividualRemoteEntityNetInterface (const DtSimIndividualRemoteEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimIndividualRemoteEntityNetInterface &	operator= (const DtSimIndividualRemoteEntityNetInterface &orig)
	assignment operator
virtual	~DtSimIndividualRemoteEntityNetInterface ()
	destructor
virtual DtReflectedEntity *	reflectedEntity () const
	returns the pointer to the VR-Link reflected entity being used to represent this remote entity
virtual DtExtEntityStateRepository *	individualNetworkState () const
	returns a pointer to the DtExtEntityStateRepository created by the DtReflectedEntity
virtual bool	isPhysicalDataInitialized () const
	Returns true if physical data for entity has been initialized.
virtual bool	isAggregate () const
virtual DtArticulatedPartStateRepository *	createPart (DtArticulatedPart *artPart)
Public Member Functions inherited from DtSimRemoteEntityNetInterface
	DtSimRemoteEntityNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtSimRemoteEntityNetInterface (const DtSimRemoteEntityNetInterface &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 DtSimRemoteEntityNetInterface &	operator= (const DtSimRemoteEntityNetInterface &orig)
	assignment operator; see note on copy constructor above
virtual	~DtSimRemoteEntityNetInterface ()
	destructor; calls destroyPublisher()
virtual void	setupFromNetworkRepository ()
	initializes parts of the local repository from the network state rep.
virtual void	setReflectedObject (DtReflectedObject *reflectedObject)
	For local entities, a publisher can be created or supplied via a set<>Publisher call.
virtual const DtReflectedObject *	reflectedObject () const
virtual DtReflectedObject *	reflectedObject ()
virtual bool	isLocal () const
	This network interface is for local entities.
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 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
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 DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry, bool publishObject)
Static Public Member Functions inherited from DtSimIndividualRemoteEntityNetInterface
static const DtSimIndividualRemoteEntityNetInterface *	isIndividualRemoteEntityNetInterface (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 DtSimIndividualRemoteEntityNetInterface *	isIndividualRemoteEntityNetInterface (DtSimObjectNetInterface *objNetInterface)
Static Public Member Functions inherited from DtSimRemoteEntityNetInterface
static const DtSimRemoteEntityNetInterface *	isRemoteEntityNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimRemoteEntityNetInterface*, provided the objNetInterface is indeed an remote entity network interface.
static DtSimRemoteEntityNetInterface *	isRemoteEntityNetInterface (DtSimObjectNetInterface *objNetInterface)
static void	reflectedObjectUpdateCallbackFunction (DtReflectedObject obj, void userData)
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.

Protected Member Functions
	DtVrfIndividualRemoteEntityNetInterface ()
	default constructor; not implemented
Protected Member Functions inherited from DtSimIndividualRemoteEntityNetInterface
	DtSimIndividualRemoteEntityNetInterface ()
	default constructor; not implemented
virtual DtArticulatedPartStateRepository *	createArtPartStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString())
	Returns new instance of a DtArticulatedPartStateRepository.
Protected Member Functions inherited from DtSimRemoteEntityNetInterface
	DtSimRemoteEntityNetInterface ()
	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
DtInterfaceMessageExecutive *	myMessageExec
DtSimManager *	mySimManager
	Obtained from our DtVrfObject.
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
Protected Attributes inherited from DtSimIndividualRemoteEntityNetInterface
bool	myIsPhysicalDataInitialized
Protected Attributes inherited from DtSimRemoteEntityNetInterface
DtReflectedObject *	myReflectedObject
	Pointer to the VR-Link Reflected Object (may be a DtReflectedEntity, DtReflectedExtAggregate, etc.
bool	myUpdateReceived
	Set to true by post-update callback; set to false after update has been processed.
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.

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: DtVrfIndividualRemoteEntityNetInterfacee.

Derived from DtSimIndividualRemoteEntityNetInterface, DtVrfIndividualRemoteEntityNetInterface overrides the tick() function so that it can wait for a valid reflected entity to arrive after creation time, since remote vrf objects are created based on receipt of object created messages, not reflected emtity discoveries.

Examples

Remote Net Interface

Constructor & Destructor Documentation

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

read/writable contructor

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

copy constructor

virtual DtVrfIndividualRemoteEntityNetInterface::~DtVrfIndividualRemoteEntityNetInterface ( )

virtual

destructor

DtVrfIndividualRemoteEntityNetInterface::DtVrfIndividualRemoteEntityNetInterface ( )

protected

default constructor; not implemented

Member Function Documentation

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

assignment operator

virtual DtString DtVrfIndividualRemoteEntityNetInterface::type ( ) const

virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

virtual bool DtVrfIndividualRemoteEntityNetInterface::init ( )

virtual

override of base class init().

Reimplemented from DtSimRemoteEntityNetInterface.

virtual void DtVrfIndividualRemoteEntityNetInterface::onTick ( )

virtual

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

Reimplemented from DtSimRemoteEntityNetInterface.

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

virtual

Override to update DI-Guy Information.

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

virtual void DtVrfIndividualRemoteEntityNetInterface::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 DtVrfIndividualRemoteEntityNetInterface::minTickPeriod ( ) const

virtual

access the minimum tick period

virtual void DtVrfIndividualRemoteEntityNetInterface::setMinTickPeriodVariance ( double minTickPeriodVariance )

virtual

set the variance in the minimum tick time

virtual double DtVrfIndividualRemoteEntityNetInterface::minTickPeriodVariance ( ) const

virtual

access the variance in the minimum tick period

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

virtual

access the next tick time

virtual double DtVrfIndividualRemoteEntityNetInterface::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* DtVrfIndividualRemoteEntityNetInterface::vrfObject ( ) const

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

static

Reimplemented from DtSimIndividualRemoteEntityNetInterface.

Reimplemented in MyIndividualRemoteEntityNetInterface.

Member Data Documentation

DtInterfaceMessageExecutive* DtVrfIndividualRemoteEntityNetInterface::myMessageExec

protected

DtSimManager* DtVrfIndividualRemoteEntityNetInterface::mySimManager

protected

Obtained from our DtVrfObject.

double DtVrfIndividualRemoteEntityNetInterface::myMinTickPeriod

protected

double DtVrfIndividualRemoteEntityNetInterface::myMinTickPeriodVariance

protected

double DtVrfIndividualRemoteEntityNetInterface::myNextTickTime

protected

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

include/vrfobjcore/vrfIndRemNetIf.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