![]() |
VR-Link API Documentation for HLA Evolved
|
Because this example adds a concept that did not already exist in VR-Link's DtFireInteraction class, we create this subclass of DtFireInteraction that adds the concept of temperature. More...
Inheritance diagram for MyFireInteraction:
Collaboration diagram for MyFireInteraction:Public Member Functions | |
| virtual void | setTemperature (float temp) |
| Set the temperature. More... | |
| virtual float | temperature () const |
| The temperature. More... | |
| virtual void | printData () const |
| Virtual function override: print the interaction's data. More... | |
Public Member Functions inherited from DtFireInteraction | |
| DtFireInteraction () | |
| default constructor More... | |
| virtual | ~DtFireInteraction () |
| destructor More... | |
| DtFireInteraction (const DtFireInteraction &orig) | |
| copy constructor More... | |
| DtFireInteraction & | operator= (const DtFireInteraction &orig) |
| assignment operator More... | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print the interaction's data to the specified stream. More... | |
| virtual void | printDataToString (DtString &buffer) const |
| Put the interaction's data into the given buffer. More... | |
| virtual void | setAttackerId (const DtGlobalObjectDesignator &id) |
| Set/Get the attacker identifier. More... | |
| virtual const DtGlobalObjectDesignator & | attackerId () const |
| virtual void | setTargetId (const DtGlobalObjectDesignator &id) |
| Set/Get the target identifier. More... | |
| virtual const DtGlobalObjectDesignator & | targetId () const |
| virtual void | setMunitionId (const DtGlobalObjectDesignator &id) |
| Set/Get the munition identifier. More... | |
| virtual const DtGlobalObjectDesignator & | munitionId () const |
| virtual void | setEventId (const DtEventID &id) |
| Set/Get the event id. More... | |
| virtual const DtEventID & | eventId () const |
| virtual void | setFireMissionIndex (unsigned long i) |
| Set/Get the fire mission index. More... | |
| virtual unsigned long | fireMissionIndex () const |
| virtual void | setLocation (const DtVector &location) |
| Set/Get the location in world coordinates. More... | |
| virtual const DtVector & | location () const |
| virtual void | setVelocity (const DtVector32 &velocity) |
| Set/Get the velocity. More... | |
| virtual const DtVector32 & | velocity () const |
| virtual void | setRange (double range) |
| Set/Get the range. More... | |
| virtual double | range () const |
| virtual void | setFuseType (DtDetonatorFuze f) |
| Set/Get the detonator fuse type. More... | |
| virtual DtDetonatorFuze | fuseType () const |
| virtual void | setMunitionType (const DtEntityType &t) |
| Set/Get the munition type. More... | |
| virtual const DtEntityType & | munitionType () const |
| virtual void | setQuantity (int q) |
| Set/Get the quantity. More... | |
| virtual int | quantity () const |
| virtual void | setRate (int r) |
| Set/Get the rate. More... | |
| virtual int | rate () const |
| virtual void | setWarheadType (DtWarheadType t) |
| Set/Get the warhead type. More... | |
| virtual DtWarheadType | warheadType () const |
| virtual const char * | name () const |
| Name of the interaction. (Not necessarily the ClassName from the FOM.) More... | |
Public Member Functions inherited from DtInteractionWithEncDec | |
| DtInteractionWithEncDec () | |
| default constructor More... | |
| virtual | ~DtInteractionWithEncDec () |
| destructor More... | |
| DtInteractionWithEncDec (const DtInteractionWithEncDec &orig) | |
| copy constructor More... | |
| DtInteractionWithEncDec & | operator= (const DtInteractionWithEncDec &orig) |
| assignment operator More... | |
| virtual void | setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL) |
| Sets the interaction's ExerciseConn and class descriptor. More... | |
| virtual const RTI::ParameterHandleValuePairSet & | phvps () const |
| Get the parameter handle value pair set for the interaction. More... | |
| virtual void | setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList) |
| Set contents from a parameter handle value pair set. More... | |
| virtual void | useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data) |
| Specify an encoder, decoder, and interaction data repository to use in encoding and decoding. More... | |
| virtual DtInteractionEncoder * | encoder () const |
| Return the encoder we are using. More... | |
| virtual DtInteractionDecoder * | decoder () const |
| Return the decoder we are using. More... | |
| virtual void | setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size) |
| Set the Parameter with the given handle. More... | |
| virtual const char * | getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const |
| Get a pointer to Parameter value for the Parameter with the given handle. More... | |
| virtual void | setParameterByName (const DtString &name, const char *attrValue, unsigned size) |
| Set the Parameter with the given name. More... | |
| virtual const char * | getParameterByName (const DtString &name, unsigned &size) const |
| Get a pointer to Parameter value for the Parameter with the given name. More... | |
Public Member Functions inherited from DtInteraction | |
| DtInteraction () | |
| default constructor More... | |
| virtual | ~DtInteraction () |
| destructor More... | |
| DtInteraction (const DtInteraction &orig) | |
| copy constructor More... | |
| DtInteraction & | operator= (const DtInteraction &orig) |
| assignment operator More... | |
| virtual RTI::InteractionClassHandle | interactionClassHandle () const |
| Get the interaction class handle. Returns 0 if no classDesc. More... | |
| virtual char * | interactionClassName () const |
| Get the interaction class name. Returns NULL if no classDesc. More... | |
| virtual int | numParameters () const |
| Get the number of parameters. Returns 0 if no classDesc. More... | |
| virtual bool | neededByFederation () const |
| Returns true if the interaction class is needed by the federation false otherwise. More... | |
| virtual void | print () const |
| Print the interaction's host rep data, including header. More... | |
| virtual void | printToStream (std::ostream &stream) const |
| Print the interaction to a stream. More... | |
| virtual void | printHeader () const |
| Print the header info. More... | |
| virtual void | printHeaderToStream (std::ostream &stream) const |
| Print the header info to a stream. More... | |
| virtual void | printParams (bool withHex) const |
| Print the header followed by the interaction's parameters. More... | |
| virtual void | printParamsToStream (std::ostream &stream, bool withHex) const |
| Print the header followed by the interaction's parameters to a stream. More... | |
| virtual DtExerciseConn * | exerciseConn () const |
| Get the current exercise connection. More... | |
| virtual DtInterClassDesc * | classDesc () const |
| Get the current class descriptor we're using for this interaction. More... | |
| virtual bool | customTagSet () const |
| Get whether a custom tag has been set on the interaction or not. More... | |
| virtual void | setCustomTag (const DtString &a_tag) |
| Set the user-defined tag. More... | |
| virtual void | setTag (const DtString &tag) |
| Set the user-defined tag. More... | |
| virtual const DtString & | tag () const |
| Get the user-defined tag. More... | |
| virtual const RTI::Region * | conveyedRegion () const |
| Get & Set the conveyed region of the reflected state message. More... | |
| virtual void | setConveyedRegion (const RTI::Region *region) |
| virtual void | setProducingFederateHandle (RTI::FederateHandle federateHandle) |
| HLA Evolved added an argument that provides the FederateHandle of the federate that produced the interaction being received. More... | |
| virtual RTI::FederateHandle | producingFederateHandle () const |
| The producing federate handle. Invalid if not enabled (or could be from MOM). More... | |
| virtual const DtString & | producingFederateName () const |
| The producing federate handle is used to get the federate name (cached after first access). More... | |
| virtual void | setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative) |
| Set the time of validity of the message, and whether this represents relative or absolute time. More... | |
| virtual DtTime | timeStamp () const |
| Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp. More... | |
| virtual DtTimeStampType | timeStampType () const |
| Return the type of the time stamp. More... | |
| virtual DtTime | guessTimeValid (DtTime referenceTime) const |
| Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour. More... | |
| virtual void | setFedTime (const RTI::FedTime &ft) |
| This is used for TSO interactions. More... | |
| virtual const RTI::FedTime * | fedTime () const |
| When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set. More... | |
| virtual void | setEventRetractionHandle (const RTI::EventRetractionHandle &handle) |
| Get/Set the EventRetractionHandle. More... | |
| virtual RTI::EventRetractionHandle | eventRetractionHandle () const |
| Get the event retraction handle. For more info see setEventRetractionHandle. More... | |
Static Public Member Functions | |
| static DtInteraction * | create () |
| Create a MyFireInteraction. Caller is responsible for deletion. More... | |
Static Public Member Functions inherited from DtFireInteraction | |
| static DtInteraction * | create () |
| Create a DtFireInteraction. More... | |
| static void | addCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Add (register)/Remove (deregister) function to be called when interaction occurs. More... | |
| static void | removeCallback (DtExerciseConn *conn, DtFireInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
Static Public Member Functions inherited from DtInteraction | |
| static void | setTagIsAsciiTime (bool val) |
| Set/Get flag that tells us whether we're using the RPR FOM convention that the UserDefinedTag in updates and interactions represents a DIS-style timestamp. More... | |
| static bool | tagIsAsciiTime () |
| static void | addCallback (DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Register/Deregister callback function cb with conn, on all interaction class name (char*) contained in classes. More... | |
| static void | removeCallback (DtExerciseConn *conn, const std::vector< DtString > *classes, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| static void | addCallback (DtExerciseConn *conn, const char *className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Can be used instead of above for a single class. More... | |
| static void | removeCallback (DtExerciseConn *conn, const char *className, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
Additional Inherited Members | |
Protected Member Functions inherited from DtInteractionWithEncDec | |
| virtual DtInteractionDecoder * | createDecoder (DtExerciseConn *exConn) const |
| Called by decoderToUse to obtain a new'ed decoder. More... | |
| virtual DtInteractionEncoder * | createEncoder (DtExerciseConn *exConn) const |
| Called by encoderToUse to obtain a new'ed encoder. More... | |
| virtual DtInteractionDecoder * | decoderToUse (DtExerciseConn *exConn) const |
| Returns a decoder to use for decoding the interaction. More... | |
| virtual DtInteractionEncoder * | encoderToUse (DtExerciseConn *exConn) const |
| Returns an encoder to use for encoding the interaction. More... | |
Protected Member Functions inherited from DtInteraction | |
| virtual const char * | interactionClassToUse (DtExerciseConn *exConn) const |
| Returns the FOM interaction class name to use. More... | |
| virtual RTI::ParameterHandleValuePairSet * | privPvList () const |
| Returns a pointer to a private pvList that can be used as a return value by phvps. More... | |
| DtInteraction * | self () const |
| Get rid of const-ness on the "this" pointer in order to access non-const functions from const member functions (such as simple accessors). More... | |
Static Protected Attributes inherited from DtInteraction | |
| static bool | theTagIsAsciiTime |
Because this example adds a concept that did not already exist in VR-Link's DtFireInteraction class, we create this subclass of DtFireInteraction that adds the concept of temperature.
|
inlinestatic |
Create a MyFireInteraction. Caller is responsible for deletion.
|
inlinevirtual |
Virtual function override: print the interaction's data.
Reimplemented from DtFireInteraction.
References DtFireInteraction::printData(), and temperature().
|
inlinevirtual |
Set the temperature.
References myTemperature.
|
inlinevirtual |
|
protected |
Referenced by setTemperature(), and temperature().