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

class DtServiceRequestInteraction: More...

+ Inheritance diagram for DtServiceRequestInteraction:
+ Collaboration diagram for DtServiceRequestInteraction:

List of all members.

Public Member Functions

 DtServiceRequestInteraction ()
 default constructor
virtual ~DtServiceRequestInteraction ()
 destructor
 DtServiceRequestInteraction (const DtServiceRequestInteraction &orig)
 copy constructor
DtServiceRequestInteractionoperator= (const DtServiceRequestInteraction &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 setRequestingId (const DtGlobalObjectDesignator &requester)
 Set/Get the receiving object.
virtual const
DtGlobalObjectDesignator
requestingId () const
virtual void setServicingId (const DtGlobalObjectDesignator &servicer)
 Set/Get the repairing object.
virtual const
DtGlobalObjectDesignator
servicingId () const
virtual void setServiceType (DtServiceType type)
 Set/Get the service type.
virtual DtServiceType serviceType () const
virtual void setSupplies (const void *data, int numBytes)
 Set/Get the supplies memory block all at once.
virtual const void * supplies () const
virtual void setNumSupplyTypes (int numTypes)
 Supporting functions to get/set the Supply Array.
virtual int numSupplyTypes () const
virtual void setNthSupply (int supplyIndex, const DtEntityType &supply, float quantity, int *retCode=NULL)
virtual const DtEntityTypenthSupply (int supplyIndex, float *quantity=NULL, int *retCode=NULL) const
virtual float supplyQuantity (const DtEntityType &supply) const
virtual void changeSuppliesSize (int newSize)
virtual int indexInBounds (int ind) 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 DtServiceRequestInteraction.
static void addCallback (DtExerciseConn *conn, DtServiceRequestInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
 Add (register)/Remove (deregister) function to be called when interaction occurs.
static void removeCallback (DtExerciseConn *conn, DtServiceRequestInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes

DtGlobalObjectDesignator myRequestingObject
DtGlobalObjectDesignator myServicingObject
DtServiceType myServiceType
int myNumSupplyTypes
DtNetSupplyQuantitymySupplies
DtEntityType myNthSupply

Detailed Description

class DtServiceRequestInteraction:

Instances of DtServiceRequestInteraction are used to represent ServiceRequest Interactions in the RPR FOM.


Constructor & Destructor Documentation

default constructor

destructor

copy constructor


Member Function Documentation

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

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

virtual void DtServiceRequestInteraction::changeSuppliesSize ( int  newSize) [virtual]

Create a DtServiceRequestInteraction.

Caller is responsible for deletion.

virtual int DtServiceRequestInteraction::indexInBounds ( int  ind) const [virtual]
const char * DtServiceRequestInteraction::name ( ) const [inline, virtual]

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

Implements DtInteraction.

virtual const DtEntityType& DtServiceRequestInteraction::nthSupply ( int  supplyIndex,
float *  quantity = NULL,
int *  retCode = NULL 
) const [virtual]
virtual int DtServiceRequestInteraction::numSupplyTypes ( ) const [virtual]
DtServiceRequestInteraction& DtServiceRequestInteraction::operator= ( const DtServiceRequestInteraction orig)

assignment operator

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

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

static void DtServiceRequestInteraction::removeCallback ( DtExerciseConn conn,
DtServiceRequestInteractionCb  cb,
void *  usr,
DtDDMRegionSP  region = DtDDMRegionSP() 
) [static]

References myRequestingObject.

References myServiceType.

References myServicingObject.

virtual void DtServiceRequestInteraction::setNthSupply ( int  supplyIndex,
const DtEntityType supply,
float  quantity,
int *  retCode = NULL 
) [virtual]
virtual void DtServiceRequestInteraction::setNumSupplyTypes ( int  numTypes) [virtual]

Supporting functions to get/set the Supply Array.

void DtServiceRequestInteraction::setRequestingId ( const DtGlobalObjectDesignator requester) [inline, virtual]

Set/Get the receiving object.

References myRequestingObject.

Set/Get the service type.

References myServiceType.

void DtServiceRequestInteraction::setServicingId ( const DtGlobalObjectDesignator servicer) [inline, virtual]

Set/Get the repairing object.

References myServicingObject.

virtual void DtServiceRequestInteraction::setSupplies ( const void *  data,
int  numBytes 
) [virtual]

Set/Get the supplies memory block all at once.

virtual const void* DtServiceRequestInteraction::supplies ( ) const [virtual]
virtual float DtServiceRequestInteraction::supplyQuantity ( const DtEntityType supply) const [virtual]

Member Data Documentation

Referenced by requestingId(), and setRequestingId().

Referenced by serviceType(), and setServiceType().

Referenced by servicingId(), and setServicingId().


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)