DtSoilList Class Reference

class DtSoilList: More...

Inheritance diagram for DtSoilList:

Public Member Functions
	DtSoilList ()
	default constructor
	DtSoilList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	readable/writable constructor
	DtSoilList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtSoilList ()
	destructor
	DtSoilList (const DtString &name, const DtSoilList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtSoilList (const DtSymbolString &name, const DtSoilList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSoilList &	operator= (const DtSoilList &orig)
	assignment operator
virtual DtSoilList *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtSoilList *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtSoilFactors *	lookupSoilFactors (const DtString &soilType)
virtual DtSoilFactors *	lookupSoilFactors (const DtSymbolString &soilType)
virtual const DtSoilFactors *	lookupSoilFactors (const DtString &soilType) const
virtual const DtSoilFactors *	lookupSoilFactors (const DtSymbolString &soilType) const
virtual DtSoilFactors *	addSoilFactors (const DtSoilFactors &factors)
virtual void	removeSoilFactors (const DtString &soilType)
virtual void	removeSoilFactors (const DtSymbolString &soilType)
virtual void	copyList (const DtSoilList &orig)
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 DtRwList &	operator= (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.
	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 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	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 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
virtual void	emptyList ()
	Used by the destructor.
virtual DtSoilFactors *	addSoilFactors (DtSoilFactors *factors)
virtual void	removeSoilFactors (DtSoilFactors *factors)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Constructs a soil factor, and then reads relevant data from the stream.
virtual DtListItem *	lookupSoilFactorsItem (const DtString &soilType)
virtual DtListItem *	lookupSoilFactorsItem (const DtSymbolString &soilType)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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
DtHashlist	myHashIndex

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

Detailed Description

class DtSoilList:

Instances of DtSoilList are readable/writeable lists of DtSoilFactors.

Constructor & Destructor Documentation

DtSoilList::DtSoilList

(

)

default constructor

DtSoilList::DtSoilList	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

readable/writable constructor

DtSoilList::DtSoilList	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtSoilList::~DtSoilList ( )

virtual

destructor

DtSoilList::DtSoilList	(	const DtString &	name,
		const DtSoilList &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtSoilList::DtSoilList	(	const DtSymbolString &	name,
		const DtSoilList &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Member Function Documentation

DtSoilList& DtSoilList::operator=

(

const DtSoilList &

orig

)

assignment operator

virtual DtSoilList* DtSoilList::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  )

virtual

virtual DtSoilList* DtSoilList::clone ( const DtSymbolString &  name, DtReaderWriterRegistry *  parentRegistry = NULL  )

virtual

virtual DtSoilFactors* DtSoilList::lookupSoilFactors ( const DtString &  soilType )

virtual

virtual DtSoilFactors* DtSoilList::lookupSoilFactors ( const DtSymbolString &  soilType )

virtual

virtual const DtSoilFactors* DtSoilList::lookupSoilFactors ( const DtString &  soilType ) const

virtual

virtual const DtSoilFactors* DtSoilList::lookupSoilFactors ( const DtSymbolString &  soilType ) const

virtual

virtual DtSoilFactors* DtSoilList::addSoilFactors ( const DtSoilFactors &  factors )

virtual

virtual void DtSoilList::removeSoilFactors ( const DtString &  soilType )

virtual

virtual void DtSoilList::removeSoilFactors ( const DtSymbolString &  soilType )

virtual

virtual void DtSoilList::copyList ( const DtSoilList &  orig )

virtual

virtual void DtSoilList::emptyList ( )

protectedvirtual

Used by the destructor.

It removes and DELETES all soilFactors on the soil list.

virtual DtSoilFactors* DtSoilList::addSoilFactors ( DtSoilFactors *  factors )

protectedvirtual

virtual void DtSoilList::removeSoilFactors ( DtSoilFactors *  factors )

protectedvirtual

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

protectedvirtual

Constructs a soil factor, and then reads relevant data from the stream.

Implements DtRwList.

virtual DtListItem* DtSoilList::lookupSoilFactorsItem ( const DtString &  soilType )

protectedvirtual

virtual DtListItem* DtSoilList::lookupSoilFactorsItem ( const DtSymbolString &  soilType )

protectedvirtual

virtual const char* DtSoilList::readerWriterType ( ) const

protectedvirtual

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

Member Data Documentation

DtHashlist DtSoilList::myHashIndex

protected

---

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

• include/vrfutil/soilList.h