DtRwNLengthStringVector Class Reference

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

Inheritance diagram for DtRwNLengthStringVector:

List of all members.

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)
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 &	operator[] (unsigned int index)
virtual const DtString &	operator[] (unsigned int index) const
virtual DtString	at (unsigned int index) const
Protected Attributes
std::vector< DtString >	myStrings

---

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]

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.

---

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