DtTransferControlInteraction Class Reference

class DtTransferControlInteraction: More...

Inheritance diagram for DtTransferControlInteraction:

Collaboration diagram for DtTransferControlInteraction:

List of all members.

Public Member Functions
	DtTransferControlInteraction ()
	default constructor
	DtTransferControlInteraction (const DtTransferControlInteraction &other)
	copy constructor
virtual	~DtTransferControlInteraction ()
	destructor
DtTransferControlInteraction &	operator= (const DtTransferControlInteraction &other)
	assignment operator
virtual void	printData () const
	Print out interaction's data to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print out interaction's data to the specified stream.
virtual void	setOriginatingEntityID (const DtEntityIdentifier &entity)
	Set/Get originator ID.
virtual const DtEntityIdentifier &	originatingEntityID () const
virtual void	setReceivingEntityID (const DtEntityIdentifier &entity)
	Set/Get receiver ID.
virtual const DtEntityIdentifier	receivingEntityID () const
virtual void	setRequestID (DtU32 id)
	Set/Get request ID.
virtual DtU32	requestID () const
virtual void	setTransferType (const DtTransferType type)
	Set/Get the transfer Type.
virtual const DtTransferType	transferType () const
virtual void	setTransferredEntityID (const DtGlobalObjectDesignator &)
	Set/Get the transferEntity.
virtual const DtGlobalObjectDesignator &	transferredEntityID () const
virtual void	setNumRecordSets (DtU32 number)
	Set/Get the number of record sets in this list.
virtual DtU32	numRecordSets () const
virtual bool	setRecordSet (int index, const DtRecordSet &set)
	Set/Get the record set at the specified index.
virtual const DtRecordSet &	recordSet (int index, bool *valid=NULL)
virtual bool	getRecordSet (int index, DtRecordSet &recSet) const
	a separate Get Function For backwards Compatibility
virtual const DtRecordSetList &	recordSetList () const
	They exist for the mapper to use for conversion to net data.
virtual DtRecordSetList *	recordSetList ()
virtual const char *	name () const
	name of the interaction.
Static Public Member Functions
static DtInteraction *	create ()
	Create a DtTransferControlInteraction.
static void	addCallback (DtExerciseConn *conn, DtTransferControlInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register) / remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtTransferControlInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtEntityIdentifier	myOriginatingEnt
DtEntityIdentifier	myReceivingEnt
DtU32	myRequestId
DtGlobalObjectDesignator	myTransferEntity
DtTransferType	myTransferType
DtRecordSetList	myRecordSetList

---

Detailed Description

class DtTransferControlInteraction:

Instances of DtTransferControl are used to represent TransfterControl Interactions in the FOM.

---

Constructor & Destructor Documentation

DtTransferControlInteraction::DtTransferControlInteraction

(

)

default constructor

DtTransferControlInteraction::DtTransferControlInteraction

(

const DtTransferControlInteraction &

other

)

copy constructor

virtual DtTransferControlInteraction::~DtTransferControlInteraction

(

)

[virtual]

destructor

---

Member Function Documentation

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

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

static DtInteraction* DtTransferControlInteraction::create

(

)

[static]

Create a DtTransferControlInteraction.

Caller is responsible for the deletion

virtual bool DtTransferControlInteraction::getRecordSet	(	int	index,
		DtRecordSet &	recSet
	)		const [virtual]

a separate Get Function For backwards Compatibility

const char * DtTransferControlInteraction::name

(

)

const [inline, virtual]

name of the interaction.

(Not necessarily the ClassName from the FOM)

Implements DtInteraction.

virtual DtU32 DtTransferControlInteraction::numRecordSets

(

)

const [virtual]

DtTransferControlInteraction& DtTransferControlInteraction::operator=

(

const DtTransferControlInteraction &

other

)

assignment operator

const DtEntityIdentifier & DtTransferControlInteraction::originatingEntityID

(

)

const [inline, virtual]

References myOriginatingEnt.

virtual void DtTransferControlInteraction::printData

(

)

const [virtual]

Print out interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtTransferControlInteraction::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print out interaction's data to the specified stream.

Reimplemented from DtInteraction.

const DtEntityIdentifier DtTransferControlInteraction::receivingEntityID

(

)

const [inline, virtual]

References myReceivingEnt.

virtual const DtRecordSet& DtTransferControlInteraction::recordSet	(	int	index,
		bool *	valid = NULL
	)		[virtual]

const DtRecordSetList & DtTransferControlInteraction::recordSetList

(

)

const [inline, virtual]

They exist for the mapper to use for conversion to net data.

References myRecordSetList.

DtRecordSetList * DtTransferControlInteraction::recordSetList

(

)

[inline, virtual]

References myRecordSetList.

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

DtU32 DtTransferControlInteraction::requestID

(

)

const [inline, virtual]

References myRequestId.

virtual void DtTransferControlInteraction::setNumRecordSets

(

DtU32

number

)

[virtual]

Set/Get the number of record sets in this list.

When the number of record sets are changed, old records are not preserved.

void DtTransferControlInteraction::setOriginatingEntityID

(

const DtEntityIdentifier &

entity

)

[inline, virtual]

Set/Get originator ID.

void DtTransferControlInteraction::setReceivingEntityID

(

const DtEntityIdentifier &

entity

)

[inline, virtual]

Set/Get receiver ID.

References myReceivingEnt.

virtual bool DtTransferControlInteraction::setRecordSet	(	int	index,
		const DtRecordSet &	set
	)		[virtual]

Set/Get the record set at the specified index.

RecordSetPDU used getRecordSet, here we use recordSet

void DtTransferControlInteraction::setRequestID

(

DtU32

id

)

[inline, virtual]

Set/Get request ID.

References myRequestId.

void DtTransferControlInteraction::setTransferredEntityID

(

const DtGlobalObjectDesignator &

id

)

[inline, virtual]

Set/Get the transferEntity.

References myTransferEntity.

void DtTransferControlInteraction::setTransferType

(

const DtTransferType

type

)

[inline, virtual]

Set/Get the transfer Type.

References myTransferType.

const DtGlobalObjectDesignator & DtTransferControlInteraction::transferredEntityID

(

)

const [inline, virtual]

References myTransferEntity.

const DtTransferType DtTransferControlInteraction::transferType

(

)

const [inline, virtual]

References myTransferType.

---

Member Data Documentation

DtEntityIdentifier DtTransferControlInteraction::myOriginatingEnt [protected]

Referenced by originatingEntityID().

DtEntityIdentifier DtTransferControlInteraction::myReceivingEnt [protected]

Referenced by receivingEntityID(), and setReceivingEntityID().

DtRecordSetList DtTransferControlInteraction::myRecordSetList [protected]

Referenced by recordSetList().

DtU32 DtTransferControlInteraction::myRequestId [protected]

Referenced by requestID(), and setRequestID().

DtGlobalObjectDesignator DtTransferControlInteraction::myTransferEntity [protected]

Referenced by setTransferredEntityID(), and transferredEntityID().

DtTransferType DtTransferControlInteraction::myTransferType [protected]

Referenced by setTransferType(), and transferType().

---

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

• hTransCtlInter.h