Class Description: DtSimLocalControlObjectNetInterface. More...

Inheritance diagram for DtSimLocalControlObjectNetInterface:

Public Member Functions
	DtSimLocalControlObjectNetInterface (const DtString &name, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor More...

	DtSimLocalControlObjectNetInterface (const DtSimLocalControlObjectNetInterface &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. More...

const DtSimLocalControlObjectNetInterface &	operator= (const DtSimLocalControlObjectNetInterface &orig)
	assignment operator; see note on copy constructor above. More...

virtual	~DtSimLocalControlObjectNetInterface ()
	destructor; calls destroyPublisher() More...

virtual void	onTick ()
	Override of base class onTick() Checks if VR-Forces-specific data has changed. More...

virtual DtControlObjectRepository *	controlObjectNetworkState () const
	Get the control object publisher for this object. More...

virtual void	updatePublisher ()
	Update this publisher's contents. More...

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

virtual void	destroyPublisher ()
	Called by the destructor (and also by setPublisher() in some cases). More...

virtual DtObjectPublisher *	publisher ()
	Returns the publisher used by this net interface. More...

virtual bool	setEntityPublisher (DtVrfExtControlObjectPublisher *publisher)
	If the user needs to supply a publisher other than the one created by the network interface, this call call be used. More...

virtual DtVrfExtControlObjectPublisher *	controlObjectPublisher () const
	Returns a pointer to the DtVrfExtControlObjectPublisher created. More...

virtual void	updateUuid ()
	Updates the UUID to be published to the network. More...

virtual DtString	type () const
	Return type string for publisher that can be referred to in ope files (see "vrfNetIfTypes.h") More...

Public Member Functions inherited from DtSimLocalEnvironmentalNetInterface
	DtSimLocalEnvironmentalNetInterface (const DtString &name, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable constructor More...

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

const DtSimLocalEnvironmentalNetInterface &	operator= (const DtSimLocalEnvironmentalNetInterface &orig)
	assignment operator; see note on copy constructor above. More...

virtual	~DtSimLocalEnvironmentalNetInterface ()
	destructor; calls destroyPublisher() More...

virtual bool	init (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
	Override of base class init(), calls createPublisher(). More...

virtual void	tick ()
	Override base class tick. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

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

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

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

DtVrfObject *	vrfObject () const

virtual bool	isLocal () const
	This network interface is for local entities. More...

virtual bool	isEnvironmental () const

virtual RTI::ObjectClassHandle	objectClassHandle () const
	Returns the HLA object class handle of the published object. More...

virtual void	processVerticesChanged (const DtVrfObject *)

Public Member Functions inherited from DtSimEnvironmentalNetInterface
	DtSimEnvironmentalNetInterface (const DtString &name, DtVrfObject simObject, DtReaderWriterRegistry parentRegistry=0, bool publishObject=true)
	read/writable contructor More...

	DtSimEnvironmentalNetInterface (const DtSimEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...

const DtSimEnvironmentalNetInterface &	operator= (const DtSimEnvironmentalNetInterface &orig)
	assignment operator More...

virtual	~DtSimEnvironmentalNetInterface ()
	destructor More...

virtual bool	init ()
	override of base class init(), calls create<...>Record() functions More...

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

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

	DtSimObjectNetInterface (const DtSimObjectNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor More...

const DtSimObjectNetInterface &	operator= (const DtSimObjectNetInterface &orig)
	assignment operator More...

virtual	~DtSimObjectNetInterface ()
	destructor More...

virtual DtVrfObject *	simObject () const
	This is a pointer to the simulation object for which this interface was created. More...

virtual DtStateRepository *	networkState () const
	this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object More...

virtual int	maxNameLength () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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

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

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

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

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

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

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtSimObjectNetInterface *	creator (const DtString &name, DtVrfObject vrfObject, DtReaderWriterRegistry parentRegistry, bool publishObject)

Static Public Member Functions inherited from DtSimLocalEnvironmentalNetInterface
static DtSimLocalEnvironmentalNetInterface *	isLocalEnvironmentalNetInterface (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. More...

static void	verticesChanged (const DtVrfObject , void usr)

static void	setHeartbeatVariance (double variance)
	Variance to use for setting heartbeat thresholds. More...

static double	heartbeatVariance ()

Static Public Member Functions inherited from DtSimEnvironmentalNetInterface
static DtSimEnvironmentalNetInterface *	isEnvironmentalNetInterface (const DtSimObjectNetInterface *objNetInterface)
	This function will return the objNetInterface passed in, cast to a DtSimEntityNetInterface*, provided the objNetInterface is indeed an entity network interface. More...

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

static DtNonVrfUUIDResolver *	nonVrfUUIDResolver ()

static void	addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn)
	Adds a net interface creator function to the net interface factory. More...

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

static int	maxNameLengthForInterfaceType (const DtString &interfaceTypeString)

static void	setNonVrfObjectsUUIDScheme (const DtString &)
	Sets the UUID scheme for non vrf objects. More...

static DtString	nonVrfObjectsUUIDScheme ()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Member Functions
	DtSimLocalControlObjectNetInterface ()
	default constructor More...

virtual bool	updateGeometry (DtVrfOverlayObjectStateRepository *localState)
	Builds a DtList of env. More...

virtual bool	updateBoundingGeometry (DtVrfOverlayObjectStateRepository *localState)
	Fills in bounding sphere, bounding rect records. More...

virtual bool	updateObjectState (DtVrfOverlayObjectStateRepository *localState)
	Fills in object state record. More...

virtual bool	updateEnvModelType (DtVrfOverlayObjectStateRepository *localState)

virtual bool	updateVrfDataAsSeenByRemote ()
	Update contents of our environmental state with data from our DtVrfObject. More...

virtual DtEnvironmentProcessRepository *	_createSR () const
	Override this functions to use a subclass of DtEnvironmentProcessStateRepository. More...

Protected Member Functions inherited from DtSimLocalEnvironmentalNetInterface
	DtSimLocalEnvironmentalNetInterface ()
	default constructor More...

virtual DtEnvironmentProcessPublisher *	_createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
	Override this functions to use a subclass of DtEnvironmentProcessPublisher. More...

Protected Member Functions inherited from DtSimEnvironmentalNetInterface
	DtSimEnvironmentalNetInterface ()
	default constructor More...

Protected Member Functions inherited from DtSimObjectNetInterface
	DtSimObjectNetInterface ()
	default constructor More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Attributes
bool	myPublisherUserSupplied

DtVrfExtControlObjectPublisher *	myControlObjectPublisher

std::vector< char >	myPropertyBuffer

DtClock	myClock

DtTime	myLastEncodeTime

Protected Attributes inherited from DtSimLocalEnvironmentalNetInterface
bool	myPublisherUserSupplied

DtEnvironmentProcessPublisher *	myEnvironmentalPublisher

bool	myPublishObject

DtSimManager *	mySimManager
	Obtained from our DtVrfObject, and cached for use in sendVrfObject(). More...

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

bool	myVerticesChanged

bool	myVerticesChangedCallbackRegistered

Protected Attributes inherited from DtSimObjectNetInterface
DtVrfObject *	mySimObject

DtStateRepository *	myNetworkState

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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

Static Protected Attributes inherited from DtSimLocalEnvironmentalNetInterface
static double	theHeartbeatVariance

Static Protected Attributes inherited from DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory

static DtNonVrfUUIDResolver *	theNonVrfUUIDResolver

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Detailed Description

Class Description: DtSimLocalControlObjectNetInterface.

Derived from DtSimEnvironmentalNetInterface, DtSimLocalControlObjectNetInterface provides an interface between a local VRF control object and it's network (VR-Link) representation.

Constructor & Destructor Documentation

DtSimLocalControlObjectNetInterface::DtSimLocalControlObjectNetInterface ( )

protected

default constructor

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

read/writable constructor

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

virtual

destructor; calls destroyPublisher()

Member Function Documentation

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

assignment operator; see note on copy constructor above.

virtual void DtSimLocalControlObjectNetInterface::onTick ( )

virtual

Override of base class onTick() Checks if VR-Forces-specific data has changed.

If it has, sets the object changed flag. Calls updatePublisher().

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >.

virtual DtControlObjectRepository* DtSimLocalControlObjectNetInterface::controlObjectNetworkState ( ) const

virtual

Get the control object publisher for this object.

Reimplemented from DtSimEnvironmentalNetInterface.

virtual void DtSimLocalControlObjectNetInterface::updatePublisher ( )

virtual

Update this publisher's contents.

Implements DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtGlobalEnvironmentLocalNetInterface, DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >, DtSimLocalTacticalSmokeNetInterface, DtWeatherLocalNetInterface, and DtCloudLayerLocalNetInterface.

virtual bool DtSimLocalControlObjectNetInterface::createPublisher ( const DtEntityIdentifier & id = DtEntityIdentifier::nullId() )

virtual

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

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtWeatherLocalNetInterface, and DtCloudLayerLocalNetInterface.

virtual void DtSimLocalControlObjectNetInterface::destroyPublisher ( )

virtual

Called by the destructor (and also by setPublisher() in some cases).

Deletes the publisher.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtWeatherLocalNetInterface, and DtCloudLayerLocalNetInterface.

virtual DtObjectPublisher* DtSimLocalControlObjectNetInterface::publisher ( )

virtual

Returns the publisher used by this net interface.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

virtual bool DtSimLocalControlObjectNetInterface::setEntityPublisher ( DtVrfExtControlObjectPublisher * 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 DtVrfExtControlObjectPublisher* DtSimLocalControlObjectNetInterface::controlObjectPublisher ( ) const

virtual

Returns a pointer to the DtVrfExtControlObjectPublisher created.

virtual void DtSimLocalControlObjectNetInterface::updateUuid ( )

virtual

Updates the UUID to be published to the network.

Implements DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >.

virtual DtString DtSimLocalControlObjectNetInterface::type ( ) const

virtual

Return type string for publisher that can be referred to in ope files (see "vrfNetIfTypes.h")

Implements DtSimLocalEnvironmentalNetInterface.

Reimplemented in DtGlobalEnvironmentLocalNetInterface, DtSimLocalTacticalSmokeNetInterface, DtWeatherLocalNetInterface, DtCloudLayerLocalNetInterface, DtLocalEngineeringObjectNetInterface, and DtSimLocalControlObjectWithPropertiesNetInterface.

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

static

virtual bool DtSimLocalControlObjectNetInterface::updateGeometry ( DtVrfOverlayObjectStateRepository * localState )

protectedvirtual

Builds a DtList of env.

geometry records. Deriving classes can override and create different kinds of geometry records if desired.

virtual bool DtSimLocalControlObjectNetInterface::updateBoundingGeometry ( DtVrfOverlayObjectStateRepository * localState )

protectedvirtual

Fills in bounding sphere, bounding rect records.

virtual bool DtSimLocalControlObjectNetInterface::updateObjectState ( DtVrfOverlayObjectStateRepository * localState )

protectedvirtual

Fills in object state record.

virtual bool DtSimLocalControlObjectNetInterface::updateEnvModelType ( DtVrfOverlayObjectStateRepository * localState )

protectedvirtual

virtual bool DtSimLocalControlObjectNetInterface::updateVrfDataAsSeenByRemote ( )

protectedvirtual

Update contents of our environmental state with data from our DtVrfObject.

Reimplemented in DtSimLocalTacticalSmokeNetInterface.

virtual DtEnvironmentProcessRepository* DtSimLocalControlObjectNetInterface::_createSR ( ) const

protectedvirtual

Override this functions to use a subclass of DtEnvironmentProcessStateRepository.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Member Data Documentation

bool DtSimLocalControlObjectNetInterface::myPublisherUserSupplied

protected

DtVrfExtControlObjectPublisher* DtSimLocalControlObjectNetInterface::myControlObjectPublisher

protected

std::vector<char> DtSimLocalControlObjectNetInterface::myPropertyBuffer

protected

DtClock DtSimLocalControlObjectNetInterface::myClock

protected

DtTime DtSimLocalControlObjectNetInterface::myLastEncodeTime

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/simLocalControlObjectNetInterface.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