DtActionRequestToObjInter Class Reference

Instances of DtActionRequestToObjInter are used to represent ActionRequestToObject Interactions in the RPR FOM. More...

Inheritance diagram for DtActionRequestToObjInter:

Collaboration diagram for DtActionRequestToObjInter:

List of all members.

Public Member Functions
	DtActionRequestToObjInter ()
	default constructor
virtual	~DtActionRequestToObjInter ()
	destructor
	DtActionRequestToObjInter (const DtActionRequestToObjInter &orig)
	copy constructor
DtActionRequestToObjInter &	operator= (const DtActionRequestToObjInter &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	setAction (DtActionId action)
	Set/Get action enum.
virtual DtActionId	action () const
virtual const char *	name () const
	Name of the interaction (Not necessarily the ClassName from the FOM).
Static Public Member Functions
static DtInteraction *	create ()
	Create a DtActionRequestToObjInter.
static void	addCallback (DtExerciseConn *conn, DtActionRequestToObjInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtActionRequestToObjInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtGlobalObjectDesignatorList	myObjectList
DtGlobalObjectDesignator	myNthId
DtActionId	myAction

---

Detailed Description

Instances of DtActionRequestToObjInter are used to represent ActionRequestToObject Interactions in the RPR FOM.

---

Constructor & Destructor Documentation

DtActionRequestToObjInter::DtActionRequestToObjInter

(

)

default constructor

virtual DtActionRequestToObjInter::~DtActionRequestToObjInter

(

)

[virtual]

destructor

DtActionRequestToObjInter::DtActionRequestToObjInter

(

const DtActionRequestToObjInter &

orig

)

copy constructor

---

Member Function Documentation

virtual DtActionId DtActionRequestToObjInter::action

(

)

const [virtual]

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

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

static DtInteraction* DtActionRequestToObjInter::create

(

)

[static]

Create a DtActionRequestToObjInter.

Caller is responsible for deletion.

virtual const char* DtActionRequestToObjInter::name

(

)

const [virtual]

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

Implements DtInteraction.

virtual const DtGlobalObjectDesignator& DtActionRequestToObjInter::nthObjectId

(

DtInt32

idIndex

)

const [virtual]

virtual DtU8 DtActionRequestToObjInter::numIds

(

)

const [virtual]

virtual const DtGlobalObjectDesignatorList& DtActionRequestToObjInter::objectIDs

(

)

const [virtual]

Return the Object ID list.

virtual DtGlobalObjectDesignatorList* DtActionRequestToObjInter::objectIDs

(

)

[virtual]

DtActionRequestToObjInter& DtActionRequestToObjInter::operator=

(

const DtActionRequestToObjInter &

orig

)

assignment operator

virtual void DtActionRequestToObjInter::printData

(

)

const [virtual]

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtActionRequestToObjInter::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

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

virtual void DtActionRequestToObjInter::setAction

(

DtActionId

action

)

[virtual]

Set/Get action enum.

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

Set/Get the nth ObjectId.

virtual void DtActionRequestToObjInter::setNumIds

(

DtU8

numIds

)

[virtual]

Set/Get number of IDs.

---

Member Data Documentation

DtActionId DtActionRequestToObjInter::myAction [protected]

DtGlobalObjectDesignator DtActionRequestToObjInter::myNthId [protected]

DtGlobalObjectDesignatorList DtActionRequestToObjInter::myObjectList [protected]

---

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

• hActReqObjInt.h