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

class DtIfPlanStatement: More...

Inheritance diagram for DtIfPlanStatement:
Inheritance graph
[legend]

Public Member Functions

 DtIfPlanStatement ()
 default constructor
virtual ~DtIfPlanStatement ()
 destructor
 DtIfPlanStatement (const DtIfPlanStatement &orig)
 copy constructor
DtIfPlanStatementoperator= (const DtIfPlanStatement &orig)
 assignment operator
virtual int type () const
virtual DtSimInterfaceContentclone () const
virtual const DtStringname () const
 Set/get the name of the plan.
virtual void setName (const DtString &name)
virtual int statementId () const
 Set/get the ID of the statement requested.
virtual void setStatementId (int id)
virtual DtSimStatementstatement () const
 Set/get the plan statement associated with the above name and statement ID.
virtual void setStatement (DtSimStatement *statement)
virtual int netRepSize () const
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool setToNet ()
virtual void printDataToString (DtString &str)
virtual bool isGlobal () const
 Indicates whether the referenced plan is a global plan or an entity/aggregate plan.
virtual void setIsGlobal (bool yesNo)
 Indicates whether the referenced plan is a global plan or an entity/aggregate plan.
- Public Member Functions inherited from DtSimInterfaceContent
virtual ~DtSimInterfaceContent ()
virtual bool update (const DtSimInterfaceContent *data)
virtual char * netRep ()
virtual void setUseSessionId (bool yesNo)
virtual bool useSessionId () const

Static Public Member Functions

static DtSimInterfaceContentcreator ()
- Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContentcreateInterfaceContent (int type)
static void addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactoryfactory ()

Protected Attributes

DtString myName
bool myIsGlobal
int myStatementId
DtSimStatementmyStatement
- Protected Attributes inherited from DtSimInterfaceContent
char * myNetRep
bool myUseSessionId

Additional Inherited Members

- Protected Member Functions inherited from DtSimInterfaceContent
 DtSimInterfaceContent ()
 DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual char * createNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory

Detailed Description

class DtIfPlanStatement:

Instances of DtIfPlanStatement are interface messages used to convey the contents of a particular plan statement, for a given plan (specified by name), and a given statement ID. The addressed recipient of this message takes over the DtSimStatement pointer and is responsible for deleting it.

Content-Type: DtPlanStatementMessageType

Parameters: name - The name of the selected plan.

statementId - The integer ID of the statement requested.

statement - The plan statement (a DtSimStatement) associated with the requested name and statement ID.

Constructor & Destructor Documentation

DtIfPlanStatement::DtIfPlanStatement ( )

default constructor

virtual DtIfPlanStatement::~DtIfPlanStatement ( )
virtual

destructor

DtIfPlanStatement::DtIfPlanStatement ( const DtIfPlanStatement orig)

copy constructor

Member Function Documentation

DtIfPlanStatement& DtIfPlanStatement::operator= ( const DtIfPlanStatement orig)

assignment operator

virtual int DtIfPlanStatement::type ( ) const
virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfPlanStatement::clone ( ) const
virtual

Implements DtSimInterfaceContent.

virtual const DtString& DtIfPlanStatement::name ( ) const
virtual

Set/get the name of the plan.

virtual void DtIfPlanStatement::setName ( const DtString name)
virtual
virtual int DtIfPlanStatement::statementId ( ) const
virtual

Set/get the ID of the statement requested.

virtual void DtIfPlanStatement::setStatementId ( int  id)
virtual
virtual DtSimStatement* DtIfPlanStatement::statement ( ) const
virtual

Set/get the plan statement associated with the above name and statement ID.

virtual void DtIfPlanStatement::setStatement ( DtSimStatement statement)
virtual
virtual bool DtIfPlanStatement::isGlobal ( ) const
virtual

Indicates whether the referenced plan is a global plan or an entity/aggregate plan.

virtual void DtIfPlanStatement::setIsGlobal ( bool  yesNo)
virtual

Indicates whether the referenced plan is a global plan or an entity/aggregate plan.

virtual int DtIfPlanStatement::netRepSize ( ) const
virtual

Reimplemented from DtSimInterfaceContent.

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

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfPlanStatement::setToNet ( )
virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfPlanStatement::printDataToString ( DtString str)
virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfPlanStatement::creator ( )
static

Member Data Documentation

DtString DtIfPlanStatement::myName
protected
bool DtIfPlanStatement::myIsGlobal
protected
int DtIfPlanStatement::myStatementId
protected
DtSimStatement* DtIfPlanStatement::myStatement
protected

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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)