VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions
DtSuspendedTaskStatusList Class Reference

A list of DtSuspendedTaskStatusEntry instances, each representing a different suspend ID. More...

Inheritance diagram for DtSuspendedTaskStatusList:
Inheritance graph
[legend]

Public Member Functions

 DtSuspendedTaskStatusList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtSuspendedTaskStatusList (const DtString &name, const DtSuspendedTaskStatusList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtSuspendedTaskStatusList ()
virtual
DtSuspendedTaskStatusEntry
findEntryBySuspendId (int suspendId)
 Finds an entry in the list with the specified suspend ID and returns it.
- Public Member Functions inherited from DtRwTemplatedListPtr< DtSuspendedTaskStatusEntry, true >
 DtRwTemplatedListPtr ()
 default constructor
 DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 Invokes DtReaderWriter copy constructor.
 DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 ... and make sure the default constructor is overridden:
DtRwTemplatedListPtroperator= (const DtRwTemplatedListPtr &orig)
virtual ~DtRwTemplatedListPtr ()
DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 This method must be overridden by a subclass.
virtual DtListItem * add (DtSuspendedTaskStatusEntry *data)
 Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.
void removeAll ()
 Removes all entries from the list.
void * remove (DtListItem *item)
void * remove (DtSuspendedTaskStatusEntry *item)
void removeAndDeleteAll ()
 Removes and deletes all entries in the list.
bool operator== (const DtRwTemplatedListPtr &) const
 Equivalence operators.
bool operator!= (const DtRwTemplatedListPtr &) const
void setAutoDelete (bool b)
 Set to true to automatically delete all items in the list upon list deletion.
bool autoDelete () const
const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
void copyList (const DtRwTemplatedListPtr &orig)
- 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 DtRwListoperator= (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.
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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Additional Inherited Members

- Public Types inherited from DtRwTemplatedListPtr< DtSuspendedTaskStatusEntry, true >
typedef DtIteratorBase
< DtSuspendedTaskStatusEntry
iterator
typedef DtIteratorBase< const
DtSuspendedTaskStatusEntry
const_iterator
- Static Public Member Functions inherited from DtRwTemplatedListPtr< DtSuspendedTaskStatusEntry, true >
static const char * ListReaderWriterType ()
- 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 Attributes inherited from DtRwTemplatedListPtr< DtSuspendedTaskStatusEntry, true >
bool myAutoDelete
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn

Detailed Description

A list of DtSuspendedTaskStatusEntry instances, each representing a different suspend ID.

Constructor & Destructor Documentation

DtSuspendedTaskStatusList::DtSuspendedTaskStatusList ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtSuspendedTaskStatusList::DtSuspendedTaskStatusList ( const DtString name,
const DtSuspendedTaskStatusList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtSuspendedTaskStatusList::~DtSuspendedTaskStatusList ( )
virtual

Member Function Documentation

virtual DtSuspendedTaskStatusEntry* DtSuspendedTaskStatusList::findEntryBySuspendId ( int  suspendId)
virtual

Finds an entry in the list with the specified suspend ID and returns it.


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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)