VR-Link API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtRemoveObjectResultInter Class Reference

class DtRemoveObjectResultInter: More...

+ Inheritance diagram for DtRemoveObjectResultInter:
+ Collaboration diagram for DtRemoveObjectResultInter:

Public Member Functions

 DtRemoveObjectResultInter ()
 default constructor
virtual ~DtRemoveObjectResultInter ()
 destructor
 DtRemoveObjectResultInter (const DtRemoveObjectResultInter &orig)
 copy constructor
DtRemoveObjectResultInteroperator= (const DtRemoveObjectResultInter &orig)
 assignment operator
virtual void printData () const
 Print the interaction's data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Print the interaction's data to the specified stream.
virtual void setRemoveObjectResult (DtRemoveObjectResult result)
 Set/Get create object result.
virtual DtRemoveObjectResult removeObjectResult () const
virtual void setRequestId (DtU32 id)
 Set/Get request ID.
virtual DtU32 requestId () const
virtual const char * name () const
 Name of the interaction. (Not necessarily the ClassName from the FOM.)
- Public Member Functions inherited from DtInteractionWithEncDec
 DtInteractionWithEncDec ()
 default constructor
virtual ~DtInteractionWithEncDec ()
 destructor
 DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
 copy constructor
DtInteractionWithEncDecoperator= (const DtInteractionWithEncDec &orig)
 assignment operator
virtual void setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
 Sets the interaction's ExerciseConn and class descriptor.
virtual const
RTI::ParameterHandleValuePairSet & 
phvps () const
 Get the parameter handle value pair set for the interaction.
virtual void setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
 Set contents from a parameter handle value pair set.
virtual void useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
 Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.
virtual DtInteractionEncoderencoder () const
 Return the encoder we are using.
virtual DtInteractionDecoderdecoder () const
 Return the decoder we are using.
virtual void setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
 Set the Parameter with the given handle.
virtual const char * getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
 Get a pointer to Parameter value for the Parameter with the given handle.
virtual void setParameterByName (const DtString &name, const char *attrValue, unsigned size)
 Set the Parameter with the given name.
virtual const char * getParameterByName (const DtString &name, unsigned &size) const
 Get a pointer to Parameter value for the Parameter with the given name.
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor
virtual ~DtInteraction ()
 destructor
 DtInteraction (const DtInteraction &orig)
 copy constructor
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator
virtual RTI::InteractionClassHandle interactionClassHandle () const
 Get the interaction class handle. Returns 0 if no classDesc.
virtual char * interactionClassName () const
 Get the interaction class name. Returns NULL if no classDesc.
virtual int numParameters () const
 Get the number of parameters. Returns 0 if no classDesc.
virtual bool neededByFederation () const
 Returns true if the interaction class is needed by the federation false otherwise.
virtual void print () const
 Print the interaction's host rep data, including header.
virtual void printToStream (std::ostream &stream) const
 Print the interaction to a stream.
virtual void printHeader () const
 Print the header info.
virtual void printHeaderToStream (std::ostream &stream) const
 Print the header info to a stream.
virtual void printDataToString (DtString &buff) const
 Print the interaction's data to the string provided.
virtual void printParams (bool withHex) const
 Print the header followed by the interaction's parameters.
virtual void printParamsToStream (std::ostream &stream, bool withHex) const
 Print the header followed by the interaction's parameters to a stream.
virtual DtExerciseConnexerciseConn () const
 Get the current exercise connection.
virtual DtInterClassDescclassDesc () const
 Get the current class descriptor we're using for this interaction.
virtual bool customTagSet () const
 Get whether a custom tag has been set on the interaction or not.
virtual void setCustomTag (const DtString &a_tag)
 Set the user-defined tag.
virtual void setTag (const DtString &tag)
 Set the user-defined tag.
virtual const DtStringtag () const
 Get the user-defined tag.
virtual const RTI::Region * conveyedRegion () const
 Get & Set the conveyed region of the reflected state message.
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.
virtual RTI::FederateHandle producingFederateHandle () const
 The producing federate handle. Invalid if not enabled (or could be from MOM).
virtual const DtStringproducingFederateName () const
 The producing federate handle is used to get the federate name (cached after first access).
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the time of validity of the message, and whether this represents relative or absolute time.
virtual DtTime timeStamp () const
 Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp.
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.
virtual void setFedTime (const RTI::FedTime &ft)
 This is used for TSO interactions.
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.
virtual void setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
 Get/Set the EventRetractionHandle.
virtual RTI::EventRetractionHandle eventRetractionHandle () const
 Get the event retraction handle. For more info see setEventRetractionHandle.

Static Public Member Functions

static DtInteractioncreate ()
 Create a DtRemoveObjectResultInter.
static void addCallback (DtExerciseConn *conn, DtRemoveObjectResultInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs.
static void removeCallback (DtExerciseConn *conn, DtRemoveObjectResultInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes

DtRemoveObjectResult myRemoveObjectResult
DtU32 myRequestId
- Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecodermyDecoder
DtInteractionEncodermyEncoder
DtInteractionRep * myData
std::map< RTI::ParameterHandle,
DtGenericParameterInfo * > 
myParametersByHandle
 parameters by handle.
- Protected Attributes inherited from DtInteraction
DtInterClassDescmyClassDesc
DtExerciseConnmyExConn
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

- Protected Member Functions inherited from DtInteractionWithEncDec
virtual DtInteractionDecodercreateDecoder (DtExerciseConn *exConn) const
 Called by decoderToUse to obtain a new'ed decoder.
virtual DtInteractionEncodercreateEncoder (DtExerciseConn *exConn) const
 Called by encoderToUse to obtain a new'ed encoder.
virtual DtInteractionDecoderdecoderToUse (DtExerciseConn *exConn) const
 Returns a decoder to use for decoding the interaction.
virtual DtInteractionEncoderencoderToUse (DtExerciseConn *exConn) const
 Returns an encoder to use for encoding the interaction.
- Static Protected Attributes inherited from DtInteraction
static bool theTagIsAsciiTime

Detailed Description

class DtRemoveObjectResultInter:

Instances of DtRemoveObjectResultInter are used to represent RemoveObjectResult Interactions in the RPR FOM.

Constructor & Destructor Documentation

DtRemoveObjectResultInter::DtRemoveObjectResultInter ( )

default constructor

virtual DtRemoveObjectResultInter::~DtRemoveObjectResultInter ( )
virtual

destructor

DtRemoveObjectResultInter::DtRemoveObjectResultInter ( const DtRemoveObjectResultInter orig)

copy constructor

Member Function Documentation

static void DtRemoveObjectResultInter::addCallback ( DtExerciseConn conn,
DtRemoveObjectResultInterCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static

Add (register)/Remove (deregister) function to be called when interaction occurs.

static DtInteraction* DtRemoveObjectResultInter::create ( )
static

Create a DtRemoveObjectResultInter.

Caller is responsible for deletion.

const char * DtRemoveObjectResultInter::name ( ) const
inlinevirtual

Name of the interaction. (Not necessarily the ClassName from the FOM.)

Implements DtInteraction.

DtRemoveObjectResultInter& DtRemoveObjectResultInter::operator= ( const DtRemoveObjectResultInter orig)

assignment operator

virtual void DtRemoveObjectResultInter::printData ( ) const
virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtRemoveObjectResultInter::printDataToStream ( std::ostream &  stream) const
virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

static void DtRemoveObjectResultInter::removeCallback ( DtExerciseConn conn,
DtRemoveObjectResultInterCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static
DtRemoveObjectResult DtRemoveObjectResultInter::removeObjectResult ( ) const
inlinevirtual

References myRemoveObjectResult.

DtU32 DtRemoveObjectResultInter::requestId ( ) const
inlinevirtual

References myRequestId.

void DtRemoveObjectResultInter::setRemoveObjectResult ( DtRemoveObjectResult  result)
inlinevirtual

Set/Get create object result.

References myRemoveObjectResult.

void DtRemoveObjectResultInter::setRequestId ( DtU32  id)
inlinevirtual

Set/Get request ID.

References myRequestId.

Member Data Documentation

DtRemoveObjectResult DtRemoveObjectResultInter::myRemoveObjectResult
protected
DtU32 DtRemoveObjectResultInter::myRequestId
protected

Referenced by requestId(), and setRequestId().


The documentation for this class was generated from the following file:

Document ID: Generated on Thu Feb 22 04:26:36 EST 2018 from SVN revision 186468
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)