 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
8 bytes total More...
Public Member Functions | |
| DtIfMultiplePlanSet () | |
| default constructor | |
| virtual | ~DtIfMultiplePlanSet () |
| destructor | |
| DtIfMultiplePlanSet (const DtIfMultiplePlanSet &orig) | |
| copy constructor | |
| DtIfMultiplePlanSet & | operator= (const DtIfMultiplePlanSet &orig) |
| assignment operator | |
| virtual int | type () const |
| Returns the type of Interface Content. | |
| virtual DtSimInterfaceContent * | clone () const |
| virtual void | setEntities (const std::vector< DtString > &) |
| Get/set entities that this plan should be assigned to. | |
| virtual const std::vector < DtString > & | entities () const |
| virtual void | setName (const DtString &name) |
| Sets name and sets myNameSet to true if name is non-blank. | |
| virtual const DtString & | name () const |
| Returns comma separated list of all entities assigned, unless myNameSet is set, in which case it returns myName. | |
| virtual int | netRepSize () const |
| Get the list of statements in the message. | |
| virtual const char * | restoreName (const char *contentBuffer) |
| Restores the name portion of the network buffer. | |
| virtual char * | setNameToNet () |
| Sets the names to the network buffer and returns a pointer immediately after the name. | |
Static Public Member Functions | |
| static DtSimInterfaceContent * | creator () |
Protected Attributes | |
| std::vector< DtString > | myEntities |
| bool | myNameSet |
8 bytes total
class DtIfMultiplePlanSet:
Instances of DtIfMultiplePlanSet are the content portions of a plan message. This message contains enough information to reconstruct a DtPlan, minus the the content of the actual statements. The message is intended to be used with DtPlanStatement messages, which convey the rest of the content needed to fully represent the plan. This message is equivalent to DtIfPlan, except it stores a list of entities
Content-Type: DtMultiplePlanSetMessageType
statement count: The number of DtSimStatements contained in this message.
plan statements: A list of <statement count>=""> DtSimStatements in this message. Statements should be appended to the plan’s main block in the order they appear in the message. If the plan is large enough to require multiple messages, then the messages should be processed in the order they are received, further appending to the statements to received in earlier DtPlan messages.
append flag: bool flag indicating the plan message should be appended to an existing plan. This is used when a plan is large enough to require multiple messages. The first message should have this flag set to false. Subsequent messages should set this flag to true. DtNetIfMultiplePlanSet is the FIXED portion of the simulation network representation of a plan message, padded to an 8 byte boundary.
Fixed portion is immediately followed by:
<net rep of a DtSimStatement 1 (already padded to 8 byte boundary)> <net rep of a DtSimStatement n (already padded to 8 byte boundary)>
where n is myStatementCount.
Statements are top-level statements, added in the order they appear in the plan. Individual statements may contain nested statements (e.g. for 'If/else/then' and 'When' statements). Append flag indicates if message is intended for appending an existing plan (as opposed to creating a new plan). Append flag is false by default.
default constructor
| virtual DtIfMultiplePlanSet::~DtIfMultiplePlanSet | ( | ) | [virtual] |
destructor
| DtIfMultiplePlanSet::DtIfMultiplePlanSet | ( | const DtIfMultiplePlanSet & | orig | ) |
copy constructor
| DtIfMultiplePlanSet& DtIfMultiplePlanSet::operator= | ( | const DtIfMultiplePlanSet & | orig | ) |
assignment operator
| virtual int DtIfMultiplePlanSet::type | ( | ) | const [virtual] |
Returns the type of Interface Content.
Reimplemented from DtIfPlan.
| virtual DtSimInterfaceContent* DtIfMultiplePlanSet::clone | ( | ) | const [virtual] |
Reimplemented from DtIfPlan.
| virtual void DtIfMultiplePlanSet::setEntities | ( | const std::vector< DtString > & | ) | [virtual] |
Get/set entities that this plan should be assigned to.
| virtual const std::vector<DtString>& DtIfMultiplePlanSet::entities | ( | ) | const [virtual] |
| virtual void DtIfMultiplePlanSet::setName | ( | const DtString & | name | ) | [virtual] |
Sets name and sets myNameSet to true if name is non-blank.
Reimplemented from DtIfPlan.
| virtual const DtString& DtIfMultiplePlanSet::name | ( | ) | const [virtual] |
Returns comma separated list of all entities assigned, unless myNameSet is set, in which case it returns myName.
Reimplemented from DtIfPlan.
| virtual int DtIfMultiplePlanSet::netRepSize | ( | ) | const [virtual] |
Get the list of statements in the message.
Statement returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
Reimplemented from DtIfPlan.
| static DtSimInterfaceContent* DtIfMultiplePlanSet::creator | ( | ) | [static] |
Reimplemented from DtIfPlan.
| virtual const char* DtIfMultiplePlanSet::restoreName | ( | const char * | contentBuffer | ) | [virtual] |
Restores the name portion of the network buffer.
This will return the pointer immediately after the name
Reimplemented from DtIfPlan.
| virtual char* DtIfMultiplePlanSet::setNameToNet | ( | ) | [virtual] |
Sets the names to the network buffer and returns a pointer immediately after the name.
Reimplemented from DtIfPlan.
std::vector<DtString> DtIfMultiplePlanSet::myEntities [protected] |
bool DtIfMultiplePlanSet::myNameSet [protected] |