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

class DtRemoveObjectRequestInter: More...

+ Inheritance diagram for DtRemoveObjectRequestInter:
+ Collaboration diagram for DtRemoveObjectRequestInter:

List of all members.

Public Member Functions

 DtRemoveObjectRequestInter ()
 default constructor
virtual ~DtRemoveObjectRequestInter ()
 destructor
 DtRemoveObjectRequestInter (const DtRemoveObjectRequestInter &orig)
 copy constructor
DtRemoveObjectRequestInteroperator= (const DtRemoveObjectRequestInter &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 const
DtGlobalObjectDesignatorList
objectIDs () const
 Return the Object ID list.
virtual
DtGlobalObjectDesignatorList
objectIDs ()
virtual void setNumIds (DtU8 numIds)
 Set/Get number of IDs.
virtual DtU8 numIds () const
virtual void setNthObjectId (DtInt32 idIndex, const DtGlobalObjectDesignator &id)
 Set/Get the nth ObjectId.
virtual const
DtGlobalObjectDesignator
nthObjectId (DtInt32 idIndex) 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.)

Static Public Member Functions

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

Protected Attributes

DtGlobalObjectDesignatorList myObjectList
DtGlobalObjectDesignator myNthId
DtU32 myRequestId

Detailed Description

class DtRemoveObjectRequestInter:

Instances of DtRemoveObjectRequestInter are used to represent RemoveObjectRequest Interactions in the RPR FOM.


Constructor & Destructor Documentation

default constructor

destructor

copy constructor


Member Function Documentation

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

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

Create a DtRemoveObjectRequestInter.

Caller is responsible for deletion.

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

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

Implements DtInteraction.

virtual const DtGlobalObjectDesignator& DtRemoveObjectRequestInter::nthObjectId ( DtInt32  idIndex) const [virtual]
virtual DtU8 DtRemoveObjectRequestInter::numIds ( ) const [virtual]

Return the Object ID list.

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

assignment operator

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

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

static void DtRemoveObjectRequestInter::removeCallback ( DtExerciseConn conn,
DtRemoveObjectRequestInterCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]
DtU32 DtRemoveObjectRequestInter::requestId ( ) const [inline, virtual]

References myRequestId.

virtual void DtRemoveObjectRequestInter::setNthObjectId ( DtInt32  idIndex,
const DtGlobalObjectDesignator id 
) [virtual]

Set/Get the nth ObjectId.

virtual void DtRemoveObjectRequestInter::setNumIds ( DtU8  numIds) [virtual]

Set/Get number of IDs.

void DtRemoveObjectRequestInter::setRequestId ( DtU32  id) [inline, virtual]

Set/Get request ID.

References myRequestId.


Member Data Documentation

Referenced by requestId(), and setRequestId().


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)