VR-Link API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Attributes
DtRecordRInteraction Class Reference

class DtRecordRInteraction: More...

+ Inheritance diagram for DtRecordRInteraction:
+ Collaboration diagram for DtRecordRInteraction:

List of all members.

Public Member Functions

 DtRecordRInteraction ()
 default constructor
 DtRecordRInteraction (const DtRecordRInteraction &other)
 copy constructor
virtual ~DtRecordRInteraction ()
 destructor
DtRecordRInteractionoperator= (const DtRecordRInteraction &other)
 assignment operator
virtual void printData () const
 Print out interaction's data to DtInfo.
virtual void printDataToStream (std::ostream &stream) const
 Print the interaction's data to the specified stream.
virtual void setOriginatingEntityID (const DtEntityIdentifier &entity)
 Set/Get originator ID.
virtual const DtEntityIdentifieroriginatingEntityID () const
virtual void setReceivingEntityID (const DtEntityIdentifier &entity)
 Set/Get receiver ID.
virtual const DtEntityIdentifier receivingEntityID () const
virtual void setRequestID (DtU32 id)
 Set/Get request ID.
virtual DtU32 requestID () const
virtual void setReqRelService (enum DtRequiredReliabilityService service)
 Set/Get required reliability service.
virtual
DtRequiredReliabilityService 
reqRelService () const
virtual void setEventType (DtEventType type)
 Set/Get the event type.
virtual DtEventType eventType () const
virtual void setResponseSerialNumber (DtU32 num)
 Set/Get the response serial number.
virtual DtU32 responseSerialNumber () const
virtual void setNumRecordSets (DtU32 number)
 Set/Get the number of record sets in this list.
virtual DtU32 numRecordSets () const
virtual bool setRecordSet (int index, const DtRecordSet &set)
 Set/Get the record set at the specified index.
virtual const DtRecordSetrecordSet (int index, bool *valid=NULL)
virtual bool getRecordSet (int index, DtRecordSet &recSet) const
 a separate Get Function For backwards Compatibility
virtual const DtRecordSetListrecordSetList () const
 They exist for the mapper to use for conversion to net data.
virtual DtRecordSetListrecordSetList ()
virtual const char * name () const
 name of the interaction.

Static Public Member Functions

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

Protected Attributes

DtEntityIdentifier myOriginatingEnt
DtEntityIdentifier myReceivingEnt
DtU32 myRequestId
DtEventType myEventType
DtU32 myResponceSerialNumber
DtRequiredReliabilityService myRequiredReliabilityService
DtRecordSetList myRecordSetList

Detailed Description

class DtRecordRInteraction:

Instances of DtRecordRInteraction are used to represent RecordR Interactions in the FOM.


Constructor & Destructor Documentation

default constructor

copy constructor

destructor


Member Function Documentation

static void DtRecordRInteraction::addCallback ( DtExerciseConn conn,
DtRecordRInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]

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

Create a DtRecordRInteraction.

Caller is responsible for the deletion

DtEventType DtRecordRInteraction::eventType ( ) const [inline, virtual]

References myEventType.

virtual bool DtRecordRInteraction::getRecordSet ( int  index,
DtRecordSet recSet 
) const [virtual]

a separate Get Function For backwards Compatibility

const char * DtRecordRInteraction::name ( ) const [inline, virtual]

name of the interaction.

(Not necessarily the ClassName from the FOM)

Implements DtInteraction.

virtual DtU32 DtRecordRInteraction::numRecordSets ( ) const [virtual]
DtRecordRInteraction& DtRecordRInteraction::operator= ( const DtRecordRInteraction other)

assignment operator

References myOriginatingEnt.

virtual void DtRecordRInteraction::printData ( ) const [virtual]

Print out interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtRecordRInteraction::printDataToStream ( std::ostream &  stream) const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

References myReceivingEnt.

virtual const DtRecordSet& DtRecordRInteraction::recordSet ( int  index,
bool *  valid = NULL 
) [virtual]
const DtRecordSetList & DtRecordRInteraction::recordSetList ( ) const [inline, virtual]

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

References myRecordSetList.

References myRecordSetList.

static void DtRecordRInteraction::removeCallback ( DtExerciseConn conn,
DtRecordRInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]
DtU32 DtRecordRInteraction::requestID ( ) const [inline, virtual]

References myRequestId.

void DtRecordRInteraction::setEventType ( DtEventType  type) [inline, virtual]

Set/Get the event type.

References myEventType.

virtual void DtRecordRInteraction::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 DtRecordRInteraction::setOriginatingEntityID ( const DtEntityIdentifier entity) [inline, virtual]

Set/Get originator ID.

void DtRecordRInteraction::setReceivingEntityID ( const DtEntityIdentifier entity) [inline, virtual]

Set/Get receiver ID.

References myReceivingEnt.

virtual bool DtRecordRInteraction::setRecordSet ( int  index,
const DtRecordSet set 
) [virtual]

Set/Get the record set at the specified index.

RecordSetPDU used getRecordSet, here we use recordSet

void DtRecordRInteraction::setReqRelService ( enum DtRequiredReliabilityService  service) [inline, virtual]

Set/Get required reliability service.

References myRequiredReliabilityService.

void DtRecordRInteraction::setRequestID ( DtU32  id) [inline, virtual]

Set/Get request ID.

References myRequestId.

void DtRecordRInteraction::setResponseSerialNumber ( DtU32  num) [inline, virtual]

Set/Get the response serial number.

References myResponceSerialNumber.


Member Data Documentation

Referenced by eventType(), and setEventType().

Referenced by originatingEntityID().

Referenced by recordSetList().

Referenced by requestID(), and setRequestID().

Referenced by reqRelService(), and setReqRelService().


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)