VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Attributes | Protected Attributes
DtReaderWriterRegistry Class Reference

List of all members.

Public Member Functions

 DtReaderWriterRegistry ()
 default and real constructor
 DtReaderWriterRegistry (const DtReaderWriterRegistry &orig)
 copy constructor; copies localDataFlag only.
DtReaderWriterRegistryoperator= (const DtReaderWriterRegistry &orig)
 assignment operator
 ~DtReaderWriterRegistry ()
 destructor
bool localData () const
 Indicates whether or not there is any local data; clear (false) by default.
void setLocalData ()
void clearLocalData ()
void addEntry (const DtSymbolString &keyword, DtReaderWriter *const rw)
 Adds an entry with a DtReaderWriter for the given keyword.
void addEntryBefore (const DtSymbolString &keyword, DtReaderWriter *const rw, const DtString &addBefore)
void addEntryBefore (const DtSymbolString &keyword, DtReaderWriter *const rw, DtReaderWriter *const addBefore)
void addEntryAfter (const DtSymbolString &keyword, DtReaderWriter *const rw, const DtString &addAfter)
void addEntryAfter (const DtSymbolString &keyword, DtReaderWriter *const rw, DtReaderWriter *const addAfter)
void removeEntry (const DtSymbolString &keyword)
 Removes the entry for the given keyword.
void removeEntry (DtReaderWriter *const rw)
DtReaderWriter *const readerWriter (const DtString &keyword)
 Returns the DtReaderWriter for the indicated keyword.
void putSelf (FILE *fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual void setValueSpecified (bool specified, bool recurse)
 Iterates over list of entries and calls setValueSpecified() on each item.
const std::vector
< DtReaderWriterRegistryData * > & 
registryData () const
std::vector
< DtReaderWriterRegistryData * > & 
registryData ()
virtual
DtReaderWriterRegistryData
find (const DtString &keyword) const
 Given a keyword, returns the registry item that matches that keyword.
virtual void clear ()
 Clears out all registry and variable bindings data.
virtual DtRwVariableBindingsvariableBindings ()
virtual const
DtRwVariableBindings
variableBindings () const
virtual const DtReaderWriterfindVariableBinding (const DtString &rwType, const DtString &variableName) const
virtual DtReaderWriterfindVariableBinding (const DtString &rwType, const DtString &variableName)
virtual void setVariableBindings (const DtRwVariableBindings *newBindings)
 Sets local variable bindings to the specified value.
virtual DtReaderWriteraddVariableBinding (const DtString &variableType, const DtString &variableName)
 Adds a new variable binding to this registry.

Static Public Attributes

static const DtString theVariableBindingsName

Protected Attributes

std::vector
< DtReaderWriterRegistryData * > 
myData
 virtual DtListItem * lookup(const DtSymbolString &keyword); virtual DtListItem * lookup(DtReaderWriter * const rw);
bool myLocalDataFlag
DtRwVariableBindingsmyVariableBindings

Constructor & Destructor Documentation

default and real constructor

copy constructor; copies localDataFlag only.

destructor


Member Function Documentation

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

assignment operator

Indicates whether or not there is any local data; clear (false) by default.

When true, including DtReaderWriter will call putData/getData. Otherwise, will just call putSelf/getSelf for each registered item.

void DtReaderWriterRegistry::addEntry ( const DtSymbolString keyword,
DtReaderWriter *const  rw 
)

Adds an entry with a DtReaderWriter for the given keyword.

An optional DtList of DtString* keyword aliases may be specified.

void DtReaderWriterRegistry::addEntryBefore ( const DtSymbolString keyword,
DtReaderWriter *const  rw,
const DtString addBefore 
)
void DtReaderWriterRegistry::addEntryBefore ( const DtSymbolString keyword,
DtReaderWriter *const  rw,
DtReaderWriter *const  addBefore 
)
void DtReaderWriterRegistry::addEntryAfter ( const DtSymbolString keyword,
DtReaderWriter *const  rw,
const DtString addAfter 
)
void DtReaderWriterRegistry::addEntryAfter ( const DtSymbolString keyword,
DtReaderWriter *const  rw,
DtReaderWriter *const  addAfter 
)

Removes the entry for the given keyword.

Returns the DtReaderWriter for the indicated keyword.

void DtReaderWriterRegistry::putSelf ( FILE *  fp,
int  indentLevel,
bool  writeUnspecified,
const DtFilename &  path 
)
void DtReaderWriterRegistry::getSelf ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual void DtReaderWriterRegistry::setValueSpecified ( bool  specified,
bool  recurse 
) [virtual]

Iterates over list of entries and calls setValueSpecified() on each item.

The specified flags are used for optional values. Objects are marked as specified if read (by getSelf) or set through a mutator and unspecified objects are not written. If recurse is true, it will recursively call setValueSpecified() over the structure. If recurse is false, the specified flag is only set the specified flag in the immediate members in myData.

const std::vector< DtReaderWriterRegistryData * > & DtReaderWriterRegistry::registryData ( ) const [inline]

References myData.

References myData.

virtual DtReaderWriterRegistryData* DtReaderWriterRegistry::find ( const DtString keyword) const [virtual]

Given a keyword, returns the registry item that matches that keyword.

virtual void DtReaderWriterRegistry::clear ( ) [virtual]

Clears out all registry and variable bindings data.

virtual const DtReaderWriter* DtReaderWriterRegistry::findVariableBinding ( const DtString rwType,
const DtString variableName 
) const [virtual]
virtual DtReaderWriter* DtReaderWriterRegistry::findVariableBinding ( const DtString rwType,
const DtString variableName 
) [virtual]
virtual void DtReaderWriterRegistry::setVariableBindings ( const DtRwVariableBindings newBindings) [virtual]

Sets local variable bindings to the specified value.

The bindings are copied to this registry, and the pointer is not needed after this call. NULL is a valid input to this method.

virtual DtReaderWriter* DtReaderWriterRegistry::addVariableBinding ( const DtString variableType,
const DtString variableName 
) [virtual]

Adds a new variable binding to this registry.

This call will create a new DtReaderWriter subclass based on the type string specified. It will have the default value for this type. The newly create entry is returned. A variableBindings class for this registry will be created if it doesn't already have one.


Member Data Documentation

virtual DtListItem * lookup(const DtSymbolString &keyword); virtual DtListItem * lookup(DtReaderWriter * const rw);

Referenced by registryData().


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)