DtLocalEngineeringObjectNetInterface Class Reference

Defines the local net interface for engineering object control objects. More...

Inheritance diagram for DtLocalEngineeringObjectNetInterface:

Public Member Functions
	DtLocalEngineeringObjectNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtLocalEngineeringObjectNetInterface (const DtLocalEngineeringObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtLocalEngineeringObjectNetInterface &	operator= (const DtLocalEngineeringObjectNetInterface &orig)
	assignment operator
virtual	~DtLocalEngineeringObjectNetInterface ()
	destructor
virtual DtEnvironmentProcessPublisher *	_createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
	Create a custom publisher to ensure that publishes the correct FOM class.
virtual DtString	type () const
	Returns the type of net interface object.
Public Member Functions inherited from DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository >
	DtLocalExtendedPropertiesNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtLocalExtendedPropertiesNetInterface (const DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository > &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtLocalExtendedPropertiesNetInterface &	operator= (const DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository > &orig)
	assignment operator
virtual	~DtLocalExtendedPropertiesNetInterface ()
	destructor
virtual bool	initExtendedProperties ()
	Initializer.
virtual void	onTick ()
	Overridden to tick the ExtendedAttributes object publisher.
virtual void	updatePublisher ()
	Calls the base class updatePublisher() and then updates the extended property attributes.
virtual void	updateUuid ()
	Updates the UUID to be published to the network.
Public Member Functions inherited from DtSimLocalControlObjectNetInterface
	DtSimLocalControlObjectNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
	read/writable constructor
	DtSimLocalControlObjectNetInterface (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 DtSimLocalControlObjectNetInterface &	operator= (const DtSimLocalControlObjectNetInterface &orig)
	assignment operator; see note on copy constructor above.
virtual	~DtSimLocalControlObjectNetInterface ()
	destructor; calls destroyPublisher()
virtual DtControlObjectRepository *	controlObjectNetworkState () const
	Get the control object publisher for this object.
Public Member Functions inherited from DtSimLocalEnvironmentalNetInterface
	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 (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	Override of base class init(), calls createPublisher().
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 bool	createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	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 DtObjectPublisher *	publisher ()
	Returns the publisher used by this net interface.
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 initialized.
DtVrfObject *	vrfObject () const
virtual bool	isLocal () const
	This network interface is for local entities.
virtual bool	isEnvironmental () const
virtual RTI::ObjectClassHandle	objectClassHandle () const
	Returns the HLA object class handle of the published object.
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 bool	init ()
	override of base class init(), calls create<...>Record() functions
virtual DtEnvironmentProcessRepository *	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 constructor 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)
	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 (std::string &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 (std::string &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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original 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 bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &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)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
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 ()
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 ()
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 &)
	Restores 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)

Protected Member Functions
	DtLocalEngineeringObjectNetInterface ()
	default constructor
Protected Member Functions inherited from DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository >
	DtLocalExtendedPropertiesNetInterface ()
	default constructor
Protected Member Functions inherited from DtSimLocalControlObjectNetInterface
	DtSimLocalControlObjectNetInterface ()
	default constructor
virtual bool	updateGeometry (DtVrfOverlayObjectStateRepository *localState)
	Builds a DtList of env.
virtual bool	updateBoundingGeometry (DtVrfOverlayObjectStateRepository *localState)
	Fills in bounding sphere, bounding rect records.
virtual bool	updateObjectState (DtVrfOverlayObjectStateRepository *localState)
	Fills in object state record.
virtual bool	updateEnvModelType (DtVrfOverlayObjectStateRepository *localState)
virtual bool	updateVrfDataAsSeenByRemote ()
	Update contents of our environmental state with data from our DtVrfObject.
virtual DtEnvironmentProcessRepository *	_createSR () const
	Override this functions to use a subclass of DtEnvironmentProcessStateRepository.
Protected Member Functions inherited from DtSimLocalEnvironmentalNetInterface
	DtSimLocalEnvironmentalNetInterface ()
	default constructor
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.
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 DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository >
bool	myIsUninitialized
Static Protected Attributes inherited from DtSimLocalEnvironmentalNetInterface
static double	theHeartbeatVariance

Detailed Description

Defines the local net interface for engineering object control objects.

Constructor & Destructor Documentation

DtLocalEngineeringObjectNetInterface::DtLocalEngineeringObjectNetInterface ( )

protected

default constructor

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

read/writable constructor

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

copy constructor

virtual DtLocalEngineeringObjectNetInterface::~DtLocalEngineeringObjectNetInterface ( )

virtual

destructor

Member Function Documentation

const DtLocalEngineeringObjectNetInterface& DtLocalEngineeringObjectNetInterface::operator=

(

const DtLocalEngineeringObjectNetInterface &

orig

)

assignment operator

virtual DtEnvironmentProcessPublisher* DtLocalEngineeringObjectNetInterface::_createPublisher ( const DtEntityIdentifier &  id = DtEntityIdentifier::nullId() ) const

virtual

Create a custom publisher to ensure that publishes the correct FOM class.

Reimplemented from DtSimLocalControlObjectNetInterface.

virtual DtString DtLocalEngineeringObjectNetInterface::type ( ) const

virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtSimLocalControlObjectNetInterface.

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

static

Reimplemented from DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtExtendedPropertiesControlObjectStateRepository >.

---

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

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