DtSoilFactors Class Reference

class DtSoilFactors: More...

Inheritance diagram for DtSoilFactors:

List of all members.

Public Member Functions
	DtSoilFactors (const DtString &soilType, DtReaderWriterRegistry *parentRegistry=NULL, double accelerationFactor=1.0, double stoppingFactor=1.0, double maxSpeedFactor=1.0)
	real constructor
	DtSoilFactors (const DtSymbolString &soilType, DtReaderWriterRegistry *parentRegistry=NULL, double accelerationFactor=1.0, double stoppingFactor=1.0, double maxSpeedFactor=1.0)
virtual	~DtSoilFactors ()
	destructor
	DtSoilFactors (const DtSoilFactors &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtSoilFactors &	operator= (const DtSoilFactors &orig)
	assignment operator
virtual DtSoilFactors *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setListItem (DtListItem *item)
	Used by DtSoilList.
virtual DtListItem *	listItem ()
virtual const DtSymbolString	soilType () const
	soilType is an alias for name().
virtual void	setAccelerationFactor (DtReal aFactor)
	Accessors for these return rwReal so we can check setValueSpecified().
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)
	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 *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
Protected Member Functions
	DtSoilFactors ()
	Default constructor; since the name identifies the soil type, this should not be used.
Protected Attributes
DtListItem *	myListItem
DtRwReal	myAccelerationFactor
DtRwReal	myStoppingFactor
DtRwReal	myMaxSpeedFactor

---

Detailed Description

class DtSoilFactors:

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

---

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

(

)

[virtual]

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 [virtual]

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.

---

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:

• include/vrfutil/soilFactors.h