VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtModelSet Class Reference
Inheritance diagram for DtModelSet:
Inheritance graph
[legend]

Public Member Functions

 DtModelSet ()
 default constructor
 DtModelSet (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtModelSet ()
 destructor
 DtModelSet (const DtModelSet &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
DtModelSetoperator= (const DtModelSet &orig)
 assignment operator
virtual bool load (const DtFilename &)
virtual bool save (const DtFilename &)
virtual DtModelSetEntryfind (const DtObjectType &) const
virtual DtModelSetEntryfindMatchingPattern (const DtObjectType &) const
virtual DtModelSetEntryfindByUniqueID (const DtString &) const
virtual DtModelSetEntryfindByLabel (const DtString &) const
virtual void setComment (const DtString &)
virtual const DtString comment () const
DtObjectType objectTypeFor (const DtString &label) const
 Returns object type for item matching label.
virtual DtModelSetEntryaddModel (DtModelSetEntry *)
 Clones the model and adds it. Returns the cloned model.
virtual void emptyList ()
virtual void entitiesForObjectType (const DtObjectType &o, std::list< DtString > &list) const
 Give the object type, return all names that match (including wild cards) that object type.
int version () const
 Returns an entry given a unique ID.
virtual DtString createUniqueID (const DtModelSetEntry *) const
 Creates a unique id for the given value.
- 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 * 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)
 Top level to read itself from an input stream.
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.
 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
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 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 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 DtModelSetcreate (const DtString &, DtReaderWriterRegistry *const parentRegistry=NULL)

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtRwString item, and then retrieves it from the stream.
void copyList (const DtModelSet &orig)
 Non-virtual since it is called by the constructor.
void clear ()
 Non-virtual since is it called by the constructor/destructor.
virtual void writeSelf (FILE *fp, int i, bool writeUnspecified, const DtFilename &path)
 Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
- 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.

Protected Attributes

DtString myFilename
DtString myComment
DtRwInt myVersion

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
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Constructor & Destructor Documentation

DtModelSet::DtModelSet ( )

default constructor

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

destructor

DtModelSet::DtModelSet ( const DtModelSet orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

Member Function Documentation

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

assignment operator

virtual bool DtModelSet::load ( const DtFilename &  )
virtual
virtual bool DtModelSet::save ( const DtFilename &  )
virtual
virtual DtModelSetEntry* DtModelSet::find ( const DtObjectType ) const
virtual
virtual DtModelSetEntry* DtModelSet::findMatchingPattern ( const DtObjectType ) const
virtual
virtual DtModelSetEntry* DtModelSet::findByUniqueID ( const DtString ) const
virtual
virtual DtModelSetEntry* DtModelSet::findByLabel ( const DtString ) const
virtual
virtual void DtModelSet::setComment ( const DtString )
virtual
virtual const DtString DtModelSet::comment ( ) const
virtual
static DtModelSet* DtModelSet::create ( const DtString ,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
static
DtObjectType DtModelSet::objectTypeFor ( const DtString label) const

Returns object type for item matching label.

virtual DtModelSetEntry* DtModelSet::addModel ( DtModelSetEntry )
virtual

Clones the model and adds it. Returns the cloned model.

virtual void DtModelSet::emptyList ( )
virtual
virtual void DtModelSet::entitiesForObjectType ( const DtObjectType o,
std::list< DtString > &  list 
) const
virtual

Give the object type, return all names that match (including wild cards) that object type.

Will not add the name if it already exists in the list

int DtModelSet::version ( ) const
inline

Returns an entry given a unique ID.

References myVersion.

virtual DtString DtModelSet::createUniqueID ( const DtModelSetEntry ) const
virtual

Creates a unique id for the given value.

virtual DtlObjPtr DtModelSet::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
protectedvirtual

Constructs a DtRwString item, and then retrieves it from the stream.

Implements DtRwList.

void DtModelSet::copyList ( const DtModelSet orig)
protected

Non-virtual since it is called by the constructor.

void DtModelSet::clear ( )
protected

Non-virtual since is it called by the constructor/destructor.

virtual void DtModelSet::writeSelf ( FILE *  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
protectedvirtual

Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtString DtModelSet::myFilename
protected
DtString DtModelSet::myComment
protected
DtRwInt DtModelSet::myVersion
protected

Referenced by version().


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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)