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

A task state object that contains a generic key-value pair map. More...

Inheritance diagram for DtGenericTaskState:
Inheritance graph
[legend]

Public Member Functions

 DtGenericTaskState ()
 default constructor
 DtGenericTaskState (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a task state object 'put' itself, the writeName will preface the task.
 DtGenericTaskState (const DtString &writeName, const DtGenericTaskState &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtGenericTaskStateoperator= (const DtGenericTaskState &orig)
 assignment operator
virtual ~DtGenericTaskState ()
virtual DtString type () const
virtual DtSimTaskStateclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString stringRep () const
virtual DtRwVariableBindingskeyValueList ()
virtual const
DtRwVariableBindings
keyValueList () const
- Public Member Functions inherited from DtSimTaskState
 DtSimTaskState ()
 default constructor
 DtSimTaskState (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a task staet object 'put' itself, the write name will preface the task state object.
 DtSimTaskState (const DtString &writeName, const DtSimTaskState &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtSimTaskStateoperator= (const DtSimTaskState &orig)
 assignment operator; same as copy constructor
virtual ~DtSimTaskState ()
 destructor
virtual bool init ()
 Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual void putData (FILE *fp, int indentLevel=0)
 putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 getData is just used to get us past the type in the data stream, since it's not actually stored.
- 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 const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
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.

Static Public Member Functions

static DtSimTaskStatecreator ()
- Static Public Member Functions inherited from DtSimTaskState
static DtSimTaskStatecreateTaskState (DtlObjPtr mtlStream)
 Static functions.
static DtSimTaskStatecreateTaskState (DtString taskStateType)
static void addTaskStateCreatorFcn (const DtString &taskName, DtSimTaskStateCreatorFcn fcn)
 Adds a task creator member function to the task factory.
static void setFactory (DtSimTaskStateFactory *factory)
static DtSimTaskStateFactoryfactory ()
static bool isTypeRegistered (DtString type)
- 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 ()

Protected Attributes

DtRwVariableBindings myKeyValueList

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 Attributes inherited from DtSimTaskState
static DtSimTaskStateFactorymyFactory
- 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 DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- 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 task state object that contains a generic key-value pair map.

This may be used for any task that does not need special data types.

Constructor & Destructor Documentation

DtGenericTaskState::DtGenericTaskState ( )

default constructor

DtGenericTaskState::DtGenericTaskState ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor If you have a task state object 'put' itself, the writeName will preface the task.

DtGenericTaskState::DtGenericTaskState ( const DtString writeName,
const DtGenericTaskState orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtGenericTaskState::~DtGenericTaskState ( )
virtual

Member Function Documentation

const DtGenericTaskState& DtGenericTaskState::operator= ( const DtGenericTaskState orig)

assignment operator

virtual DtString DtGenericTaskState::type ( ) const
virtual
Returns
DtGenericTaskStateType

Reimplemented from DtSimTaskState.

virtual DtSimTaskState* DtGenericTaskState::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual
Returns
newly-created copy of this move-along-task-state object

Reimplemented from DtSimTaskState.

virtual DtString DtGenericTaskState::stringRep ( ) const
virtual
Returns
a readable string representation of this task state object
virtual DtRwVariableBindings& DtGenericTaskState::keyValueList ( )
virtual
virtual const DtRwVariableBindings& DtGenericTaskState::keyValueList ( ) const
virtual
static DtSimTaskState* DtGenericTaskState::creator ( )
static

Member Data Documentation

DtRwVariableBindings DtGenericTaskState::myKeyValueList
protected

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)