DtDataQueryInteraction Class Reference

class DtDataQueryInteraction: More...

Inheritance diagram for DtDataQueryInteraction:

Collaboration diagram for DtDataQueryInteraction:

List of all members.

Public Member Functions
	DtDataQueryInteraction ()
	default constructor
virtual	~DtDataQueryInteraction ()
	destructor
	DtDataQueryInteraction (const DtDataQueryInteraction &orig)
	copy constructor
DtDataQueryInteraction &	operator= (const DtDataQueryInteraction &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	setRequestId (unsigned long id)
	Set/Get request ID.
virtual unsigned long	requestId () const
virtual void	setTimeInterval (DtTime seconds)
	Set/Get the time interval.
virtual DtTime	timeInterval () const
virtual void	initDatumIds (unsigned long numFixedFields, unsigned long numVarFields)
	Initialize fixed and variable datum ids.
virtual void	setNumFixedFields (unsigned long numFixedFields)
	Set/Get fixed fields.
virtual unsigned long	numFixedFields () const
virtual int	setFixedDatumId (DtU32 index, DtDatumParam id)
virtual DtDatumParam	fixedDatumId (DtU32 index) const
virtual void	setNumVarFields (unsigned long numVarFields)
	Set/Get variable fields.
virtual unsigned long	numVarFields () const
virtual int	setVarDatumId (DtU32 index, DtDatumParam id)
virtual DtDatumParam	varDatumId (DtU32 index) const
virtual void	setFixedDatumIDs (const void *data, DtInt32 numBytes)
	Set/Get the fixed field's memory block all at once.
virtual const void *	fixedDatumIDs () const
virtual void	setVariableDatumIDs (const void *data, DtInt32 numBytes)
	Set/Get the variable field's memory block all at once.
virtual const void *	variableDatumIDs () const
virtual void	changeFixedSize (DtU32 newSize)
	Change size of fixed or variable fields.
virtual void	changeVariableSize (DtU32 newSize)
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 DtDataQueryInteraction.
static void	addCallback (DtExerciseConn *conn, DtDataQueryInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtDataQueryInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt
DtU32	myRequestId
DtNetTimeStamp	myTimeInterval
DtNetU32 *	myFixedDatumIDs
DtNetU32 *	myVariableDatumIDs
DtU32	myNumFixed
DtU32	myNumVar

---

Detailed Description

class DtDataQueryInteraction:

Instances of DtDataQueryInteraction are used to represent DataQuery Interactions in the RPR FOM.

---

Constructor & Destructor Documentation

DtDataQueryInteraction::DtDataQueryInteraction

(

)

default constructor

virtual DtDataQueryInteraction::~DtDataQueryInteraction

(

)

[virtual]

destructor

DtDataQueryInteraction::DtDataQueryInteraction

(

const DtDataQueryInteraction &

orig

)

copy constructor

---

Member Function Documentation

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

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

virtual void DtDataQueryInteraction::changeFixedSize

(

DtU32

newSize

)

[virtual]

Change size of fixed or variable fields.

virtual void DtDataQueryInteraction::changeVariableSize

(

DtU32

newSize

)

[virtual]

static DtInteraction* DtDataQueryInteraction::create

(

)

[static]

Create a DtDataQueryInteraction.

Caller is responsible for deletion.

virtual DtDatumParam DtDataQueryInteraction::fixedDatumId

(

DtU32

index

)

const [virtual]

virtual const void* DtDataQueryInteraction::fixedDatumIDs

(

)

const [virtual]

virtual void DtDataQueryInteraction::initDatumIds	(	unsigned long	numFixedFields,
		unsigned long	numVarFields
	)		[virtual]

Initialize fixed and variable datum ids.

virtual const char* DtDataQueryInteraction::name

(

)

const [virtual]

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

Implements DtInteraction.

virtual unsigned long DtDataQueryInteraction::numFixedFields

(

)

const [virtual]

virtual unsigned long DtDataQueryInteraction::numVarFields

(

)

const [virtual]

DtDataQueryInteraction& DtDataQueryInteraction::operator=

(

const DtDataQueryInteraction &

orig

)

assignment operator

virtual void DtDataQueryInteraction::printData

(

)

const [virtual]

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtDataQueryInteraction::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual const DtEntityIdentifier& DtDataQueryInteraction::receiverId

(

)

const [virtual]

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

virtual unsigned long DtDataQueryInteraction::requestId

(

)

const [virtual]

virtual const DtEntityIdentifier& DtDataQueryInteraction::senderId

(

)

const [virtual]

virtual int DtDataQueryInteraction::setFixedDatumId	(	DtU32	index,
		DtDatumParam	id
	)		[virtual]

virtual void DtDataQueryInteraction::setFixedDatumIDs	(	const void *	data,
		DtInt32	numBytes
	)		[virtual]

Set/Get the fixed field's memory block all at once.

virtual void DtDataQueryInteraction::setNumFixedFields

(

unsigned long

numFixedFields

)

[virtual]

Set/Get fixed fields.

virtual void DtDataQueryInteraction::setNumVarFields

(

unsigned long

numVarFields

)

[virtual]

Set/Get variable fields.

virtual void DtDataQueryInteraction::setReceiverId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get receiver ID.

virtual void DtDataQueryInteraction::setRequestId

(

unsigned long

id

)

[virtual]

Set/Get request ID.

virtual void DtDataQueryInteraction::setSenderId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get sender ID.

virtual void DtDataQueryInteraction::setTimeInterval

(

DtTime

seconds

)

[virtual]

Set/Get the time interval.

virtual int DtDataQueryInteraction::setVarDatumId	(	DtU32	index,
		DtDatumParam	id
	)		[virtual]

virtual void DtDataQueryInteraction::setVariableDatumIDs	(	const void *	data,
		DtInt32	numBytes
	)		[virtual]

Set/Get the variable field's memory block all at once.

virtual DtTime DtDataQueryInteraction::timeInterval

(

)

const [virtual]

virtual DtDatumParam DtDataQueryInteraction::varDatumId

(

DtU32

index

)

const [virtual]

virtual const void* DtDataQueryInteraction::variableDatumIDs

(

)

const [virtual]

---

Member Data Documentation

DtNetU32* DtDataQueryInteraction::myFixedDatumIDs [protected]

DtU32 DtDataQueryInteraction::myNumFixed [protected]

DtU32 DtDataQueryInteraction::myNumVar [protected]

DtEntityIdentifier DtDataQueryInteraction::myOrigEnt [protected]

DtEntityIdentifier DtDataQueryInteraction::myReceiveEnt [protected]

DtU32 DtDataQueryInteraction::myRequestId [protected]

DtNetTimeStamp DtDataQueryInteraction::myTimeInterval [protected]

DtNetU32* DtDataQueryInteraction::myVariableDatumIDs [protected]

---

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

• hDataQInter.h