DtStopFreezeInteraction Class Reference

class DtStopFreezeInteraction: More...

Inheritance diagram for DtStopFreezeInteraction:

Collaboration diagram for DtStopFreezeInteraction:

List of all members.

Public Member Functions
	DtStopFreezeInteraction ()
	default constructor
virtual	~DtStopFreezeInteraction ()
	destructor
	DtStopFreezeInteraction (const DtStopFreezeInteraction &orig)
	copy constructor
DtStopFreezeInteraction &	operator= (const DtStopFreezeInteraction &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	setRealWorldTime (const DtTime time)
	Set/Get real world time.
virtual DtTime	realWorldTime () const
virtual void	setRequestId (int id)
	Set/Get request ID.
virtual int	requestId () const
virtual DtStopReason	reason () const
	Set/Get stopReason.
virtual void	setReason (DtStopReason reason)
virtual bool	reflectWhenFrozen () const
	SetGet reflectWhenFrozen flag.
virtual void	setReflectWhenFrozen (bool flag)
virtual bool	runClockWhenFrozen () const
	SetGet runClockWhenFrozen flag.
virtual void	setRunClockWhenFrozen (bool flag)
virtual bool	updateWhenFrozen () const
	SetGet updateWhenFrozen flag.
virtual void	setUpdateWhenFrozen (bool flag)
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 DtStopFreezeInteraction.
static void	addCallback (DtExerciseConn *conn, DtStopFreezeInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtStopFreezeInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
Protected Attributes
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt
int	myRequestId
DtTime	myRealTime
DtStopReason	myReason
bool	myReflect
bool	myUpdate
bool	myRunClock

---

Detailed Description

class DtStopFreezeInteraction:

Instances of DtStopFreezeInteraction are used to represent StopFreeze Interactions in the RPR ROM.

---

Constructor & Destructor Documentation

DtStopFreezeInteraction::DtStopFreezeInteraction

(

)

default constructor

virtual DtStopFreezeInteraction::~DtStopFreezeInteraction

(

)

[virtual]

destructor

DtStopFreezeInteraction::DtStopFreezeInteraction

(

const DtStopFreezeInteraction &

orig

)

copy constructor

---

Member Function Documentation

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

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

static DtInteraction* DtStopFreezeInteraction::create

(

)

[static]

Create a DtStopFreezeInteraction.

Caller is responsible for deletion.

virtual const char* DtStopFreezeInteraction::name

(

)

const [virtual]

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

Implements DtInteraction.

DtStopFreezeInteraction& DtStopFreezeInteraction::operator=

(

const DtStopFreezeInteraction &

orig

)

assignment operator

virtual void DtStopFreezeInteraction::printData

(

)

const [virtual]

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtStopFreezeInteraction::printDataToStream

(

std::ostream &

stream

)

const [virtual]

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

virtual DtTime DtStopFreezeInteraction::realWorldTime

(

)

const [virtual]

virtual DtStopReason DtStopFreezeInteraction::reason

(

)

const [virtual]

Set/Get stopReason.

virtual const DtEntityIdentifier& DtStopFreezeInteraction::receiverId

(

)

const [virtual]

virtual bool DtStopFreezeInteraction::reflectWhenFrozen

(

)

const [virtual]

SetGet reflectWhenFrozen flag.

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

virtual int DtStopFreezeInteraction::requestId

(

)

const [virtual]

virtual bool DtStopFreezeInteraction::runClockWhenFrozen

(

)

const [virtual]

SetGet runClockWhenFrozen flag.

virtual const DtEntityIdentifier& DtStopFreezeInteraction::senderId

(

)

const [virtual]

virtual void DtStopFreezeInteraction::setRealWorldTime

(

const DtTime

time

)

[virtual]

Set/Get real world time.

virtual void DtStopFreezeInteraction::setReason

(

DtStopReason

reason

)

[virtual]

virtual void DtStopFreezeInteraction::setReceiverId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get receiver ID.

virtual void DtStopFreezeInteraction::setReflectWhenFrozen

(

bool

flag

)

[virtual]

virtual void DtStopFreezeInteraction::setRequestId

(

int

id

)

[virtual]

Set/Get request ID.

virtual void DtStopFreezeInteraction::setRunClockWhenFrozen

(

bool

flag

)

[virtual]

virtual void DtStopFreezeInteraction::setSenderId

(

const DtEntityIdentifier &

id

)

[virtual]

Set/Get sender ID.

virtual void DtStopFreezeInteraction::setUpdateWhenFrozen

(

bool

flag

)

[virtual]

virtual bool DtStopFreezeInteraction::updateWhenFrozen

(

)

const [virtual]

SetGet updateWhenFrozen flag.

---

Member Data Documentation

DtEntityIdentifier DtStopFreezeInteraction::myOrigEnt [protected]

DtTime DtStopFreezeInteraction::myRealTime [protected]

DtStopReason DtStopFreezeInteraction::myReason [protected]

DtEntityIdentifier DtStopFreezeInteraction::myReceiveEnt [protected]

bool DtStopFreezeInteraction::myReflect [protected]

int DtStopFreezeInteraction::myRequestId [protected]

bool DtStopFreezeInteraction::myRunClock [protected]

bool DtStopFreezeInteraction::myUpdate [protected]

---

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

• hStopInter.h