DtIfSkipTask Class Reference

File: ifSkipTask.h. More...

Inheritance diagram for DtIfSkipTask:

Public Member Functions
	DtIfSkipTask ()
	default constructor
	DtIfSkipTask (const DtIfSkipTask &orig)
	copy constructor
const DtIfSkipTask &	operator= (const DtIfSkipTask &orig)
	assignment operator
virtual	~DtIfSkipTask ()
virtual int	type () const
	Returns the type of Interface Content; DtExitMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual const DtUUID &	entity () const
	Was: entityNameString.
virtual void	setEntity (const DtUUID &)
	Was: setEntityNameString.
virtual void	setRequestedBySuperior (bool requestedBySuperior)
	Set to true if this skip task request is being made by an aggregate, false if not.
virtual bool	requestedBySuperior () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtUUID	myEntity
bool	myRequestedBySuperior
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Detailed Description

File: ifSkipTask.h.

Class: DtIfSkipTask DtIfSkipTask is the content portion of a Skip Task message. When a user asks an entity to skip to the next task using the Skip Task menu item in the GUI, a DtIfSkipTask interface message is sent to the Entity Manager, which then calls DtSimLocalEn- tity::skipTask() on the selected entity.

Content-Type: DtSkipTaskMessageType

Parameters: entityNameString - Entity name DtString of the selected entity

Constructor & Destructor Documentation

DtIfSkipTask::DtIfSkipTask

(

)

default constructor

DtIfSkipTask::DtIfSkipTask

(

const DtIfSkipTask &

orig

)

copy constructor

virtual DtIfSkipTask::~DtIfSkipTask ( )

virtual

Member Function Documentation

const DtIfSkipTask& DtIfSkipTask::operator=

(

const DtIfSkipTask &

orig

)

assignment operator

virtual int DtIfSkipTask::type ( ) const

virtual

Returns the type of Interface Content; DtExitMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfSkipTask::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual const DtUUID& DtIfSkipTask::entity ( ) const

virtual

Was: entityNameString.

virtual void DtIfSkipTask::setEntity ( const DtUUID &  )

virtual

Was: setEntityNameString.

virtual void DtIfSkipTask::setRequestedBySuperior ( bool  requestedBySuperior )

virtual

Set to true if this skip task request is being made by an aggregate, false if not.

By default, this is set to false.

virtual bool DtIfSkipTask::requestedBySuperior ( ) const

virtual

virtual int DtIfSkipTask::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSkipTask::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfSkipTask::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfSkipTask::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfSkipTask::creator ( )

static

Member Data Documentation

DtUUID DtIfSkipTask::myEntity

protected

bool DtIfSkipTask::myRequestedBySuperior

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifSkipTask.h