DtRwNLengthStringVector Class Reference

DtRwNLengthStringVector is a named, readable/writable vector of strings of arbitrary length. More...

Inheritance diagram for DtRwNLengthStringVector:

Public Member Functions
	DtRwNLengthStringVector (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwNLengthStringVector (const std::vector< DtString > &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
	comparison operator case sensitive comparison of string lists does not take parent DtReaderWriter values into consideration
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
	compare() Compare contents of this list with orig if same, return true, otherwise false By default, this is a case-sensitive comparison.
virtual void	setSize (unsigned int length)
	Sets the size of the list.
virtual unsigned int	size () const
virtual int	indexOfValue (const DtString &value) const
virtual bool	containsValue (const DtString &value) const
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual void	add (const DtString &)
	Adds a new string to the myStrings vector.
virtual void	remove (int iIndex)
	Removes a string at the specified index (if the index is valid)
const std::vector< DtString > &	strings () const
void	clear ()
virtual DtString	prettyPrint () const
	Routine to return a human readable form of this variable.
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 ()
	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 DtReaderWriter &	operator= (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 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 aliasContainer &	aliases () 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 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
std::vector< DtString >	myStrings
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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

Detailed Description

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.

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::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.

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 ( FILE *  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 DtFilename &  searchPath, 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)

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

inline

References myStrings.

void DtRwNLengthStringVector::clear ( )

inline

References 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().

---

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

• include/vrfutil/rwNLengthStringVector.h