VR-Link API Documentation for HLA 1.3
 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
DtSetRecordInteraction Class Reference
+ Inheritance diagram for DtSetRecordInteraction:
+ Collaboration diagram for DtSetRecordInteraction:

Public Member Functions

 DtSetRecordInteraction ()
 
 DtSetRecordInteraction (const DtSetRecordInteraction &other)
 copy Constructor More...
 
virtual ~DtSetRecordInteraction ()
 destructor More...
 
DtSetRecordInteractionoperator= (const DtSetRecordInteraction &other)
 assignment operator More...
 
virtual void printData () const
 Print out interaction's data. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print out the interaction's data to a stream. More...
 
virtual void setOriginatingEntityID (const DtEntityIdentifier &entity)
 Set/Get originator ID. More...
 
virtual const DtEntityIdentifieroriginatingEntityID () const
 
virtual void setReceivingEntityID (const DtEntityIdentifier &entity)
 Set/Get receiver ID. More...
 
virtual const DtEntityIdentifier receivingEntityID () const
 
virtual void setRequestID (DtU32 id)
 Set/Get request ID. More...
 
virtual DtU32 requestID () const
 
virtual void setReqRelService (enum DtRequiredReliabilityService service)
 Set/Get required reliability service. More...
 
virtual
DtRequiredReliabilityService 
reqRelService () const
 
virtual void setNumRecordSets (DtU32 number)
 Set/Get the number of record sets in this list. More...
 
virtual DtU32 numRecordSets () const
 
virtual bool setRecordSet (int index, const DtRecordSet &set)
 Set/Get the record set at the specified index. More...
 
virtual const DtRecordSetrecordSet (int index, bool *valid=NULL)
 
virtual bool getRecordSet (int index, DtRecordSet &recSet) const
 a separate Get Function For backwards compatibility More...
 
virtual const DtRecordSetListrecordSetList () const
 They exist for the mapper to use for conversion to net data. More...
 
virtual DtRecordSetListrecordSetList ()
 
virtual const char * name () const
 name of the interaction. More...
 
- Public Member Functions inherited from DtInteractionWithEncDec
 DtInteractionWithEncDec ()
 default constructor More...
 
virtual ~DtInteractionWithEncDec ()
 destructor More...
 
 DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
 copy constructor More...
 
DtInteractionWithEncDecoperator= (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 DtInteractionEncoderencoder () const
 Return the encoder we are using. More...
 
virtual DtInteractionDecoderdecoder () 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...
 
DtInteractionoperator= (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 DtExerciseConnexerciseConn () const
 Get the current exercise connection. More...
 
virtual DtInterClassDescclassDesc () 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 DtStringtag () 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 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 DtInteractioncreate ()
 Create a DtSetRecordInteraction. More...
 
static void addCallback (DtExerciseConn *conn, DtSetRecordInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register) / remove (deregister) function to be called when interaction occurs. More...
 
static void removeCallback (DtExerciseConn *conn, DtSetRecordInteractionCb 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 Attributes

DtEntityIdentifier myOriginatingEnt
 
DtEntityIdentifier myReceivingEnt
 
DtU32 myRequestId
 
DtRequiredReliabilityService myRequiredReliabilityService
 
DtRecordSetList myRecordSetList
 
- Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecodermyDecoder
 
DtInteractionEncodermyEncoder
 
DtInteractionRep * myData
 
std::map< RTI::ParameterHandle,
DtGenericParameterInfo * > 
myParametersByHandle
 parameters by handle. More...
 
- 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. More...
 
virtual DtInteractionEncodercreateEncoder (DtExerciseConn *exConn) const
 Called by encoderToUse to obtain a new'ed encoder. More...
 
virtual DtInteractionDecoderdecoderToUse (DtExerciseConn *exConn) const
 Returns a decoder to use for decoding the interaction. More...
 
virtual DtInteractionEncoderencoderToUse (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...
 
DtInteractionself () 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
 

Constructor & Destructor Documentation

DtSetRecordInteraction::DtSetRecordInteraction ( )
DtSetRecordInteraction::DtSetRecordInteraction ( const DtSetRecordInteraction other)

copy Constructor

virtual DtSetRecordInteraction::~DtSetRecordInteraction ( )
virtual

destructor

Member Function Documentation

static void DtSetRecordInteraction::addCallback ( DtExerciseConn conn,
DtSetRecordInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static

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

static DtInteraction* DtSetRecordInteraction::create ( )
static

Create a DtSetRecordInteraction.

Caller is responsible for the deletion

virtual bool DtSetRecordInteraction::getRecordSet ( int  index,
DtRecordSet recSet 
) const
virtual

a separate Get Function For backwards compatibility

const char * DtSetRecordInteraction::name ( ) const
inlinevirtual

name of the interaction.

(Not necessarily the ClassName from the FOM)

Implements DtInteraction.

virtual DtU32 DtSetRecordInteraction::numRecordSets ( ) const
virtual
DtSetRecordInteraction& DtSetRecordInteraction::operator= ( const DtSetRecordInteraction other)

assignment operator

const DtEntityIdentifier & DtSetRecordInteraction::originatingEntityID ( ) const
inlinevirtual

References myOriginatingEnt.

virtual void DtSetRecordInteraction::printData ( ) const
virtual

Print out interaction's data.

Reimplemented from DtInteraction.

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

Print out the interaction's data to a stream.

Reimplemented from DtInteraction.

const DtEntityIdentifier DtSetRecordInteraction::receivingEntityID ( ) const
inlinevirtual

References myReceivingEnt.

virtual const DtRecordSet& DtSetRecordInteraction::recordSet ( int  index,
bool valid = NULL 
)
virtual
const DtRecordSetList & DtSetRecordInteraction::recordSetList ( ) const
inlinevirtual

They exist for the mapper to use for conversion to net data.

References myRecordSetList.

DtRecordSetList * DtSetRecordInteraction::recordSetList ( )
inlinevirtual

References myRecordSetList.

static void DtSetRecordInteraction::removeCallback ( DtExerciseConn conn,
DtSetRecordInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
)
static
DtRequiredReliabilityService DtSetRecordInteraction::reqRelService ( ) const
inlinevirtual
DtU32 DtSetRecordInteraction::requestID ( ) const
inlinevirtual

References myRequestId.

virtual void DtSetRecordInteraction::setNumRecordSets ( DtU32  number)
virtual

Set/Get the number of record sets in this list.

When the number of record sets are changed, old records are not preserved.

void DtSetRecordInteraction::setOriginatingEntityID ( const DtEntityIdentifier entity)
inlinevirtual

Set/Get originator ID.

void DtSetRecordInteraction::setReceivingEntityID ( const DtEntityIdentifier entity)
inlinevirtual

Set/Get receiver ID.

References myReceivingEnt.

virtual bool DtSetRecordInteraction::setRecordSet ( int  index,
const DtRecordSet set 
)
virtual

Set/Get the record set at the specified index.

RecordSetPDU used getRecordSet, here we use recordSet

void DtSetRecordInteraction::setReqRelService ( enum DtRequiredReliabilityService  service)
inlinevirtual

Set/Get required reliability service.

References myRequiredReliabilityService.

void DtSetRecordInteraction::setRequestID ( DtU32  id)
inlinevirtual

Set/Get request ID.

References myRequestId.

Member Data Documentation

DtEntityIdentifier DtSetRecordInteraction::myOriginatingEnt
protected

Referenced by originatingEntityID().

DtEntityIdentifier DtSetRecordInteraction::myReceivingEnt
protected
DtRecordSetList DtSetRecordInteraction::myRecordSetList
protected

Referenced by recordSetList().

DtU32 DtSetRecordInteraction::myRequestId
protected

Referenced by requestID(), and setRequestID().

DtRequiredReliabilityService DtSetRecordInteraction::myRequiredReliabilityService
protected

Referenced by reqRelService(), and setReqRelService().


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

Document ID: Generated on Thu Sep 19 02:12:35 EDT 2024 from SVN revision 269601
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)