DtCommentInteraction Class Reference

Instances of DtCommentInteraction are used to represent Comment Interactions in the RPR FOM. More...

Inheritance diagram for DtCommentInteraction:

Collaboration diagram for DtCommentInteraction:

List of all members.

Public Member Functions
	DtCommentInteraction ()
	default constructor
virtual	~DtCommentInteraction ()
	destructor
	DtCommentInteraction (const DtCommentInteraction &orig)
	copy constructor
DtCommentInteraction &	operator= (const DtCommentInteraction &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	setSenderId (const DtEntityIdentifier &id)
	Set/Get sender ID.
virtual const DtEntityIdentifier &	senderId () const
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set/Get receiver ID.
virtual const DtEntityIdentifier &	receiverId () const
virtual void	setComment (const char *message, int size)
	Set/Get the comment; warning: inspector returns a readable text string.
virtual const char *	comment () 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 DtCommentInteraction.
static void	addCallback (DtExerciseConn *conn, DtCommentInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtCommentInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt

---

Detailed Description

Instances of DtCommentInteraction are used to represent Comment Interactions in the RPR FOM.

The variable datum record is accessed through DtInteractionWithData member functions.

---

Constructor & Destructor Documentation

DtCommentInteraction::DtCommentInteraction

(

)

default constructor

virtual DtCommentInteraction::~DtCommentInteraction

(

)

[virtual]

destructor

DtCommentInteraction::DtCommentInteraction

(

const DtCommentInteraction &

orig

)

copy constructor

---

Member Function Documentation

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

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

virtual const char* DtCommentInteraction::comment

(

)

const [virtual]

static DtInteraction* DtCommentInteraction::create

(

)

[static]

Create a DtCommentInteraction.

Caller is responsible for deletion.

virtual const char* DtCommentInteraction::name

(

)

const [virtual]

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

Implements DtInteraction.

DtCommentInteraction& DtCommentInteraction::operator=

(

const DtCommentInteraction &

orig

)

assignment operator

virtual void DtCommentInteraction::printData

(

)

const [virtual]

Print the interaction's data to DtInfo.

Reimplemented from DtInteractionWithData.

virtual void DtCommentInteraction::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteractionWithData.

virtual const DtEntityIdentifier& DtCommentInteraction::receiverId

(

)

const [virtual]

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

virtual const DtEntityIdentifier& DtCommentInteraction::senderId

(

)

const [virtual]

virtual void DtCommentInteraction::setComment	(	const char *	message,
		int	size
	)		[virtual]

Set/Get the comment; warning: inspector returns a readable text string.

Use DtInteractionWithData member functions to get non-string comments. Comments are sent in the first Var Message Record.

virtual void DtCommentInteraction::setReceiverId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get receiver ID.

virtual void DtCommentInteraction::setSenderId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get sender ID.

---

Member Data Documentation

DtEntityIdentifier DtCommentInteraction::myOrigEnt [protected]

DtEntityIdentifier DtCommentInteraction::myReceiveEnt [protected]

---

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

• hCommentInter.h