 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
File: lclEntNetIf.h. More...
Public Member Functions | |
| DtSimLocalEntityNetInterface (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0, bool publishObject=true) | |
| read/writable contructor | |
| DtSimLocalEntityNetInterface (const DtSimLocalEntityNetInterface &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 DtSimLocalEntityNetInterface & | operator= (const DtSimLocalEntityNetInterface &orig) |
| assignment operator; see note on copy constructor above. | |
| virtual | ~DtSimLocalEntityNetInterface () |
| destructor; calls destroyPublisher(). | |
| virtual bool | init () |
| Override of base class init(), calls createPublisher(). | |
| virtual void | onTick () |
| Checks if VR-Forces-specific data has changed. | |
| 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 void | updatePublisher ()=0 |
| This will copy from the local state repository to the specific type of publisher created in deriving classes. | |
| virtual bool | createPublisher ()=0 |
| Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type. | |
| virtual void | destroyPublisher ()=0 |
| Called by the destructor (and also by setPublisher() in some cases), deletes a publisher. | |
| virtual void | updateNet () |
| Cause any necessary data to be send to the network. | |
| virtual void | setupNetworkRepository ()=0 |
| 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 | isAggregate () const =0 |
Static Public Member Functions | |
| static bool | isVrfGlobalId (const DtGlobalObjectDesignator &identifier) |
| Returns true if given global object Id is a VR-Forces encoded global Id and false if it is not. | |
| static DtSimLocalEntityNetInterface * | isLocalEntityNetInterface (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 | setVrfDataTimeThreshold (DtTime time) |
| Sets the time to update the vrf data message. | |
Protected Member Functions | |
| DtSimLocalEntityNetInterface () | |
| default constructor | |
Protected Attributes | |
| bool | myPublisherUserSupplied |
| bool | myPublishObject |
| DtSimManager * | mySimManager |
| Obtained from our DtVrfObject, and cached for use in sendVrfObject(). | |
| double | myMinTickPeriod |
| double | myMinTickPeriodVariance |
| double | myNextTickTime |
File: lclEntNetIf.h.
Class: DtSimLocalEntityNetInterface Class Description: DtSimLocalEntityNetInterface
Derived from DtSimEntityNetInterface, DtSimLocalEntityNetInterface provides an interface between a local entity and its network (VR-Link) representation. This is an abstract class whose deriving classes will represent different types of entities, such as individual, aggregate, and eventually, environmental.
| DtSimLocalEntityNetInterface::DtSimLocalEntityNetInterface | ( | ) | [protected] |
default constructor
| DtSimLocalEntityNetInterface::DtSimLocalEntityNetInterface | ( | const DtString & | name, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry = 0, |
||
| bool | publishObject = true |
||
| ) |
read/writable contructor
| DtSimLocalEntityNetInterface::DtSimLocalEntityNetInterface | ( | const DtSimLocalEntityNetInterface & | 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 DtSimLocalEntityNetInterface::~DtSimLocalEntityNetInterface | ( | ) | [virtual] |
destructor; calls destroyPublisher().
| const DtSimLocalEntityNetInterface& DtSimLocalEntityNetInterface::operator= | ( | const DtSimLocalEntityNetInterface & | orig | ) |
assignment operator; see note on copy constructor above.
| virtual bool DtSimLocalEntityNetInterface::init | ( | ) | [virtual] |
Override of base class init(), calls createPublisher().
Reimplemented from DtSimObjectNetInterface.
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::onTick | ( | ) | [virtual] |
Checks if VR-Forces-specific data has changed.
If it has, sets the object changed flag.
Implements DtSimObjectNetInterface.
| virtual void DtSimLocalEntityNetInterface::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.
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::setMinTickPeriod | ( | double | minTickPeriod | ) | [virtual] |
specifies a minimum tick period (which can also be thought of as
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual double DtSimLocalEntityNetInterface::minTickPeriod | ( | ) | const [virtual] |
access the minimum tick period
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::setMinTickPeriodVariance | ( | double | minTickPeriodVariance | ) | [virtual] |
set the variance in the minimum tick time
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual double DtSimLocalEntityNetInterface::minTickPeriodVariance | ( | ) | const [virtual] |
access the variance in the minimum tick period
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::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())
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual double DtSimLocalEntityNetInterface::nextTickTime | ( | ) | const [virtual] |
access the next tick time
Reimplemented in DtSimAggregateLocalEntityNetInterface.
| virtual double DtSimLocalEntityNetInterface::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 bool DtSimLocalEntityNetInterface::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 DtSimLocalEntityNetInterface::updatePublisher | ( | ) | [pure virtual] |
This will copy from the local state repository to the specific type of publisher created in deriving classes.
Implemented in DtSimAggregateLocalEntityNetInterface, DtSimIndividualLocalEntityNetInterface, DtSimPseudoAggregateLocalEntityNetInterface, and MyIndividualLocalEntityNetInterface.
| virtual bool DtSimLocalEntityNetInterface::createPublisher | ( | ) | [pure virtual] |
Called by init() to create a VR-Link publisher, deriving classes create the type of publisher needed for that entity type.
Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::destroyPublisher | ( | ) | [pure virtual] |
Called by the destructor (and also by setPublisher() in some cases), deletes a publisher.
Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::updateNet | ( | ) | [virtual] |
Cause any necessary data to be send to the network.
Called by onTick. Base class implementation causes a VrfData message to be sent if necessary.
Reimplemented in DtSimIndividualLocalEntityNetInterface, and DtSimAggregateLocalEntityNetInterface.
| virtual void DtSimLocalEntityNetInterface::setupNetworkRepository | ( | ) | [pure 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.
Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.
| static bool DtSimLocalEntityNetInterface::isVrfGlobalId | ( | const DtGlobalObjectDesignator & | identifier | ) | [static] |
Returns true if given global object Id is a VR-Forces encoded global Id and false if it is not.
Calls down to DtVrfObjectIdGenerator to make the check
| virtual bool DtSimLocalEntityNetInterface::isLocal | ( | ) | const [inline, virtual] |
This network interface is for local entities.
Implements DtSimObjectNetInterface.
| virtual bool DtSimLocalEntityNetInterface::isAggregate | ( | ) | const [pure virtual] |
Implemented in DtSimAggregateLocalEntityNetInterface, and DtSimIndividualLocalEntityNetInterface.
| static DtSimLocalEntityNetInterface* DtSimLocalEntityNetInterface::isLocalEntityNetInterface | ( | 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 DtSimLocalEntityNetInterface::setVrfDataTimeThreshold | ( | DtTime | time | ) | [static] |
Sets the time to update the vrf data message.
The message will be sent on this time (default is five seconds) or if the data as seen by remote is different that the current time. If time is set to be -1, it will only be sent if the data is different
bool DtSimLocalEntityNetInterface::myPublishObject [protected] |
DtSimManager* DtSimLocalEntityNetInterface::mySimManager [protected] |
Obtained from our DtVrfObject, and cached for use in sendVrfObject().
double DtSimLocalEntityNetInterface::myMinTickPeriod [protected] |
Reimplemented in DtSimAggregateLocalEntityNetInterface.
double DtSimLocalEntityNetInterface::myMinTickPeriodVariance [protected] |
Reimplemented in DtSimAggregateLocalEntityNetInterface.
double DtSimLocalEntityNetInterface::myNextTickTime [protected] |
Reimplemented in DtSimAggregateLocalEntityNetInterface.