DtSoilFactorsMetaDataEntry Class Reference

DtSoilFactorsMetaDataEntry. More...

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
	Equivalence operator. Calls virtual compare.
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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.

Static Public Member Functions
static DtSystemMetaDataEntry *	create (const DtString &name)
Static Public Member Functions inherited from DtSystemMetaDataEntry
static DtSystemMetaDataEntry *	createMetaDataEntry (const DtString &type)
	Uses theFactory to create a DtSystemMetaDataEntry subclass of the specified type.
static DtSystemMetaDataEntryFactory *	factory ()
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 void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

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

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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
Static Protected Attributes inherited from DtSystemMetaDataEntry
static std::auto_ptr < DtSystemMetaDataEntryFactory >	theFactory

Detailed Description

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.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/soilFactorsMetaDataEntry.h