DtPathSoilFactor Class Reference

A readable-writable entry for data about planning paths over various soil types. More...

Inheritance diagram for DtPathSoilFactor:

Public Member Functions
	DtPathSoilFactor ()
	default constructor
	DtPathSoilFactor (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	constructor
	DtPathSoilFactor (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtPathSoilFactor ()
	destructor
	DtPathSoilFactor (const DtString &name, const DtPathSoilFactor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtPathSoilFactor (const DtSymbolString &name, const DtPathSoilFactor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtPathSoilFactor &	operator= (const DtPathSoilFactor &orig)
	assignment operator
virtual DtString	soilName () const
virtual void	setSoilName (const DtString &v)
virtual double	pathFactor () const
virtual void	setPathFactor (double v)
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	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 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 Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwString	mySoilName
	Parameter Name: soil-name Parameter Description: The name of a soil type.
DtRwReal	myPathFactor
	Parameter Name: path-factor Parameter Description: The factor applied to this soil type when planning a path.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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

Detailed Description

A readable-writable entry for data about planning paths over various soil types.

An instance of this class holds a specific soil type string name and a factor to be applied to that. The factor is a multiplier, where higher values are less-preferred types. A path of length X over a type with factor 1.0 is considered equivalent to a path of length X / 2 over a type with factor 2.0

Constructor & Destructor Documentation

DtPathSoilFactor::DtPathSoilFactor

(

)

default constructor

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

constructor

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

virtual DtPathSoilFactor::~DtPathSoilFactor ( )

virtual

destructor

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

copy constructor

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

Member Function Documentation

DtPathSoilFactor& DtPathSoilFactor::operator=

(

const DtPathSoilFactor &

orig

)

assignment operator

virtual DtString DtPathSoilFactor::soilName ( ) const

virtual

See Also

mySoilName

virtual void DtPathSoilFactor::setSoilName ( const DtString &  v )

virtual

See Also

mySoilName

virtual double DtPathSoilFactor::pathFactor ( ) const

virtual

See Also

myPathFactor

virtual void DtPathSoilFactor::setPathFactor ( double  v )

virtual

See Also

myPathFactor

Member Data Documentation

DtRwString DtPathSoilFactor::mySoilName

protected

Parameter Name: soil-name
Parameter Description: The name of a soil type.

Strings usable in the surfCharMap files are usable here.

DtRwReal DtPathSoilFactor::myPathFactor

protected

Parameter Name: path-factor
Parameter Description: The factor applied to this soil type when planning a path.

Higher numbers indicate lower preference for the soil type. Values must be greater than 0. Parameter Default Value: 1.0

---

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

• include/bhaveMsgs/pathSoilFactor.h