DtSoilFactorsMetaDataEntry Class Reference

DtSoilFactorsMetaDataEntry.

Meta data entry for systems that include soil factors as part of their definition.

Note

More than one system with soil factors should not be included on an entity, because the one that will be used is not determined.

Inheritance diagram for DtSoilFactorsMetaDataEntry:

Public Member Functions
	DtSoilFactorsMetaDataEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSoilFactorsMetaDataEntry (const DtString &name, const DtSoilFactorsMetaDataEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSoilFactorsMetaDataEntry &	operator= (const DtSoilFactorsMetaDataEntry &orig)
virtual	~DtSoilFactorsMetaDataEntry ()
virtual DtString	entryType () const
virtual DtSystemMetaDataEntry *	clone () const
virtual bool	compare (const DtSystemMetaDataEntry &) const
virtual const DtSoilList &	soilFactors () const
virtual DtSoilList &	soilFactors ()
Public Member Functions inherited from DtSystemMetaDataEntry
	DtSystemMetaDataEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSystemMetaDataEntry (const DtString &name, const DtSystemMetaDataEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSystemMetaDataEntry &	operator= (const DtSystemMetaDataEntry &orig)
virtual	~DtSystemMetaDataEntry ()
bool	operator== (const DtSystemMetaDataEntry &) 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)
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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
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 &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
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 DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSystemMetaDataEntry *	create (const DtString &name)
Static Public Member Functions inherited from DtSystemMetaDataEntry
static DtSystemMetaDataEntry *	createMetaDataEntry (const DtString &type)
static DtSystemMetaDataEntryFactory *	factory ()
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 Attributes
DtSoilList	mySoilFactors
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

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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSystemMetaDataEntry
static std::auto_ptr < DtSystemMetaDataEntryFactory >	theFactory
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

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

DtSoilFactorsMetaDataEntry::DtSoilFactorsMetaDataEntry	(	const DtString &	name,
		const DtSoilFactorsMetaDataEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtSoilFactorsMetaDataEntry::~DtSoilFactorsMetaDataEntry ( )

virtual

Member Function Documentation

DtSoilFactorsMetaDataEntry& DtSoilFactorsMetaDataEntry::operator=

(

const DtSoilFactorsMetaDataEntry &

orig

)

virtual DtString DtSoilFactorsMetaDataEntry::entryType ( ) const

virtual

Returns

The type string for this entry. Comes from systemMetaDataEntryTypes.h.

Implements DtSystemMetaDataEntry.

virtual const DtSoilList& DtSoilFactorsMetaDataEntry::soilFactors ( ) const

virtual

See Also

mySoilFactors

virtual DtSoilList& DtSoilFactorsMetaDataEntry::soilFactors ( )

virtual

See Also

mySoilFactors

virtual DtSystemMetaDataEntry* DtSoilFactorsMetaDataEntry::clone ( ) const

virtual

Implements DtSystemMetaDataEntry.

static DtSystemMetaDataEntry* DtSoilFactorsMetaDataEntry::create ( const DtString &  name )

static

virtual bool DtSoilFactorsMetaDataEntry::compare ( const DtSystemMetaDataEntry &  ) const

virtual

Implements DtSystemMetaDataEntry.

Member Data Documentation

DtSoilList DtSoilFactorsMetaDataEntry::mySoilFactors

protected

The list of DtSoilFactors that will be used to determine how the entity moves along the various soil type.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/soilFactorsMetaDataEntry.h