VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtRwNLengthStringVector Class Reference

DtRwNLengthStringVector is a named, readable/writable vector of strings of arbitrary length. This wraps a std::vector<DtString> so funtions are equivelent to their std::vector counterparts. This means no range checking on indecees.

Inheritance diagram for DtRwNLengthStringVector:
Inheritance graph
[legend]

Public Member Functions

 DtRwNLengthStringVector (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwNLengthStringVector (const std::vector< DtString > &strings, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwNLengthStringVector (const std::vector< std::string > &strings, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwNLengthStringVector (const std::list< DtString > &strings, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwNLengthStringVector (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtRwNLengthStringVector (const DtRwNLengthStringVector &orig, DtReaderWriterRegistry *parentRegistry=0)
 
const DtRwNLengthStringVector & operator= (const DtRwNLengthStringVector &orig)
 
virtual bool operator== (const DtRwNLengthStringVector &orig) const
 
virtual bool operator!= (const DtRwNLengthStringVector &orig) const
 
virtual ~DtRwNLengthStringVector ()
 
virtual DtRwNLengthStringVector * clone (DtReaderWriterRegistry *parentRegistry=0) const
 
virtual bool compare (const DtRwNLengthStringVector &orig, bool bCaseSensitive=true) const
 
virtual void setSize (unsigned int length)
 
virtual unsigned int size () const
 
virtual int indexOfValue (const DtString &value) const
 
virtual bool containsValue (const DtString &value) const
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual const char * readerWriterType () const
 
virtual void add (const DtString &)
 
virtual void remove (int iIndex)
 
virtual void remove (const DtString &)
 
const std::vector< DtString > & strings () const
 
virtual void setFrom (const std::vector< DtString > &)
 
std::set< std::string > asStdSet () const
 
virtual void setFrom (const std::set< std::string > &)
 
virtual void setFrom (const std::set< DtString > &)
 
void clear ()
 
virtual DtString prettyPrint () const
 
virtual DtString & operator[] (unsigned int index)
 
virtual const DtString & operator[] (unsigned int index) const
 
virtual DtString at (unsigned int index) const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriter & operator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs) const
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContainer & aliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType > 		unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriter * defaultRWValue () const
 
virtual DtReaderWriter * defaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistry & registry () const
 
DtReaderWriterRegistry & registry ()
 
virtual DtPropertyInterface * property ()
 
virtual const DtPropertyInterface * property () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindings * generateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Protected Attributes

std::vector< DtString > myStrings
 
std::set< std::string > mySetStrings
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistry * myParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWriter * myDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual const char * xmlType () const
 
virtual void stringToStringList (const DtString &string)
 
virtual DtString stringListToString () const
 
static const char * theXmlType ()
 

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::vector< DtFilename > SearchPaths
 
typedef std::pair
< DtSymbolString, DtString > 		DtVariableNameType
 
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList & 		nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const char * theXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactory * factory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWriter * createFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWriter * createFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWriter * createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- 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
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtRwNLengthStringVector::DtRwNLengthStringVector ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwNLengthStringVector::DtRwNLengthStringVector ( const std::vector< DtString > &  strings,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwNLengthStringVector::DtRwNLengthStringVector ( const std::vector< std::string > &  strings,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwNLengthStringVector::DtRwNLengthStringVector ( const std::list< DtString > &  strings,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwNLengthStringVector::DtRwNLengthStringVector ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)
DtRwNLengthStringVector::DtRwNLengthStringVector ( const DtRwNLengthStringVector &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)
virtual DtRwNLengthStringVector::~DtRwNLengthStringVector ( )
virtual

Member Function Documentation

const DtRwNLengthStringVector& DtRwNLengthStringVector::operator= ( const DtRwNLengthStringVector &  orig)
virtual bool DtRwNLengthStringVector::operator== ( const DtRwNLengthStringVector &  orig) const
virtual

comparison operator case sensitive comparison of string lists does not take parent DtReaderWriter values into consideration

virtual bool DtRwNLengthStringVector::operator!= ( const DtRwNLengthStringVector &  orig) const
virtual
virtual DtRwNLengthStringVector* DtRwNLengthStringVector::clone ( DtReaderWriterRegistry *  parentRegistry = 0) const
virtual
virtual bool DtRwNLengthStringVector::compare ( const DtRwNLengthStringVector &  orig,
bool  bCaseSensitive = true 
) const
virtual

compare() Compare contents of this list with orig if same, return true, otherwise false By default, this is a case-sensitive comparison. Set bCaseSensitive to false to ignore case during comparison.

virtual void DtRwNLengthStringVector::setSize ( unsigned int  length)
virtual

Sets the size of the list. Existing items still within the new size are preserved.

virtual unsigned int DtRwNLengthStringVector::size ( ) const
virtual
Returns
The current size of the list.
virtual DtString& DtRwNLengthStringVector::operator[] ( unsigned int  index)
virtual
Returns
String at specified index.
Note
No range checking; index must be in the range 0 to size - 1.
virtual const DtString& DtRwNLengthStringVector::operator[] ( unsigned int  index) const
virtual
Returns
String at specified index.
Note
No range checking; index must be in the range 0 to size - 1.
virtual DtString DtRwNLengthStringVector::at ( unsigned int  index) const
virtual
Returns
String at specified index.
Note
No range checking; index must be in the range 0 to size - 1.
virtual int DtRwNLengthStringVector::indexOfValue ( const DtString &  value) const
virtual
Returns
The index of the first occurrence specified value of the array. If the value is not found, -1 is returned.

Referenced by DtModelSetEntry::hasCategory().

virtual bool DtRwNLengthStringVector::containsValue ( const DtString &  value) const
virtual
Returns
True if and only if the specified value is contained in the array.
virtual void DtRwNLengthStringVector::putData ( std::string &  fp,
int  indentLevel = 0 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwNLengthStringVector::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual const char* DtRwNLengthStringVector::readerWriterType ( ) const
virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

virtual void DtRwNLengthStringVector::add ( const DtString &  )
virtual

Adds a new string to the myStrings vector.

virtual void DtRwNLengthStringVector::remove ( int  iIndex)
virtual

Removes a string at the specified index (if the index is valid)

virtual void DtRwNLengthStringVector::remove ( const DtString &  )
virtual

Removes the first occurance of the given string. If there are multiple occurances you will need to call this multiple times.

const std::vector< DtString > & DtRwNLengthStringVector::strings ( ) const
inline

References myStrings.

virtual void DtRwNLengthStringVector::setFrom ( const std::vector< DtString > &  )
virtual
std::set<std::string> DtRwNLengthStringVector::asStdSet ( ) const
virtual void DtRwNLengthStringVector::setFrom ( const std::set< std::string > &  )
virtual
virtual void DtRwNLengthStringVector::setFrom ( const std::set< DtString > &  )
virtual
virtual void DtRwNLengthStringVector::putData ( DtEnvironmentSP  ,
DtEnvValueSP  parent 
) const
virtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtRwNLengthStringVector::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  value,
const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList &  bindings = DtVariableBindingsList() 
)
virtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtRwNLengthStringVector::getSelf ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths = SearchPaths(),
const DtVariableBindingsList &  variableBindings = nullVariableReference() 
)
virtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtRwNLengthStringVector::getSelf ( const DtEnvironmentSP  ,
const DtEnvValueSP  root,
const SearchPaths &  searchPaths = SearchPaths(),
const DtVariableBindingsList &  bindings = DtVariableBindingsList() 
)
virtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

static const char* DtRwNLengthStringVector::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtRwNLengthStringVector::xmlType ( ) const
inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwNLengthStringVector::stringToStringList ( const DtString &  string)
virtual

Routines to archive/dearchive from an XML Environment.

virtual DtString DtRwNLengthStringVector::stringListToString ( ) const
virtual

Routines to archive/dearchive from an XML Environment.

void DtRwNLengthStringVector::clear ( )
inline

References mySetStrings, and myStrings.

virtual DtString DtRwNLengthStringVector::prettyPrint ( ) const
virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

Member Data Documentation

std::vector<DtString> DtRwNLengthStringVector::myStrings
protected

Referenced by clear(), and strings().

std::set<std::string> DtRwNLengthStringVector::mySetStrings
protected

Referenced by clear().

The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)