DtIfRequestPlan Class Reference

class DtIfRequestPlan: More...

Inheritance diagram for DtIfRequestPlan:

Public Member Functions
	DtIfRequestPlan ()
	default constructor More...
virtual	~DtIfRequestPlan ()
	destructor More...
	DtIfRequestPlan (const DtIfRequestPlan &orig)
	copy constructor More...
DtIfRequestPlan &	operator= (const DtIfRequestPlan &orig)
	assignment operator More...
virtual int	type () const
	Returns the type of Interface Content. More...
virtual DtSimInterfaceContent *	clone () const
virtual const DtUUID &	planName () const
	Set/get the UUID of plan. More...
virtual void	setPlanName (const DtUUID &)
	Was: setName. More...
virtual void	setAddPlanStatementCallback (bool)
	If false, will not tell the back end to send current plan statement or start sending messages when statements change (by default this is true) More...
virtual bool	addPlanStatementCallback () 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	myPlanName
bool	myAddPlanStatementCallback
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

class DtIfRequestPlan:

Instances of DtIfRequestPlan are the content portions of request-plan messages. They contain an echelon ID string and a return address to whom the set-plan message should be addressed.

Content-Type: DtRequestPlanMessageType

Parameters: echelonId - The echelon ID DtString of the plan.

address - An arbitrary, unique return address DtString that is needed to ensure that only one receiver of the reply message will attempt to own the DtPlan pointer.

Constructor & Destructor Documentation

DtIfRequestPlan::DtIfRequestPlan

(

)

default constructor

virtual DtIfRequestPlan::~DtIfRequestPlan ( )

virtual

destructor

DtIfRequestPlan::DtIfRequestPlan

(

const DtIfRequestPlan &

orig

)

copy constructor

Member Function Documentation

DtIfRequestPlan& DtIfRequestPlan::operator=

(

const DtIfRequestPlan &

orig

)

assignment operator

virtual int DtIfRequestPlan::type ( ) const

virtual

Returns the type of Interface Content.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfRequestPlan::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual const DtUUID& DtIfRequestPlan::planName ( ) const

virtual

Set/get the UUID of plan.

Was: name

virtual void DtIfRequestPlan::setPlanName ( const DtUUID &  )

virtual

Was: setName.

virtual void DtIfRequestPlan::setAddPlanStatementCallback ( bool  )

virtual

If false, will not tell the back end to send current plan statement or start sending messages when statements change (by default this is true)

virtual bool DtIfRequestPlan::addPlanStatementCallback ( ) const

virtual

virtual int DtIfRequestPlan::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfRequestPlan::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfRequestPlan::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfRequestPlan::creator ( )

static

Member Data Documentation

DtUUID DtIfRequestPlan::myPlanName

protected

bool DtIfRequestPlan::myAddPlanStatementCallback

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmsgs/ifRequestPlan.h