MyIndividualLocalEntityNetInterface Class Reference

Inheritance diagram for MyIndividualLocalEntityNetInterface:

Public Member Functions
	MyIndividualLocalEntityNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
virtual	~MyIndividualLocalEntityNetInterface ()
virtual void	updatePublisher ()
	Override of base class updatePublisher().
virtual DtString	type () const
	Returns the type of net interface object.
Public Member Functions inherited from DtSimIndividualLocalEntityNetInterface
	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 bool	createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	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
Public Member Functions inherited from DtSimLocalEntityNetInterface
	DtSimLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable constructor
	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 (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	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 bool	init ()
	Derived classes that need to perform virtual construction my override this function as desired.
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 void	addAlias (const DtString &alias)
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 *simObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)
Static Public Member Functions inherited from DtSimIndividualLocalEntityNetInterface
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 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	setNonVrfUUIDResolver (DtNonVrfUUIDResolver *)
	Sets the resolver that is to be used when resolving non-VR-Forces uuids.
static DtNonVrfUUIDResolver *	nonVrfUUIDResolver ()
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 void	setNonVrfObjectsUUIDScheme (const DtString &)
	Sets the UUID scheme for non vrf objects.
static DtString	nonVrfObjectsUUIDScheme ()
	Sets the UUID scheme for non vrf objects.
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
	MyIndividualLocalEntityNetInterface ()
	MyIndividualLocalEntityNetInterface (const MyIndividualLocalEntityNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
const MyIndividualLocalEntityNetInterface &	operator= (const MyIndividualLocalEntityNetInterface &orig)
Protected Member Functions inherited from DtSimIndividualLocalEntityNetInterface
	DtSimIndividualLocalEntityNetInterface ()
	default constructor
virtual bool	updateVrfDataAsSeenByRemote ()
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 ()
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.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

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 )()
Protected Attributes inherited from DtSimIndividualLocalEntityNetInterface
DtVrfEntityPublisher *	myEntityPublisher
DtTime	myTimeLastCharacterTypeSent
DtTime	myTimeLastAnimationSent
bool	myFirstTick
bool	myPublishDIGuy
Static Protected Attributes inherited from DtSimIndividualLocalEntityNetInterface
static DtTime	theDiGuyCustomPduThreshold

Constructor & Destructor Documentation

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

virtual MyIndividualLocalEntityNetInterface::~MyIndividualLocalEntityNetInterface ( )

virtual

MyIndividualLocalEntityNetInterface::MyIndividualLocalEntityNetInterface ( )

protected

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

protected

Member Function Documentation

virtual void MyIndividualLocalEntityNetInterface::updatePublisher ( )

virtual

Override of base class updatePublisher().

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

Reimplemented from DtSimIndividualLocalEntityNetInterface.

virtual DtString MyIndividualLocalEntityNetInterface::type ( ) const

virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimIndividualLocalEntityNetInterface.

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

static

Reimplemented from DtSimIndividualLocalEntityNetInterface.

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

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/examples/addAttr/addAttrSim/myIndLclNetIf.h