VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtGlobalEnvironmentRemoteNetInterface Class Reference
Inheritance diagram for DtGlobalEnvironmentRemoteNetInterface:
Inheritance graph
[legend]

Public Member Functions

 DtGlobalEnvironmentRemoteNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
 read/writable contructor
virtual ~DtGlobalEnvironmentRemoteNetInterface ()
 destructor
virtual DtString type () const
 Returns the type of net interface object.
virtual void onTick ()
 onTick is being overriden so the net interface isn't ticked before the reflected object has been setup.
- Public Member Functions inherited from DtVrfRemoteEnvironmentalNetInterface
 DtVrfRemoteEnvironmentalNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
 read/writable contructor
 DtVrfRemoteEnvironmentalNetInterface (const DtVrfRemoteEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const
DtVrfRemoteEnvironmentalNetInterface
operator= (const DtVrfRemoteEnvironmentalNetInterface &orig)
 assignment operator
virtual ~DtVrfRemoteEnvironmentalNetInterface ()
 destructor
virtual bool init ()
 override of base class init().
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.
DtVrfObjectvrfObject () const
- Public Member Functions inherited from DtSimRemoteEnvironmentalNetInterface
 DtSimRemoteEnvironmentalNetInterface (const DtString &name, DtVrfObject *simObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true)
 read/writable contructor
 DtSimRemoteEnvironmentalNetInterface (const DtSimRemoteEnvironmentalNetInterface &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const
DtSimRemoteEnvironmentalNetInterface
operator= (const DtSimRemoteEnvironmentalNetInterface &orig)
 assignment operator
virtual ~DtSimRemoteEnvironmentalNetInterface ()
 destructor
virtual void updateFromReflectedObject ()
 this will copy from the reflected environment process and associated network state repository to the local state repository
virtual
DtReflectedEnvironmentProcess * 
reflectedObject () const
 returns the pointer to the VR-Link reflected entity being used to represent this remote entity
virtual void setupFromNetworkRepository ()
 initializes parts of the local repository from the network state rep.
virtual void setReflectedObject (DtReflectedEnvironmentProcess *reflectedObject)
 A reflected object must always be supplied.
virtual bool isLocal () const
 Is this network interface for a local (true) or remote (false) object? Local network interfaces should implement this function to return true.
virtual void setUpdateReceived (bool updateReceived)
 Setting update received to true will cause updateFromRemoteObject() to be called on the next tick.
virtual bool updateReceived () const
 Check to see if an update has been received from the network.
- Public Member Functions inherited from 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 DtControlObjectRepository * 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.
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 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 DtStateRepository * networkState () const
 this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object
virtual int maxNameLength () const
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (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 getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
virtual std::list
< DtVariableNameType
unboundVariables () const
bool invalid () const
virtual bool hasChild (const DtReaderWriter *p) const
 Returns true if this variable has a child p in it's chain.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual 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.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions

static DtSimObjectNetInterfacecreator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry, bool publishObject)

Protected Member Functions

virtual void updateLocalObjectState (DtVrfObjectStateRepository *localState)
virtual void updateLocalGeometry (DtVrfObjectStateRepository *localState)
 put the data INTO the local state repository
virtual void deadReckonTimeOfDay ()
- Protected Member Functions inherited from DtVrfRemoteEnvironmentalNetInterface
 DtVrfRemoteEnvironmentalNetInterface ()
 default constructor
- Protected Member Functions inherited from DtSimRemoteEnvironmentalNetInterface
 DtSimRemoteEnvironmentalNetInterface ()
 default constructor
virtual void updateLocalBoundingGeometry (DtVrfObjectStateRepository *localState)
virtual void updateLocalObjectType (DtVrfObjectStateRepository *localState)
virtual void updateLocalModelType (DtVrfObjectStateRepository *localState)
- 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.
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

DtTime myLastUpdateTime
- Protected Attributes inherited from DtVrfRemoteEnvironmentalNetInterface
DtInterfaceMessageExecutivemyMessageExec
DtSimManagermySimManager
 Obtained from our DtVrfObject.
double myMinTickPeriod
double myMinTickPeriodVariance
double myNextTickTime
- Protected Attributes inherited from DtSimRemoteEnvironmentalNetInterface
DtReflectedEnvironmentProcess * myReflectedObject
 Pointer to the VR-Link Reflected Object.
bool myUpdateReceived
 Set to true by post-update callback; set to false after update has been processed.

Private Member Functions

 DtGlobalEnvironmentRemoteNetInterface ()
 Not implemented.
 DtGlobalEnvironmentRemoteNetInterface (const DtGlobalEnvironmentRemoteNetInterface &orig)
 Not implemented.
const
DtGlobalEnvironmentRemoteNetInterface
operator= (const DtGlobalEnvironmentRemoteNetInterface &orig)
 Not implemented.

Additional Inherited Members

- Public Types inherited from DtReaderWriter
typedef std::vector
< DtSymbolString > 
aliasContainer
typedef std::vector
< DtSymbolString >::iterator 
aliasIter
typedef std::vector
< DtSymbolString >
::const_iterator 
aliasConstIter
typedef std::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Static Protected Attributes inherited from DtSimObjectNetInterface
static
DtSimObjectNetInterfaceFactory
theFactory

Constructor & Destructor Documentation

DtGlobalEnvironmentRemoteNetInterface::DtGlobalEnvironmentRemoteNetInterface ( )
private

Not implemented.

DtGlobalEnvironmentRemoteNetInterface::DtGlobalEnvironmentRemoteNetInterface ( const DtGlobalEnvironmentRemoteNetInterface orig)
private

Not implemented.

DtGlobalEnvironmentRemoteNetInterface::DtGlobalEnvironmentRemoteNetInterface ( const DtString name,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry = 0,
bool  publishObject = true 
)

read/writable contructor

virtual DtGlobalEnvironmentRemoteNetInterface::~DtGlobalEnvironmentRemoteNetInterface ( )
virtual

destructor

Member Function Documentation

const DtGlobalEnvironmentRemoteNetInterface& DtGlobalEnvironmentRemoteNetInterface::operator= ( const DtGlobalEnvironmentRemoteNetInterface orig)
private

Not implemented.

virtual DtString DtGlobalEnvironmentRemoteNetInterface::type ( ) const
virtual

Returns the type of net interface object.

Strings are defined in netIfTypes.h.

Reimplemented from DtVrfRemoteEnvironmentalNetInterface.

virtual void DtGlobalEnvironmentRemoteNetInterface::onTick ( )
virtual

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

Reimplemented from DtVrfRemoteEnvironmentalNetInterface.

static DtSimObjectNetInterface* DtGlobalEnvironmentRemoteNetInterface::creator ( const DtString name,
DtVrfObject vrfObject,
DtReaderWriterRegistry parentRegistry,
bool  publishObject 
)
static
virtual void DtGlobalEnvironmentRemoteNetInterface::updateLocalObjectState ( DtVrfObjectStateRepository localState)
protectedvirtual
virtual void DtGlobalEnvironmentRemoteNetInterface::updateLocalGeometry ( DtVrfObjectStateRepository localState)
protectedvirtual

put the data INTO the local state repository

Reimplemented from DtSimRemoteEnvironmentalNetInterface.

virtual void DtGlobalEnvironmentRemoteNetInterface::deadReckonTimeOfDay ( )
protectedvirtual

Member Data Documentation

DtTime DtGlobalEnvironmentRemoteNetInterface::myLastUpdateTime
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)