![]() |
VR-Link API Documentation for HLA 1.3
|
class DtIffPublisher: More...
Inheritance diagram for DtIffPublisher:
Collaboration diagram for DtIffPublisher:Public Types | |
| typedef DtIffStateRepository *(* | DtStateRepCreator )() |
| Function prototype for functions that create DtEntityStateRepositories. More... | |
Public Member Functions | |
| DtIffPublisher (DtIffStateRepository *stateRepToUse, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0) | |
| Constructor – State Rep Must have the NavaidsSysType set. More... | |
| DtIffPublisher (DtIffAtcNavaidsSysType type, DtExerciseConn *conn, DtIffAtcNavaidsSysName systemName, DtEntityIdentifier entityId, DtVector32 relativePosition=DtVector32::zero(), std::vector< DtModeType > enabledModes={DtMode1, DtMode2, DtMode3A, DtMode3C, DtMode5, DtModeS, DtTCAS}, const char *name=0, const DtDDMRegionSet *regionSetToUse=0) | |
| Constructor – State Rep Must have the NavaidsSysType set Accepts enableMode parameters to specify which modes are enabled for a given system. More... | |
| DtIffPublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0) | |
| Constructor. More... | |
| DtIffPublisher (DtIffAtcNavaidsSysType type, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0) | |
| Constructor. More... | |
| DtIffPublisher (DtHlaObjectWithStateRep *obj, DtExerciseConn *conn) | |
| Constructor that creates a publisher for an existing DtHlaObject. More... | |
| virtual | ~DtIffPublisher () |
| destructor More... | |
| virtual bool | tick () |
| Tick the publisher, returns true if data is sent. More... | |
| virtual DtIffStateRepository * | iffStateRep () |
| Returns a pointer to the IffStateRepository - through which you can set current state information. More... | |
| virtual DtIffStateRepository * | isr () |
| Synonym for iffStateRep() More... | |
Public Member Functions inherited from DtObjectPublisher | |
| DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0) | |
| Constructor. More... | |
| virtual | ~DtObjectPublisher () |
| Destructor. More... | |
| virtual void | setHlaObject (const char *className, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0) |
| A DtObjectPublisher is not capable of communicating data through the RTI until setHlaObject is called. More... | |
| virtual void | setHlaObject (RTI::ObjectClassHandle hand, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0) |
| This version takes a classHandle and optional object name, and creates the DtHlaObject for you. More... | |
| virtual void | setHlaObject (DtHlaObjectWithStateRep *obj, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0) |
| This version takes an existing DtHlaObject, and uses it. More... | |
| virtual void | detachHlaObject () |
| Detach HLA object - bringing the DtObjectPublisher back to the state it was in before setHlaObject was called. More... | |
| virtual DtStateRepository * | stateRep () |
| Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More... | |
| virtual DtStateRepository * | sr () |
| Synonym for stateRep(). More... | |
| virtual DtStateRepository * | approximateRemoteStateRep () |
| Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More... | |
| virtual DtHlaStateDecoder * | decoder () |
| Returns a pointer to the Decoder being used to decode state messages that we send back into the asSeenByRemote SR. More... | |
| virtual DtHlaStateEncoder * | encoder () |
| Returns a pointer to the Encoder being used to encode current state into an outgoing message. More... | |
| virtual DtHlaObjectWithStateRep * | hlaObject () |
| Get the object's hlaObject. More... | |
| virtual DtExerciseConn * | exerciseConn () |
| Get our exercise connection. More... | |
| virtual const DtObjectId & | id () const |
| Get the object's local identifier. More... | |
| virtual const DtObjectId & | objectId () const |
| Get the object's local identifier. More... | |
| virtual const DtObjectId & | localId () const |
| Get the object's local identifier. More... | |
| virtual const DtString & | name () const |
| Get the object's name. More... | |
| virtual const DtGlobalObjectDesignator & | globalId () const |
| Get the HLA object's global object designator - the object name in RTI1.3.3, but the objectId in RTI1.0.3. More... | |
| virtual void | forceUpdate () |
| Specify a set of attributes that should be included in the ahvps the next time tick is called, even if they would not otherwise need to be sent. More... | |
| virtual void | forceUpdate (const RTI::AttributeHandleSet &set) |
| virtual bool | parallelTick () |
| Tick (update) this object in parallel threads. More... | |
| virtual void | setDeleteObjInDtorFlag (bool onOff) |
| Set/Get a flag that determines whether to try to delete the HLA object that we represent, upon destruction of this DtObjectPublisher. More... | |
| virtual bool | deleteObjInDtorFlag () const |
| virtual const DtDDMRegionSet & | publishingRegions () const |
| virtual void | addRegion (DtDDMRegionSP regionToAdd) |
| Adds the specified region to the set of publishing regions, and calls associateRegionForUpdates on the RTI Ambassador. More... | |
| virtual void | removeRegion (DtDDMRegionSP regionToRemove) |
| Removes the specified region from the set of publishing regions, and calls unassociateRegionForUpdates on the RTI Ambassador. More... | |
| virtual void | setUpdateRateWarningThreshold (unsigned short updatesPerSecond) |
| Sets & overrides the default (static) updates per second for a specific instance If a negative integer is passed to it, it will use the difference of the max value of an unsigned short and the absolute value of the negative integer. More... | |
| virtual unsigned short | updateRateWarningThreshold () const |
| Returns the value of the overridden rate warning threshold. More... | |
| virtual void | checkForUpdateRateWarning () |
| Helper function that determines whether or not to trigger a spam warning. More... | |
| DtObjectPublisher (DtExerciseConn *conn, const char *name=0) | |
| These constructors and init functions are obsolete, but are here for backwards compatibility with pre-3.4 releases. More... | |
| void | init (RTI::ObjectClassHandle hand, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0) |
| void | init (const char *className, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0) |
Static Public Member Functions | |
| static DtStateRepCreator | setStateRepCreator (DtStateRepCreator creator) |
| Give us a function to be used for creating SRs. More... | |
Static Public Member Functions inherited from DtObjectPublisher | |
| static void | removeObjectCb (DtHlaObject *obj, void *pub) |
| Callback to be called when our underlying DtHlaObject goes away. More... | |
| static void | setDfltUpdateRateWarningThreshold (unsigned short updatesPerSecond) |
| Sets the default (static) updates per second for any instance. More... | |
| static unsigned short | dfltUpdateRateWarningThreshold () |
| Return the value of theDfltUpdateRateWarningThreshold. More... | |
Protected Member Functions | |
| DtIffPublisher (const char *name=0, const DtDDMRegionSet *regionSetToUse=0) | |
| Constructor which does not include the DtExerciseConn and does not register the HLA object. More... | |
| DtIffPublisher (const DtIffPublisher &orig) | |
| copy constructor – not implemented More... | |
| DtIffPublisher & | operator= (const DtIffPublisher &orig) |
| assignment operator – not implemented More... | |
| const char * | objectClassNameFromType (DtIffAtcNavaidsSysType type) |
| Non-virtual since called from constructor. More... | |
| virtual void | initIffDataPublishers (DtExerciseConn *conn, const char *name, const DtDDMRegionSet *regionSetToUse, DtIffAtcNavaidsSysType type, std::vector< DtModeType > *enabledModesPtr=0) |
| Creates IFFData publishers. More... | |
Protected Member Functions inherited from DtObjectPublisher | |
| DtObjectPublisher (DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0) | |
| Constructor which does not include the DtExerciseConn. More... | |
| virtual void | setExerciseConn (DtExerciseConn *conn) |
| Allows the DtExerciseConn to be set after initial publisher creation. More... | |
| virtual void | processRemoveObject (DtHlaObject *obj) |
| Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away. More... | |
Protected Attributes | |
| DtMode1Publisher * | myMode1Publisher |
| DtMode2Publisher * | myMode2Publisher |
| DtMode3APublisher * | myMode3APublisher |
| DtMode3CPublisher * | myMode3CPublisher |
| DtMode4Publisher * | myMode4Publisher |
| DtMode5Publisher * | myMode5Publisher |
| DtModeSPublisher * | myModeSPublisher |
| DtTCASDataPublisher * | myTCASDataPublisher |
| DtSovietPublisher * | mySovietPublisher |
| DtRRBPublisher * | myRRBPublisher |
| std::map< DtModeType, std::wstring > | myReservedDataNames |
Protected Attributes inherited from DtObjectPublisher | |
| DtExerciseConn * | myExConn |
| DtHlaObjectWithStateRep * | myHlaObj |
| DtStateRepository * | myStateRep |
| DtStateRepository * | myAsSeenByRemote |
| DtHlaStateEncoder * | myEncoder |
| DtHlaStateDecoder * | myDecoder |
| DtObjectId | myObjectId |
| bool | myOkToDeleteStateRepFlag |
| DtString | myName |
| bool | myDeleteObjInDtorFlag |
| DtDDMRegionSet | myPublishingRegions |
| DtTime | myRealTimeLastUpdate |
| DtTime | myLastSpamCheckTime |
| unsigned short | myNumberOfUpdatesPerSecond |
| unsigned short | myUpdateRateWarningThreshold |
| bool | myCanWarn |
Static Protected Attributes | |
| static DtStateRepCreator | theStateRepCreator |
Static Protected Attributes inherited from DtObjectPublisher | |
| static unsigned short | theDfltUpdateRateWarningThreshold |
| Static member that holds the value of the number of updates to be sent to trigger a spam warning. More... | |
class DtIffPublisher:
Instances of IffPublisher are used for local or source simulations of "Iff" objects. The publisher sends data to the network when necessary. This class is derived from DtObjectPublisher, which does most of the work. The derived class mostly exists to provide type safety, and to configure the base object.
| typedef DtIffStateRepository*(* DtIffPublisher::DtStateRepCreator)() |
Function prototype for functions that create DtEntityStateRepositories.
| DtIffPublisher::DtIffPublisher | ( | DtIffStateRepository * | stateRepToUse, |
| DtExerciseConn * | conn, | ||
| const char * | name = 0, |
||
| const DtDDMRegionSet * | regionSetToUse = 0 |
||
| ) |
Constructor – State Rep Must have the NavaidsSysType set.
| DtIffPublisher::DtIffPublisher | ( | DtIffAtcNavaidsSysType | type, |
| DtExerciseConn * | conn, | ||
| DtIffAtcNavaidsSysName | systemName, | ||
| DtEntityIdentifier | entityId, | ||
| DtVector32 | relativePosition = DtVector32::zero(), |
||
| std::vector< DtModeType > | enabledModes = {DtMode1, DtMode2, DtMode3A, DtMode3C, DtMode5, DtModeS, DtTCAS}, |
||
| const char * | name = 0, |
||
| const DtDDMRegionSet * | regionSetToUse = 0 |
||
| ) |
Constructor – State Rep Must have the NavaidsSysType set Accepts enableMode parameters to specify which modes are enabled for a given system.
It also accepts the IFF System Type, indicating publishing of transponder, interrogator or other, etc
| DtIffPublisher::DtIffPublisher | ( | RTI::ObjectClassHandle | h, |
| DtExerciseConn * | conn, | ||
| const char * | name = 0, |
||
| const DtDDMRegionSet * | regionSetToUse = 0 |
||
| ) |
Constructor.
| DtIffPublisher::DtIffPublisher | ( | DtIffAtcNavaidsSysType | type, |
| DtExerciseConn * | conn, | ||
| const char * | name = 0, |
||
| const DtDDMRegionSet * | regionSetToUse = 0 |
||
| ) |
Constructor.
| DtIffPublisher::DtIffPublisher | ( | DtHlaObjectWithStateRep * | obj, |
| DtExerciseConn * | conn | ||
| ) |
Constructor that creates a publisher for an existing DtHlaObject.
(DtHlaObjectWithStateRep is derived from DtHlaObject.) Typically used in conjunction with ownership management, when you want to take ownership and begin updating some attributes of an object that you have already discovered.
|
virtual |
destructor
|
protected |
Constructor which does not include the DtExerciseConn and does not register the HLA object.
This is typically not desired, but may be useful in certain cases when a derived publisher wants to better control how the object is published.
|
protected |
copy constructor – not implemented
|
inlinevirtual |
Returns a pointer to the IffStateRepository - through which you can set current state information.
References DtObjectPublisher::myStateRep.
|
protectedvirtual |
Creates IFFData publishers.
| conn | The exercise connection |
| name | A user specifies name for the publisher |
| regionSetToUse | The DtDDMRegion |
| type | The IFF System Type, indicating publishing of transponder, interrogator or other, etc |
|
inlinevirtual |
Synonym for iffStateRep()
References DtObjectPublisher::myStateRep.
|
protected |
Non-virtual since called from constructor.
If you don't like the default mapping between entity type and object class, just pass the object class handle you want to the constructor.
|
protected |
assignment operator – not implemented
|
static |
Give us a function to be used for creating SRs.
|
virtual |
Tick the publisher, returns true if data is sent.
Reimplemented from DtObjectPublisher.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
staticprotected |