 |
VR-Forces 4.2 Class Documentation
|
|
VR-Forces 4.2 Class Documentation
|
Class Description: DtControllerComponentList. More...
Public Member Functions | |
| DtControllerComponentList () | |
| default constructor | |
| DtControllerComponentList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0) | |
| constructor | |
| virtual | ~DtControllerComponentList () |
| destructor | |
| virtual void | taskNotify (const DtSimTask &task, const DtSimComponent ¬ifier) |
| virtual void | clearTask () |
 Public Member Functions inherited from DtSimComponentList | |
| DtSimComponentList (const DtString &name, DtReaderWriterRegistry *const parentRegistry=0) | |
| constructor | |
| virtual | ~DtSimComponentList () |
| destructor | |
| virtual void | tick (bool hostEntityDestroyed) |
| Ticks each component on the list. | |
| virtual DtSimComponent * | lookupComponent (const DtString &name) |
| virtual void | addComponent (DtSimComponent *component) |
| virtual void | removeComponent (DtSimComponent *component) |
| virtual DtSimComponent * | firstComponent () |
| virtual DtSimComponent * | lastComponent () |
| Public Member Functions inherited from DtRwList | |
| DtRwList () | |
| default constructor | |
| DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual | ~DtRwList () |
| const DtRwList & | operator= (const DtRwList &orig) |
| Calls down to DtReaderWriter::operator=(). List elements are not copied. | |
| virtual DtListItem * | add (DtReaderWriter *data) |
| Add element to the end of the list. | |
| virtual DtListItem * | addWithAlternateName (DtReaderWriter *data, const DtString &name) |
| Add element to the end of the list, but use the provided name in place of the object name on the data object. | |
| virtual DtListItem * | addToStart (DtReaderWriter *data) |
| Add element to the beginning of the list. | |
| virtual DtListItem * | addToEnd (DtReaderWriter *data) |
| Add element to the end of the list. | |
| virtual void * | remove (DtReaderWriter *data, DtListItem *item) |
| Remove an element from the list. | |
| virtual DtlObjPtr | getLocalData (DtlObjPtr args) |
| Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists. | |
| virtual void | getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| virtual DtListItem * | addBefore (DtReaderWriter *data, DtReaderWriter *before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, DtReaderWriter *after) |
| Add element to the list just after the indicated item. | |
| virtual void | removeAll () |
| Removes all the items in the list. | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| bool | operator== (const DtRwList &rhs) const |
| Iterates over all items and calls the factory to compare. | |
| bool | operator!= (const DtRwList &rhs) const |
| DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Invokes DtReaderWriter copy constructor. | |
| DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Invokes DtReaderWriter copy constructor. | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, const DtString &before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, const DtSymbolString &before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, const DtString &after) |
| Add element to the list just after the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, const DtSymbolString &after) |
| Add element to the list just after the indicated item. | |
| 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) | |
| copy constructor | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| 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 | getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Top level to read itself from an input stream. | |
| 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 bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. | |
| virtual void | setName (const DtString &) |
| Set the name of the object. | |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. | |
| 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 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. | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Protected Member Functions | |
| DtControllerComponentList (const DtControllerComponentList &orig) | |
| copy constructor | |
| const DtControllerComponentList & | operator= (const DtControllerComponentList &orig) |
| assignment | |
| Protected Member Functions inherited from DtSimComponentList | |
| DtSimComponentList () | |
| default constructor | |
| virtual void | emptyList () |
| Used by the destructor. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Constructs a component, and then reads relevant data from the stream. | |
| Protected Member Functions inherited from DtRwList | |
| virtual DtListItem * | addBefore (DtReaderWriter *data, DtListItem *before) |
| Add element to the list just before the indicated item. | |
| virtual DtListItem * | addAfter (DtReaderWriter *data, DtListItem *after) |
| Add element to the list just after the indicated item. | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| 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 | putData (FILE *fp, int indentLevel=0) |
| Deriving class overrides these to get/put class specific data. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
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::pair < DtSymbolString, DtString > | DtVariableNameType |
| typedef DtReaderWriterFactory *(* | DtReaderWriterFactoryCreatorFcn )() |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static DtReaderWriterFactory * | factory () |
| Protected Types inherited from DtSimComponentList | |
| typedef std::map< DtString, DtSimComponent * > | DtSimComponentMap |
| Protected Attributes inherited from DtSimComponentList | |
| DtSimComponentMap | myIndex |
| Static Protected Attributes inherited from DtReaderWriter | |
| static DtString | theUnspecifiedValue |
| static DtGetSelfCallbackInfo | thePostGetSelfCallback |
| static DtPutSelfCallbackInfo | thePrePutSelfCallback |
| static const DtVariableBindingsList | theEmptyVariableBindingsList |
| static bool | theCreatorFcnSet |
| static DtReaderWriterFactory * | theFactory |
| static DtReaderWriterFactoryCreatorFcn | theFactoryCreatorFcn |
Class Description: DtControllerComponentList.
Instances of DtControllerComponentList build and manage a hashlist of DtControllerComponents.
| DtControllerComponentList::DtControllerComponentList | ( | ) |
default constructor
| DtControllerComponentList::DtControllerComponentList | ( | const DtString & | name, |
| DtReaderWriterRegistry *const | parentRegistry = 0 |
||
| ) |
constructor
|
protected |
copy constructor
|
virtual |
destructor
|
protected |
assignment
|
virtual |
|
virtual |