 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Class Description: DtSimLocalEnvironmentalNetInterface. More...
Public Member Functions | |
| 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 () |
| Override of base class init(), calls createPublisher(). | |
| virtual DtString | type () const =0 |
| Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h") | |
| 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 void | updatePublisher ()=0 |
| This will copy from the local state repository to the specific type of publisher created in deriving classes. | |
| virtual bool | createPublisher () |
| 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 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 intialized. | |
| DtVrfObject * | vrfObject () const |
| virtual bool | isLocal () const |
| This network interface is for local entities. | |
| virtual bool | isEnvironmental () const |
| virtual void | processVerticesChanged (DtVrfObject *) |
Static Public Member Functions | |
| 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) |
Protected Member Functions | |
| DtSimLocalEnvironmentalNetInterface () | |
| default constructor | |
| virtual DtEnvironmentProcessPublisher * | _createPublisher () const |
| Override this functions to use a subclass of DtEnvironmentProcessPublisher. | |
| virtual DtEnvironmentProcessRepository * | _createSR () const |
| Override this functions to use a subclass of DtEnvironmentProcessStateRepository. | |
Protected Attributes | |
| bool | myPublisherUserSupplied |
| DtEnvironmentProcessPublisher * | myEnvironmentalPublisher |
| bool | myPublishObject |
| DtSimManager * | mySimManager |
| Obtained from our DtVrfObject, and cached for use in sendVrfObject(). | |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
| bool | myVerticesChanged |
Class Description: DtSimLocalEnvironmentalNetInterface.
Derived from DtSimEnvironmentalNetInterface, DtSimLocalEnvironmentalNetInterface provides an interface between a local environmental object and it's network (VR-Link) representation.
default constructor
| DtSimLocalEnvironmentalNetInterface::DtSimLocalEnvironmentalNetInterface | ( | const DtString & | name, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry = 0, |
||
| bool | publishObject = true |
||
| ) |
read/writable contructor
| DtSimLocalEnvironmentalNetInterface::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.
Therefore, you must call init() on the copy after construction, or call setPublisher() with a user constructed publisher.
| virtual DtSimLocalEnvironmentalNetInterface::~DtSimLocalEnvironmentalNetInterface | ( | ) | [virtual] |
destructor; calls destroyPublisher()
| const DtSimLocalEnvironmentalNetInterface& DtSimLocalEnvironmentalNetInterface::operator= | ( | const DtSimLocalEnvironmentalNetInterface & | orig | ) |
assignment operator; see note on copy constructor above.
| virtual bool DtSimLocalEnvironmentalNetInterface::init | ( | ) | [virtual] |
Override of base class init(), calls createPublisher().
Reimplemented from DtSimEnvironmentalNetInterface.
Reimplemented in DtGlobalEnvironmentLocalNetInterface.
| virtual DtString DtSimLocalEnvironmentalNetInterface::type | ( | ) | const [pure virtual] |
Return type string for publisher that can be refered to in ope files (see "vrfNetIfTypes.h")
Implements DtSimObjectNetInterface.
Implemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.
| virtual void DtSimLocalEnvironmentalNetInterface::tick | ( | ) | [virtual] |
Override base class tick.
This version of tick checks to see if the time to tick has arrived (myNextTickTime <= exerciseClock()-> approximateElapsedRealTime()). If it has, it will then call the base class tick (which in turn calls onTick()), and recalculate the next tick time
Reimplemented from DtSimObjectNetInterface.
| virtual void DtSimLocalEnvironmentalNetInterface::setMinTickPeriod | ( | double | minTickPeriod | ) | [virtual] |
specifies a minimum tick period (which can also be thought of as
| virtual double DtSimLocalEnvironmentalNetInterface::minTickPeriod | ( | ) | const [virtual] |
access the minimum tick period
| virtual void DtSimLocalEnvironmentalNetInterface::setMinTickPeriodVariance | ( | double | minTickPeriodVariance | ) | [virtual] |
set the variance in the minimum tick time
| virtual double DtSimLocalEnvironmentalNetInterface::minTickPeriodVariance | ( | ) | const [virtual] |
access the variance in the minimum tick period
| virtual void DtSimLocalEnvironmentalNetInterface::setNextTickTime | ( | double | nextTickTime | ) | [virtual] |
The next tick time is normally calculated internally.
setNextTickTime can be used to force a tick (set nextTickTime to exerciseClock()-> approximateElapsedRealTime())
| virtual double DtSimLocalEnvironmentalNetInterface::nextTickTime | ( | ) | const [virtual] |
access the next tick time
| virtual double DtSimLocalEnvironmentalNetInterface::calculateNextTickTime | ( | ) | const [virtual] |
The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
and +myMinTickPeriodVariance/2. If the exercise clock is paused, the variance is always set to zero to insure that the extra calls to DtFRand() don't prevent repeatability.
| virtual void DtSimLocalEnvironmentalNetInterface::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().
Implements DtSimObjectNetInterface.
| virtual bool DtSimLocalEnvironmentalNetInterface::publisherUserSupplied | ( | ) | const [virtual] |
A true return indicates that the publisher currently used by the interface was supplied by the user rather than created by init().
| virtual void DtSimLocalEnvironmentalNetInterface::updatePublisher | ( | ) | [pure virtual] |
This will copy from the local state repository to the specific type of publisher created in deriving classes.
Implemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.
| virtual bool DtSimLocalEnvironmentalNetInterface::createPublisher | ( | ) | [virtual] |
Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type.
| virtual void DtSimLocalEnvironmentalNetInterface::destroyPublisher | ( | ) | [virtual] |
Called by the destructor (and also by setPublisher() in some cases, deletes a publisher.
| virtual bool DtSimLocalEnvironmentalNetInterface::setEntityPublisher | ( | DtEnvironmentProcessPublisher * | 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 DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::environmentalPublisher | ( | ) | const [virtual] |
| virtual void DtSimLocalEnvironmentalNetInterface::setupNetworkRepository | ( | ) | [virtual] |
Initializes parts of the network repository created by the publisher This needs to be done after the local state repository has been intialized.
Details depend upon which type of publisher (and therefore network state repository) is actually created.
| virtual bool DtSimLocalEnvironmentalNetInterface::isLocal | ( | ) | const [inline, virtual] |
This network interface is for local entities.
Implements DtSimObjectNetInterface.
| virtual bool DtSimLocalEnvironmentalNetInterface::isEnvironmental | ( | ) | const [inline, virtual] |
Reimplemented from DtSimEnvironmentalNetInterface.
| static DtSimLocalEnvironmentalNetInterface* DtSimLocalEnvironmentalNetInterface::isLocalEnvironmentalNetInterface | ( | const DtSimObjectNetInterface * | objNetInterface | ) | [static] |
This function will return the objNetInterface passed in, cast to a DtSimLocalEntityNetInterface*, provided the objNetInterface is indeed an local entity network interface.
| static void DtSimLocalEnvironmentalNetInterface::verticesChanged | ( | DtVrfObject * | , |
| void * | usr | ||
| ) | [static] |
| virtual void DtSimLocalEnvironmentalNetInterface::processVerticesChanged | ( | DtVrfObject * | ) | [virtual] |
| virtual DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::_createPublisher | ( | ) | const [protected, virtual] |
Override this functions to use a subclass of DtEnvironmentProcessPublisher.
Reimplemented in DtSimLocalControlObjectNetInterface, DtSimLocalTacticalSmokeNetInterface, and DtGlobalEnvironmentLocalNetInterface.
| virtual DtEnvironmentProcessRepository* DtSimLocalEnvironmentalNetInterface::_createSR | ( | ) | const [protected, virtual] |
Override this functions to use a subclass of DtEnvironmentProcessStateRepository.
Reimplemented in DtSimLocalControlObjectNetInterface.
DtEnvironmentProcessPublisher* DtSimLocalEnvironmentalNetInterface::myEnvironmentalPublisher [protected] |
Obtained from our DtVrfObject, and cached for use in sendVrfObject().
double DtSimLocalEnvironmentalNetInterface::myMinTickPeriod [protected] |
double DtSimLocalEnvironmentalNetInterface::myMinTickPeriodVariance [protected] |
double DtSimLocalEnvironmentalNetInterface::myNextTickTime [protected] |