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

Total: 3 bytes. More...

Inheritance diagram for DtIfRequestPlan:
Inheritance graph
[legend]

Public Member Functions

 DtIfRequestPlan ()
 default constructor
virtual ~DtIfRequestPlan ()
 destructor
 DtIfRequestPlan (const DtIfRequestPlan &orig)
 copy constructor
DtIfRequestPlanoperator= (const DtIfRequestPlan &orig)
 assignment operator
virtual int type () const
 Returns the type of Interface Content.
virtual DtSimInterfaceContentclone () const
virtual const DtStringname () const
 Set/get the name string of plan.
virtual void setName (const DtString &name)
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)
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 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 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 DtSimInterfaceContentoperator= (const DtSimInterfaceContent &orig)
virtual char * createNetworkBuffer ()
- Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactorymyFactory

Detailed Description

Total: 3 bytes.

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 DtString& DtIfRequestPlan::name ( ) const
virtual

Set/get the name string of plan.

virtual void DtIfRequestPlan::setName ( const DtString name)
virtual
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

DtString DtIfRequestPlan::myName
protected
bool DtIfRequestPlan::myAddPlanStatementCallback
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)