DtIfPlanStatement Class Reference

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.

Inheritance diagram for DtIfPlanStatement:

Public Member Functions
	DtIfPlanStatement ()
virtual	~DtIfPlanStatement ()
	DtIfPlanStatement (const DtIfPlanStatement &orig)
DtIfPlanStatement &	operator= (const DtIfPlanStatement &orig)
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual const DtUUID &	planName () const
virtual void	setPlanName (const DtUUID &)
virtual int	statementId () const
virtual void	setStatementId (int id)
virtual DtSimStatement *	statement () const
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
virtual void	setIsGlobal (bool yesNo)
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	myPlanName
bool	myIsGlobal
int	myStatementId
DtSimStatement *	myStatement
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

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 DtUUID& DtIfPlanStatement::planName ( ) const

virtual

Set/get the uuid of the plan. Was: name.

virtual void DtIfPlanStatement::setPlanName ( const DtUUID &  )

virtual

Was: setName.

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

DtUUID DtIfPlanStatement::myPlanName

protected

bool DtIfPlanStatement::myIsGlobal

protected

int DtIfPlanStatement::myStatementId

protected

DtSimStatement* DtIfPlanStatement::myStatement

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifPlanStatement.h