 |
VR-Link API Documentation for HLA 4
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Link API Documentation for HLA 4
|
Instances of DtReplyInteraction are used to store state data for IFFEmission.Reply interactions. More...
Inheritance diagram for DtReplyInteraction: Collaboration diagram for DtReplyInteraction:Public Member Functions | |
| DtReplyInteraction () | |
| Constructor. More... | |
| virtual | ~DtReplyInteraction () |
| Destructor. More... | |
| DtReplyInteraction (const DtReplyInteraction &orig) | |
| Copy constructor. More... | |
| DtReplyInteraction & | operator= (const DtReplyInteraction &orig) |
| Assignment operator. More... | |
| virtual void | printData () const |
| Print the interaction's data. More... | |
| virtual void | printDataToStream (std::ostream &stream) const |
| Print the interaction's data to the specified stream. More... | |
| virtual void | setReplyAmplification (const DtReplyAmplification &val) |
| ReplyAmplification mutator. More... | |
| virtual const DtReplyAmplification & | replyAmplification () const |
| ReplyAmplification accessor. More... | |
| virtual void | setModeSDAPSource (const DtModeSDAPSourceStruct &val) |
| ModeSDAPSource mutator. More... | |
| virtual const DtModeSDAPSourceStruct & | modeSDAPSource () const |
| ModeSDAPSource accessor. More... | |
| virtual void | setLethal (bool val) |
| Lethal mutator. More... | |
| virtual bool | isLethal () const |
| Lethal accessor. More... | |
| virtual const char * | name () const |
| Name of the interaction. (Not necessarily the ClassName from the FOM.) More... | |
| Public Member Functions inherited from DtIFFEmissionInteraction | |
| DtIFFEmissionInteraction () | |
| Constructor. More... | |
| virtual | ~DtIFFEmissionInteraction () |
| Destructor. More... | |
| DtIFFEmissionInteraction (const DtIFFEmissionInteraction &orig) | |
| Copy constructor. More... | |
| DtIFFEmissionInteraction & | operator= (const DtIFFEmissionInteraction &orig) |
| Assignment operator. More... | |
| virtual void | setIFFSystemIdentifier (const DtGlobalObjectDesignator &val) |
| The identification of the IFFSystem object emitting this IFF electromagnetic signal or composite set of signals. More... | |
| virtual const DtGlobalObjectDesignator & | IFFSystemIdentifier () const |
| IFFSystemIdentifier accessor. More... | |
| virtual void | setSimulationMode (DtPduStatusIFFSimulationMode mode) |
| Set/Get the Simulation Mode of the Change/Options record. More... | |
| virtual bool | simulationMode () const |
| virtual bool | isInteractiveCapable () const |
| Get Interactive Capable field from the Change/Options record where 1=Capable and 0=Not Capable Setting the Simulation Mode will set the Interactive Capable field accordingly. More... | |
| virtual void | setTransmissionIndicator (const DtTransmissionIndicator &val) |
| Indication whether this is an interrogation, a reply to an interrogation, or a squitter transmission. More... | |
| virtual const DtTransmissionIndicator & | transmissionIndicator () const |
| TransmissionIndicator accessor. More... | |
| virtual void | setInterrogatingId (const DtGlobalObjectDesignator &val) |
| The object that is interrogating another object. More... | |
| virtual const DtGlobalObjectDesignator & | interrogatingId () const |
| InterrogatingObjectIdentifier accessor. More... | |
| virtual void | setInterrogatedId (const DtGlobalObjectDesignator &val) |
| The object to which the interrogation is being directed InterrogatedObjectIdentifier mutator. More... | |
| virtual const DtGlobalObjectDesignator & | interrogatedId () const |
| InterrogatedObjectIdentifier accessor. More... | |
| virtual void | setInteractiveEventId (const DtEventId &val) |
| Used to associate a reply to an interrogation. More... | |
| virtual const DtEventId & | interactiveEventId () const |
| InteractiveEventIdentifier accessor. More... | |
| virtual void | setInterrogatedModes (const DtInterrogatedModesStruct &val) |
| The modes being interrogated. More... | |
| virtual const DtInterrogatedModesStruct & | interrogatedModes () const |
| InterrogatedModes accessor. More... | |
| virtual const DtInterrogatedModesStruct & | interrogatedModesStruct () const |
| virtual void | setReportingSimulation (const DtFederateIdentifierStruct &val) |
| The simulation publishing this IFF emission. More... | |
| virtual const DtFederateIdentifierStruct & | reportingSimulation () const |
| ReportingSimulation accessor. More... | |
| virtual void | setDataCommunicationsSpecificInformation (const DtIFFLayerSpecificInformationEnum8 &val) |
| Specific information for data communications (DIS IFF PDU layer 5) that varies by System Type. More... | |
| virtual const DtIFFLayerSpecificInformationEnum8 & | dataCommunicationsSpecificInformation () const |
| DataCommunicationsSpecificInformation accessor. More... | |
| virtual void | setInteractiveIFFData (const DtIFFDataVariantStructArray &val) |
| Additional interactive IFF data. More... | |
| virtual const DtIFFDataVariantStructArray & | interactiveIFFData () const |
| InteractiveIFFData accessor. 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 | printDataToString (DtString &buff) const |
| Print the interaction's data to the string provided. 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 | setTransportationTypeHandle (RTI::TransportationTypeHandle transportationTypeHandle) |
| HLA 4 added an argument that provides the TransportationTypeHandle. More... | |
| virtual RTI::TransportationTypeHandle | transportationTypeHandle () const |
| The transportation type handle. 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 DtReplyInteraction. More... | |
| static void | addCallback (DtExerciseConn *conn, DtReplyInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Add (register)/Remove (deregister) function to be called when interaction occurs. More... | |
| static void | removeCallback (DtExerciseConn *conn, DtReplyInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Static Public Member Functions inherited from DtIFFEmissionInteraction | |
| static DtInteraction * | create () |
| Create a DtIFFEmissionInteraction. More... | |
| static void | addCallback (DtExerciseConn *conn, DtIFFEmissionInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Add (register)/Remove (deregister) function to be called when interaction occurs. More... | |
| static void | removeCallback (DtExerciseConn *conn, DtIFFEmissionInteractionCb 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()) |
Protected Member Functions | |
| virtual const char * | interactionClassToUse (DtExerciseConn *exConn) const |
| Returns the FOM interaction class name to use. More... | |
| 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... | |
| Protected Member Functions inherited from DtInteractionWithEncDec | |
| 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 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... | |
Additional Inherited Members | |
| Static Protected Attributes inherited from DtInteraction | |
| static bool | theTagIsAsciiTime |
Instances of DtReplyInteraction are used to store state data for IFFEmission.Reply interactions.
| DtReplyInteraction::DtReplyInteraction | ( | ) |
Constructor.
|
virtual |
Destructor.
| DtReplyInteraction::DtReplyInteraction | ( | const DtReplyInteraction & | orig | ) |
Copy constructor.
|
static |
Add (register)/Remove (deregister) function to be called when interaction occurs.
|
static |
Create a DtReplyInteraction.
Caller is responsible for deletion.
|
protectedvirtual |
Called by decoderToUse to obtain a new'ed decoder.
Default implementation is to ask the FOM Mapper. The object is automatically deleted in the interaction's destructor.
Reimplemented from DtIFFEmissionInteraction.
|
protectedvirtual |
Called by encoderToUse to obtain a new'ed encoder.
Default implementation is to ask the FOM Mapper. The object is automatically deleted in the interaction's destructor.
Reimplemented from DtIFFEmissionInteraction.
|
protectedvirtual |
Returns the FOM interaction class name to use.
Default implementation is to ask the fomMapper.
Reimplemented from DtIFFEmissionInteraction.
|
virtual |
Lethal accessor.
|
virtual |
ModeSDAPSource accessor.
|
inlinevirtual |
Name of the interaction. (Not necessarily the ClassName from the FOM.)
Reimplemented from DtIFFEmissionInteraction.
| DtReplyInteraction& DtReplyInteraction::operator= | ( | const DtReplyInteraction & | orig | ) |
Assignment operator.
|
virtual |
Print the interaction's data.
Reimplemented from DtIFFEmissionInteraction.
|
virtual |
Print the interaction's data to the specified stream.
Reimplemented from DtIFFEmissionInteraction.
|
static |
|
virtual |
ReplyAmplification accessor.
|
virtual |
Lethal mutator.
|
virtual |
ModeSDAPSource mutator.
|
virtual |
ReplyAmplification mutator.
|
protected |
|
protected |
|
protected |
