class DtSoilFactors:

Instances of DtSoilFactors are readable/writeable objects which represent a soil type and its effect on acceleration, stopping, and max speed.

Inheritance diagram for DtSoilFactors:

[legend]

Public Member Functions
	DtSoilFactors (const DtString &soilType, DtReaderWriterRegistry *parentRegistry=NULL, double accelerationFactor=1.0, double stoppingFactor=1.0, double maxSpeedFactor=1.0)

	DtSoilFactors (const DtSymbolString &soilType, DtReaderWriterRegistry *parentRegistry=NULL, double accelerationFactor=1.0, double stoppingFactor=1.0, double maxSpeedFactor=1.0)

virtual	~DtSoilFactors () override

	DtSoilFactors (const DtSoilFactors &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtSoilFactors &	operator= (const DtSoilFactors &orig)

virtual DtSoilFactors *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

virtual const DtSymbolString	soilType () const

virtual void	setAccelerationFactor (DtReal aFactor)

virtual const DtRwReal &	accelerationFactor () const

virtual void	setStoppingFactor (DtReal sFactor)

virtual const DtRwReal &	stoppingFactor () const

virtual void	setMaxSpeedFactor (DtReal msFactor)

virtual const DtRwReal &	maxSpeedFactor () const

virtual void	inheritValues (const DtSoilFactors &orig)

virtual const char *	readerWriterType () const override

bool	operator== (const DtSoilFactors &) 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	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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, 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)

Protected Member Functions
	DtSoilFactors ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtListItem *	myListItem

DtRwReal	myAccelerationFactor

DtRwReal	myStoppingFactor

DtRwReal	myMaxSpeedFactor

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	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) override

virtual const char *	xmlType () const override

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

DtSoilFactors::DtSoilFactors ( )

protected

Default constructor; since the name identifies the soil type, this should not be used.

DtSoilFactors::DtSoilFactors	(	const DtString &	soilType,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		double	accelerationFactor = `1.0`,
		double	stoppingFactor = `1.0`,
		double	maxSpeedFactor = `1.0`
	)

real constructor

DtSoilFactors::DtSoilFactors	(	const DtSymbolString &	soilType,
		DtReaderWriterRegistry *	parentRegistry = `NULL`,
		double	accelerationFactor = `1.0`,
		double	stoppingFactor = `1.0`,
		double	maxSpeedFactor = `1.0`
	)

virtual DtSoilFactors::~DtSoilFactors ( )

overridevirtual

destructor

DtSoilFactors::DtSoilFactors	(	const DtSoilFactors &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

Member Function Documentation

DtSoilFactors& DtSoilFactors::operator= ( const DtSoilFactors & orig )

assignment operator

virtual DtSoilFactors* DtSoilFactors::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

virtual

virtual void DtSoilFactors::setListItem ( DtListItem * item )

virtual

Used by DtSoilList.

virtual DtListItem* DtSoilFactors::listItem ( )

virtual

virtual const DtSymbolString DtSoilFactors::soilType ( ) const

virtual

soilType is an alias for name().

virtual void DtSoilFactors::setAccelerationFactor ( DtReal aFactor )

virtual

Accessors for these return rwReal so we can check setValueSpecified().

virtual const DtRwReal& DtSoilFactors::accelerationFactor ( ) const

virtual

virtual void DtSoilFactors::setStoppingFactor ( DtReal sFactor )

virtual

virtual const DtRwReal& DtSoilFactors::stoppingFactor ( ) const

virtual

virtual void DtSoilFactors::setMaxSpeedFactor ( DtReal msFactor )

virtual

virtual const DtRwReal& DtSoilFactors::maxSpeedFactor ( ) const

virtual

virtual void DtSoilFactors::inheritValues ( const DtSoilFactors & orig )

virtual

This is an alternate form of assignment wherein we only assign a value to one of our members if valueSpecified() is false and valueSpecified is true for that member in orig.

virtual const char* DtSoilFactors::readerWriterType ( ) const

overridevirtual

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

bool DtSoilFactors::operator== ( const DtSoilFactors & ) const

virtual void DtSoilFactors::putData	(	DtEnvironmentSP	,
		DtEnvValueSP	parent
	)		const

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

virtual void DtSoilFactors::getData	(	const DtEnvironmentSP	,
		const DtEnvValueSP	value,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

static const char* DtSoilFactors::theXmlType ( )

static

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

virtual const char* DtSoilFactors::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtListItem* DtSoilFactors::myListItem

protected

DtRwReal DtSoilFactors::myAccelerationFactor

protected

DtRwReal DtSoilFactors::myStoppingFactor

protected

DtRwReal DtSoilFactors::myMaxSpeedFactor

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/soilFactors.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation