 |
VR-Forces 4.3.1 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3.1 Class Documentation
|
DtAggregateEmbarkationDescriptor; descriptor for a DtAggregateEmbarkation component. More...
Public Member Functions | |
| DtAggregateEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtAggregateEmbarkationDescriptor (const DtAggregateEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtAggregateEmbarkationDescriptor & | operator= (const DtAggregateEmbarkationDescriptor &orig) |
| assignment | |
| virtual | ~DtAggregateEmbarkationDescriptor () |
| destructor | |
| virtual DtString | type () const |
| Returns the type of descriptor. | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=0) const |
| virtual bool | embarkAggregate () const |
| Accessor/mutator for myEmbarkAggregate. | |
| virtual void | setEmbarkAggregate (bool) |
| Accessor/mutator for myEmbarkAggregate. | |
 Public Member Functions inherited from DtEmbarkationDescriptor | |
| DtEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtEmbarkationDescriptor (const DtEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtEmbarkationDescriptor & | operator= (const DtEmbarkationDescriptor &orig) |
| assignment | |
| virtual | ~DtEmbarkationDescriptor () |
| destructor | |
| virtual double | responseTimeout () const |
| Accessor/mutator for myResponseTimeout. | |
| virtual void | setResponseTimeout (double value) |
| Accessor/mutator for myResponseTimeout. | |
| virtual int | responseRetries () const |
| Accessor/mutator for myResponseRetries. | |
| virtual void | setResponseRetries (int value) |
| Accessor/mutator for myResponseRetries. | |
| virtual bool | stopAtEmbarkationPoint () const |
| Accessor/mutator for myStopAtEmbarkationPoint. | |
| virtual void | setStopAtEmbarkationPoint (bool value) |
| Accessor/mutator for myStopAtEmbarkationPoint. | |
| Public Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtComponentDescriptor & | operator= (const DtComponentDescriptor &orig) |
| assignment | |
| virtual | ~DtComponentDescriptor () |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| Overrides base class putData to output our type. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actually stored. | |
| virtual bool | init () |
| Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. | |
| bool | operator== (const DtComponentDescriptor &) const |
| DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual void | setComponentType (const DtString &componentType) |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual const DtString & | componentType () const |
| Type of DtSimComponent this descriptor is associated with. | |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| virtual DtReal | minTickPeriod () const |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| virtual DtReal | minTickPeriodVariance () const |
| virtual void | setTickPeriodUsesRealTime (bool value) |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual bool | tickPeriodUsesRealTime () const |
| Accessor/mutator for myTickPeriodUsesRealTime. | |
| virtual const DtString & | processStateRepositoryName () const |
| Name which this component will assign to its PSR. | |
| virtual void | setProcessStateRepositoryName (const DtString &name) |
| Name which this component will assign to its PSR. | |
| virtual const DtString & | processStateRepositoryType () const |
| Type of PSR this component will create. | |
| virtual void | setProcessStateRepositoryType (const DtString &type) |
| Type of PSR this component will create. | |
| virtual void | setIsEnabled (bool yesNo) |
| Is the component enabled or not. | |
| virtual bool | isEnabled () const |
| Is the component enabled or not. | |
| virtual void | setDebugActive (bool active) |
| Should detailed debug info be printed for this component. | |
| virtual bool | debugActive () const |
| Should detailed debug info be printed for this component. | |
| virtual void | setCreateComponent (bool yesNo) |
| Should the component be created or not. | |
| virtual bool | createComponent () const |
| Should the component be created or not. | |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. | |
| virtual void | writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. | |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. | |
| virtual bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op. | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| The variable name, if this object is a variable reference. | |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual DtReaderWriter * | defaultRWValue () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restires object from given xml file. | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. | |
Static Public Member Functions | |
| static DtComponentDescriptor * | creator () |
| | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwBoolean | myEmbarkAggregate |
| Parameter Name: embark-aggregate Parameter Description: Sets whether or not to embark the aggregate at the location of the lead subordinate when all eligible subordinates are embarked. | |
| Protected Attributes inherited from DtEmbarkationDescriptor | |
| DtRwReal | myResponseTimeout |
| Parameter Name: response-timeout Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request. | |
| DtRwInt | myResponseRetries |
| Parameter Name: response-retries Parameter Description: Sets the number of retries for sending an embarkation response request. | |
| DtRwBoolean | myStopAtEmbarkationPoint |
| Parameter Name: stop-at-embarkation-point Parameter Description: Specifies whether the entity should perform a full stop when it reaches the embarkation point prior to embarking. | |
| Protected Attributes inherited from DtComponentDescriptor | |
| DtRwBoolean | myIsEnabled |
| DtRwBoolean | myDebug |
| This parameter defaults to false. | |
| DtRwBoolean | myCreateComponent |
| DtRwString | myComponentType |
| Parameter Name: component-type Parameter Description: String identifying type of component. | |
| DtRwReal | myMinTickPeriod |
| Parameter Name: min-tick-period Parameter Description: Average tick period for this component. | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. | |
| DtRwBoolean | myTickPeriodUsesRealTime |
| Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. | |
| DtRwString | myProcessStateRepositoryName |
| Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. | |
| DtRwString | myProcessStateRepositoryType |
| Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component. | |
| Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. | |
Private Member Functions | |
| DtAggregateEmbarkationDescriptor () | |
| default constructor; not implemented | |
Additional Inherited Members | |
| Public Types inherited from DtReaderWriter | |
| typedef std::vector < DtSymbolString > | aliasContainer |
| typedef std::vector < DtSymbolString >::iterator | aliasIter |
| typedef std::vector < DtSymbolString > ::const_iterator | aliasConstIter |
| typedef std::vector< DtFilename > | SearchPaths |
| typedef std::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| Protected Member Functions inherited from DtComponentDescriptor | |
| DtComponentDescriptor () | |
| default constructor; not implemented | |
| Static Protected Attributes inherited from DtComponentDescriptor | |
| static DtComponentDescriptorFactory * | myFactory |
DtAggregateEmbarkationDescriptor; descriptor for a DtAggregateEmbarkation component.
Class DtAggregateEmbarkationDescriptor holds all of the readable/writeable parameters used to configure a DtAggregateEmbarkation model component.
End User Description: The DtAggregateEmbarkationDescriptor should only be configured as a part of aggregate entity types (entities configured with a vrf-aggregate-state-repository).
| DtAggregateEmbarkationDescriptor::DtAggregateEmbarkationDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtAggregateEmbarkationDescriptor::DtAggregateEmbarkationDescriptor | ( | const DtAggregateEmbarkationDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
|
virtual |
destructor
|
private |
default constructor; not implemented
| DtAggregateEmbarkationDescriptor& DtAggregateEmbarkationDescriptor::operator= | ( | const DtAggregateEmbarkationDescriptor & | orig | ) |
assignment
|
virtual |
Returns the type of descriptor.
Used to create the descriptor when read in from an mtl file. Descriptor types are defined in compDescTypes.h
Reimplemented from DtEmbarkationDescriptor.
|
virtual |
Reimplemented from DtEmbarkationDescriptor.
|
static |
Reimplemented from DtEmbarkationDescriptor.
|
virtual |
Accessor/mutator for myEmbarkAggregate.
|
virtual |
Accessor/mutator for myEmbarkAggregate.
|
protected |
Parameter Name: embark-aggregate
Parameter Description: Sets whether or not to embark the aggregate at the location of the lead subordinate when all eligible subordinates are embarked.
Parameter Default Value: True