VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtSimLocalControlObjectNetInterface Class Reference

Class Description: DtSimLocalEnvironmentalNetInterface. More...

Inheritance diagram for DtSimLocalControlObjectNetInterface:
Inheritance graph
[legend]

Public Member Functions

 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 DtControlObjectRepositorycontrolObjectNetworkState () const
 Get the control object publisher for this object.
virtual void updatePublisher ()
 UPdate this publisher's contents.
virtual void updateUuid ()
 Updates the UUID to be published to the network.
virtual DtString type () const
 Return type string for publisher that can be referred to in ope files (see "vrfNetIfTypes.h")
- 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 void onTick ()
 Override of base class onTick() Checks if VR-Forces-specific data has changed.
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 DtObjectPublisherpublisher ()
 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.
DtVrfObjectvrfObject () 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 DtSimObjectNetInterfaceoperator= (const DtSimObjectNetInterface &orig)
 assignment operator
virtual ~DtSimObjectNetInterface ()
 destructor
virtual DtVrfObjectsimObject () const
 This is a pointer to the simulation object for which this interface was created.
virtual DtStateRepositorynetworkState () 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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 DtSimObjectNetInterfacecreator (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.
static void verticesChanged (DtVrfObject *, void *usr)
static void setHeartbeatVariance (double variance)
 Variance to use for setting heartbeat thresholds.
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.
- 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 DtNonVrfUUIDResolvernonVrfUUIDResolver ()
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 DtSimObjectNetInterfacecreateNetInterface (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 ()
- 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 chartheXmlType ()
 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 DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 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

 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
DtEnvironmentProcessPublisher
_createPublisher (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
 Override this functions to use a subclass of DtEnvironmentProcessPublisher.
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 ()

Protected Attributes

std::vector< charmyPropertyBuffer
DtClock myClock
DtTime myLastEncodeTime
- Protected Attributes inherited from DtSimLocalEnvironmentalNetInterface
bool myPublisherUserSupplied
DtEnvironmentProcessPublishermyEnvironmentalPublisher
bool myPublishObject
DtSimManagermySimManager
 Obtained from our DtVrfObject, and cached for use in sendVrfObject().
double myMinTickPeriod
double myMinTickPeriodVariance
double myNextTickTime
bool myVerticesChanged
bool myVerticesChangedCallbackRegistered

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

Detailed Description

Class Description: DtSimLocalEnvironmentalNetInterface.

Derived from DtSimEnvironmentalNetInterface, DtSimLocalEnvironmentalNetInterface provides an interface between a local environmental 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 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.

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 DtControlObjectRepository* DtSimLocalControlObjectNetInterface::controlObjectNetworkState ( ) const
virtual

Get the control object publisher for this object.

Reimplemented from DtSimEnvironmentalNetInterface.

virtual void DtSimLocalControlObjectNetInterface::updatePublisher ( )
virtual
virtual void DtSimLocalControlObjectNetInterface::updateUuid ( )
virtual
virtual DtString DtSimLocalControlObjectNetInterface::type ( ) const
virtual
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 DtEnvironmentProcessPublisher* DtSimLocalControlObjectNetInterface::_createPublisher ( const DtEntityIdentifier &  id = DtEntityIdentifier::nullId()) const
protectedvirtual
virtual DtEnvironmentProcessRepository* DtSimLocalControlObjectNetInterface::_createSR ( ) const
protectedvirtual

Override this functions to use a subclass of DtEnvironmentProcessStateRepository.

Reimplemented from DtSimLocalEnvironmentalNetInterface.

Member Data Documentation

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:

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)