VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtIfSkipTask Class Reference

Total: 8 bytes. More...

Inheritance diagram for DtIfSkipTask:
Inheritance graph
[legend]

Public Member Functions

 DtIfSkipTask ()
 default constructor
 DtIfSkipTask (const DtIfSkipTask &orig)
 copy constructor
const DtIfSkipTaskoperator= (const DtIfSkipTask &orig)
 assignment operator
virtual ~DtIfSkipTask ()
virtual int type () const
 Returns the type of Interface Content; DtExitMessageType.
virtual DtSimInterfaceContentclone () const
virtual const DtStringentityNameString () const
virtual void setEntityNameString (const DtString &entityNameString)
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)

Static Public Member Functions

static DtSimInterfaceContentcreator ()

Protected Attributes

DtString myEntityNameString
bool myRequestedBySuperior

Detailed Description

Total: 8 bytes.

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.

virtual DtSimInterfaceContent* DtIfSkipTask::clone ( ) const
virtual
virtual const DtString& DtIfSkipTask::entityNameString ( ) const
virtual
virtual void DtIfSkipTask::setEntityNameString ( const DtString entityNameString)
virtual
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
virtual bool DtIfSkipTask::setFromNet ( const char *  contentBuffer,
unsigned  contentSize 
)
virtual
virtual bool DtIfSkipTask::setToNet ( )
virtual
virtual void DtIfSkipTask::printDataToString ( DtString str)
virtual
static DtSimInterfaceContent* DtIfSkipTask::creator ( )
static

Member Data Documentation

DtString DtIfSkipTask::myEntityNameString
protected
bool DtIfSkipTask::myRequestedBySuperior
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)