![]() |
VR-Link API Documentation for HLA 4
|
class DtUnknownInteraction: More...
Inheritance diagram for DtUnknownInteraction:
Collaboration diagram for DtUnknownInteraction:Public Member Functions | |
| DtUnknownInteraction () | |
| default constructor More... | |
| DtUnknownInteraction (RTI::InteractionClassHandle handle, const RTI::ParameterHandleValuePairSet &pvList) | |
| constructor More... | |
| virtual | ~DtUnknownInteraction () |
| destructor More... | |
| DtUnknownInteraction (const DtUnknownInteraction &orig) | |
| copy constructor More... | |
| DtUnknownInteraction & | operator= (const DtUnknownInteraction &orig) |
| assignment operator 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) |
| Decode into this object from parameter value list. More... | |
| virtual void | setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc) |
| Sets the interaction's ExerciseConn and class descriptor. More... | |
| virtual void | printData () const |
| Just prints the parameters. More... | |
| virtual const char * | name () const |
| Name of the interaction. 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 | printDataToStream (std::ostream &stream) const |
| Print the interaction's data to the 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 | 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 DtUnknownInteraction. More... | |
| static void | addCallback (RTI::InteractionClassHandle handle, DtExerciseConn *conn, DtUnknownInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP()) |
| Add (register)/Remove (deregister) function to be called when interaction with specified class handle occurs. More... | |
| static void | removeCallback (RTI::InteractionClassHandle handle, DtExerciseConn *conn, DtUnknownInteractionCb 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 | |
| void | internalSetFromPhvps (const RTI::ParameterHandleValuePairSet &pvList) |
| Decode into this object from parameter value list. 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... | |
Protected Attributes | |
| RTI::ParameterHandleValuePairSet * | myParams |
| RTI::InteractionClassHandle | myHandle |
Protected Attributes inherited from DtInteraction | |
| DtInterClassDesc * | myClassDesc |
| DtExerciseConn * | myExConn |
| DtTime | myTime |
| DtTimeStampType | myTimeType |
| DtString | myTag |
| RTI::ParameterHandleValuePairSet * | myPvList |
| int | myPvListMaxSize |
| RTI::FedTime * | myFedTime |
| RTI::EventRetractionHandle | myRetractionHandle |
| const RTI::Region * | myConveyedRegion |
| bool | myCustomTagSet |
Additional Inherited Members | |
Static Protected Attributes inherited from DtInteraction | |
| static bool | theTagIsAsciiTime |
class DtUnknownInteraction:
Instances of DtUnknownInteraction are used to represent Interactions for which there is no derived DtInteraction.
| DtUnknownInteraction::DtUnknownInteraction | ( | ) |
default constructor
| DtUnknownInteraction::DtUnknownInteraction | ( | RTI::InteractionClassHandle | handle, |
| const RTI::ParameterHandleValuePairSet & | pvList | ||
| ) |
constructor
|
virtual |
destructor
| DtUnknownInteraction::DtUnknownInteraction | ( | const DtUnknownInteraction & | orig | ) |
copy constructor
|
static |
Add (register)/Remove (deregister) function to be called when interaction with specified class handle occurs.
|
static |
Create a DtUnknownInteraction.
Caller is responsible for deletion.
|
protected |
Decode into this object from parameter value list.
Non-virtual, since meant to be called from ctor.
|
virtual |
Name of the interaction.
Implements DtInteraction.
| DtUnknownInteraction& DtUnknownInteraction::operator= | ( | const DtUnknownInteraction & | orig | ) |
assignment operator
|
virtual |
Get the parameter handle value pair set for the interaction.
Implements DtInteraction.
|
virtual |
Just prints the parameters.
Reimplemented from DtInteraction.
|
static |
|
virtual |
Sets the interaction's ExerciseConn and class descriptor.
If classDesc is NULL, we use the classDesc associated with the handle on which the interaction was created. Without being told what ExConn or class descriptor to use, many of the HLA-specific functions won't work properly.
Reimplemented from DtInteraction.
|
virtual |
Decode into this object from parameter value list.
Implements DtInteraction.
|
protected |
|
protected |