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

class DtSoilList:

Instances of DtSoilList are readable/writeable lists of DtSoilFactors.

Inheritance diagram for DtSoilList:
Inheritance graph
[legend]

Classes

struct  SoilFactorsAdder
 

Public Member Functions

 DtSoilList ()
 
 DtSoilList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSoilList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtSoilList ()
 
 DtSoilList (const DtString &name, const DtSoilList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtSoilList (const DtSymbolString &name, const DtSoilList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtSoilList & operator= (const DtSoilList &orig)
 
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)
 
bool operator== (const DtSoilList &) const
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList ()
 
const DtRwList & operator= (const DtRwList &orig)
 
virtual DtListItem * add (DtReaderWriter *data)
 
virtual DtListItem * addWithAlternateName (DtReaderWriter *data, const DtString &name)
 
virtual DtListItem * addToStart (DtReaderWriter *data)
 
virtual DtListItem * addToEnd (DtReaderWriter *data)
 
virtual void * remove (DtReaderWriter *data, DtListItem *item)
 
virtual DtlObjPtr getLocalData (DtlObjPtr args)
 
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 DtListItem * addBefore (DtReaderWriter *data, DtReaderWriter *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void removeAll ()
 
virtual void removeAndDeleteAll ()
 
virtual void reset ()
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
virtual void populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
 DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtString &before)
 
virtual DtListItem * addBefore (DtReaderWriter *data, const DtSymbolString &before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtString &after)
 
virtual DtListItem * addAfter (DtReaderWriter *data, const DtSymbolString &after)
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP parent) 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 int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual DtString prettyPrint () const
 
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 putData (std::string &fp, int indentLevel=0)
 
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 Member Functions

virtual void emptyList ()
 
virtual DtSoilFactors * addSoilFactors (DtSoilFactors *factors)
 
virtual void removeSoilFactors (DtSoilFactors *factors)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual DtListItem * lookupSoilFactorsItem (const DtString &soilType)
 
virtual DtListItem * lookupSoilFactorsItem (const DtSymbolString &soilType)
 
virtual const char * readerWriterType () const
 
- Protected Member Functions inherited from DtRwList
virtual DtListItem * addBefore (DtReaderWriter *data, DtListItem *before)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtListItem *after)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Protected Attributes

DtHashlist myHashIndex
 
- 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 getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual const char * xmlType () const
 
virtual std::set< DtString > supportedXmlTypes () 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 DtRwList
static const char * theXmlType ()
 
- 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)
 
- 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

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
bool DtSoilList::operator== ( const DtSoilList &  ) const
virtual void DtSoilList::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  value,
const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList &  bindings = DtVariableBindingsList() 
)
virtual

Returns the list of xml types supported by this list. Default is DtXMLSoilFactorsType.

Reimplemented from DtRwList.

static const char* DtSoilList::theXmlType ( )
static

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

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

Returns the list of xml types supported by this list. Default is DtXMLSoilFactorsType.

Reimplemented from DtRwList.

References DtRwList::theXmlType().

virtual std::set<DtString> DtSoilList::supportedXmlTypes ( ) const
virtual

Returns the list of xml types supported by this list. Default is DtXMLSoilFactorsType.

Reimplemented from DtRwList.

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 DtReaderWriter::SearchPaths &  searchPaths,
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:
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)