 |
VR-Link API Documentation for HLA 1516
|
|
VR-Link API Documentation for HLA 1516
|
class DtReflectedObject: More...
Inheritance diagram for DtReflectedObject: Collaboration diagram for DtReflectedObject:Public Types | |
| typedef DtStateRepository *(* | DtBaseStateRepCreator )() |
| Function prototype for functions that create DtStateRepositories. | |
Public Member Functions | |
| DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep) | |
| Primary constructor. | |
| DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator) | |
| Older constructor. | |
| DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator) | |
| Older constructor. | |
| virtual | ~DtReflectedObject () |
| destructor | |
| virtual DtStateRepository * | stateRep () const |
| Returns a pointer to the StateRepository - through which you can inspect current state information. | |
| virtual DtStateRepository * | sr () const |
| Synonym for stateRep(). | |
| virtual DtHlaStateDecoder * | decoder () |
| Returns a pointer to the Decoder being used to decode state messages into our SR. | |
| virtual DtHlaObjectWithStateRep * | hlaObject () const |
| Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject). | |
| virtual const DtObjectId & | objectId () const |
| Get the HLA object's id. | |
| virtual const DtObjectId & | id () const |
| Get the HLA object's id (local ID). | |
| virtual const DtObjectId & | localId () const |
| Get the HLA object's id (local ID). | |
| virtual const DtString & | name () const |
| Get the HLA object name. | |
| virtual const DtGlobalObjectDesignator & | globalId () const |
| Get the HLA object's global object designator - the object name in HLA. | |
| virtual const std::set < DtDDMRegion > & | lastRegionInformation () const |
| Get the region handle from the last update HLA 1516 only. | |
| virtual DtTime | lastSimTimeUpdated () const |
| Returns the value of simulation time at the time an update was last received for the entity. | |
| virtual DtTime | lastReceivedTimeStamp () const |
| Returns the value of the time send in the last Update received for this entity. | |
| virtual void | baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
| Object state callback registration/deregistration. | |
| virtual void | baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData) |
| virtual DtReflectedObject * | nextObj () const |
| Get the next remote object. | |
| virtual DtReflectedObject * | prevObj () const |
| Get the previous remote object. | |
| virtual DtReflectedObject * | wrapNextObj () const |
| Get the next remote object. | |
| virtual DtReflectedObject * | wrapPrevObj () const |
| Get the previous remote object. | |
| void | setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL) |
| Start reflecting this object, using this decoder. | |
| virtual void | setNoHlaObject (const DtObjectId &id, const DtGlobalObjectDesignator &des) |
| Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object. | |
| void | detachHlaObject () |
| Ends managing of current HLA object. | |
| virtual void | requestUpdate () |
| Request that the owner of this entity send an attribute update. | |
Protected Member Functions | |
| DtReflectedObject (const DtReflectedObject &orig) | |
| copy constructor -- Not Implemented | |
| DtReflectedObject & | operator= (const DtReflectedObject &orig) |
| assignment operator -- Not Implemented | |
| virtual void | processPostUpdateCallbacks () |
| Process the post update callbacks. | |
Static Protected Member Functions | |
| static void | requestUpdatePostDrainCb (void *usr) |
| Calls requestUpdate. | |
| static void | processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr) |
| Callback from HlaObject to process post update callbacks. | |
Protected Attributes | |
| DtExerciseConn * | myExConn |
| DtHlaObjectWithStateRep * | myHlaObj |
| DtStateRepository * | myStateRep |
| DtHlaStateDecoder * | myDecoder |
| bool | myRequestCbRegistered |
| DtIntrusiveList | myStateUpdateCallbacks |
| DtObjectId | myId |
| DtString | myName |
class DtReflectedObject:
Instances of DtReflectedObject are used to represent a simulation entity reflected across a network (i.e. this is not a full simulation running on this machine).
| typedef DtStateRepository*(* DtReflectedObject::DtBaseStateRepCreator)() |
Function prototype for functions that create DtStateRepositories.
| DtReflectedObject::DtReflectedObject | ( | DtExerciseConn * | conn, |
| DtStateRepository * | stateRep | ||
| ) |
Primary constructor.
| DtReflectedObject::DtReflectedObject | ( | DtHlaObject * | obj, |
| DtExerciseConn * | conn, | ||
| DtBaseStateRepCreator | creator | ||
| ) |
Older constructor.
Use the primary constructor followed by setHlaObject instead.
| DtReflectedObject::DtReflectedObject | ( | const DtObjectId & | id, |
| const DtGlobalObjectDesignator & | des, | ||
| DtExerciseConn * | conn, | ||
| DtBaseStateRepCreator | creator | ||
| ) |
Older constructor.
Use the primary constructor followed by setNoHlaObject instead.
| virtual DtReflectedObject::~DtReflectedObject | ( | ) | [virtual] |
destructor
| DtReflectedObject::DtReflectedObject | ( | const DtReflectedObject & | orig | ) | [protected] |
copy constructor -- Not Implemented
| virtual void DtReflectedObject::baseAddPostUpdateCallback | ( | DtReflectedObjectCallbackFunction | cb, |
| void * | userData | ||
| ) | [virtual] |
Object state callback registration/deregistration.
| virtual void DtReflectedObject::baseRemovePostUpdateCallback | ( | DtReflectedObjectCallbackFunction | cb, |
| void * | userData | ||
| ) | [virtual] |
| virtual DtHlaStateDecoder* DtReflectedObject::decoder | ( | ) | [virtual] |
Returns a pointer to the Decoder being used to decode state messages into our SR.
| void DtReflectedObject::detachHlaObject | ( | ) |
Ends managing of current HLA object.
NON Virtual -- Called in DTOR
| virtual const DtGlobalObjectDesignator& DtReflectedObject::globalId | ( | ) | const [virtual] |
Get the HLA object's global object designator - the object name in HLA.
| DtHlaObjectWithStateRep * DtReflectedObject::hlaObject | ( | ) | const [inline, virtual] |
Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
References myHlaObj.
| virtual const DtObjectId& DtReflectedObject::id | ( | ) | const [virtual] |
Get the HLA object's id (local ID).
Referenced by localId().
| virtual DtTime DtReflectedObject::lastReceivedTimeStamp | ( | ) | const [virtual] |
Returns the value of the time send in the last Update received for this entity.
| virtual const std::set<DtDDMRegion>& DtReflectedObject::lastRegionInformation | ( | ) | const [virtual] |
Get the region handle from the last update HLA 1516 only.
May require additional RTI configuration to be populated, including DDM subscription / publications.
| virtual DtTime DtReflectedObject::lastSimTimeUpdated | ( | ) | const [virtual] |
Returns the value of simulation time at the time an update was last received for the entity.
| const DtObjectId & DtReflectedObject::localId | ( | ) | const [inline, virtual] |
Get the HLA object's id (local ID).
References id().
| virtual const DtString& DtReflectedObject::name | ( | ) | const [virtual] |
Get the HLA object name.
| DtReflectedObject * DtReflectedObject::nextObj | ( | ) | const [inline, virtual] |
Get the next remote object.
References DtListedObj::next().
| virtual const DtObjectId& DtReflectedObject::objectId | ( | ) | const [virtual] |
Get the HLA object's id.
| DtReflectedObject& DtReflectedObject::operator= | ( | const DtReflectedObject & | orig | ) | [protected] |
assignment operator -- Not Implemented
| DtReflectedObject * DtReflectedObject::prevObj | ( | ) | const [inline, virtual] |
Get the previous remote object.
References DtListedObj::prev().
| virtual void DtReflectedObject::processPostUpdateCallbacks | ( | ) | [protected, virtual] |
Process the post update callbacks.
| static void DtReflectedObject::processPostUpdateCallbacksCb | ( | const DtStateMsg & | stateMsg, |
| DtHlaObject * | obj, | ||
| void * | usr | ||
| ) | [static, protected] |
Callback from HlaObject to process post update callbacks.
| virtual void DtReflectedObject::requestUpdate | ( | ) | [virtual] |
Request that the owner of this entity send an attribute update.
| static void DtReflectedObject::requestUpdatePostDrainCb | ( | void * | usr | ) | [static, protected] |
Calls requestUpdate.
| void DtReflectedObject::setHlaObject | ( | DtHlaObject * | obj, |
| DtHlaStateDecoder * | decoder = NULL |
||
| ) |
Start reflecting this object, using this decoder.
If decoder is NULL, we get one from the FOM Mapper. The decoder is deleted by the DtReflectedObject destructor. Usually called by derived class constructor.
| virtual void DtReflectedObject::setNoHlaObject | ( | const DtObjectId & | id, |
| const DtGlobalObjectDesignator & | des | ||
| ) | [virtual] |
Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object.
| DtStateRepository * DtReflectedObject::sr | ( | ) | const [inline, virtual] |
Synonym for stateRep().
References myStateRep.
| DtStateRepository * DtReflectedObject::stateRep | ( | ) | const [inline, virtual] |
Returns a pointer to the StateRepository - through which you can inspect current state information.
References myStateRep.
| DtReflectedObject * DtReflectedObject::wrapNextObj | ( | ) | const [inline, virtual] |
Get the next remote object.
Will cycle back to the first remote object.
References DtListedObj::wrapNext().
| DtReflectedObject * DtReflectedObject::wrapPrevObj | ( | ) | const [inline, virtual] |
Get the previous remote object.
Will cycle back to the last remote object.
References DtListedObj::wrapPrev().
DtHlaStateDecoder* DtReflectedObject::myDecoder [protected] |
DtExerciseConn* DtReflectedObject::myExConn [protected] |
DtHlaObjectWithStateRep* DtReflectedObject::myHlaObj [protected] |
Referenced by hlaObject().
DtObjectId DtReflectedObject::myId [protected] |
DtString DtReflectedObject::myName [protected] |
bool DtReflectedObject::myRequestCbRegistered [protected] |
DtStateRepository* DtReflectedObject::myStateRep [protected] |
Referenced by DtReflectedActiveSonarBeam::activeSonarBeamRep(), DtReflectedActiveSonar::activeSonarRep(), DtReflectedAdditionalPassiveActivities::additionalPassiveActivitiesRep(), DtReflectedAggregate::aggregateStateRep(), DtReflectedArealObject::aosr(), DtReflectedArealObject::arealObjectRep(), DtReflectedActiveSonarBeam::asr(), DtReflectedAdditionalPassiveActivities::asr(), DtReflectedActiveSonar::asr(), DtReflectedAggregate::asr(), DtReflectedEmitterBeam::beamRep(), DtReflectedEmitterBeam::bsr(), DtReflectedDesignator::designatorRep(), DtReflectedDesignator::dsr(), DtReflectedEmitterSystem::emitterSysRep(), DtReflectedEntity::entityStateRep(), DtReflectedEnvironmentProcess::environmentProcessStateRep(), DtReflectedEnvironmentProcess::epsr(), DtReflectedEntity::esr(), DtReflectedEmitterSystem::esr(), DtReflectedFederate::federateRep(), DtReflectedFederate::fsr(), DtReflectedGriddedData::gdsr(), DtReflectedGriddedData::gridDataRep(), DtReflectedIff::iffStateRep(), DtReflectedIff::isr(), DtReflectedLinearObject::linearObjectRep(), DtReflectedLinearObject::losr(), DtReflectedPointObject::pointObjectRep(), DtReflectedPointObject::posr(), DtReflectedPropulsionNoise::propulsionNoiseRep(), DtReflectedPropulsionNoise::psr(), DtReflectedRadioReceiver::receiverRep(), DtReflectedRadioReceiver::rsr(), sr(), stateRep(), DtReflectedRadioTransmitter::transmitterRep(), and DtReflectedRadioTransmitter::tsr().
