DtGroundVehicleParameters Class Reference

Contains the set of readable/writeable parameters associated with a ground vehicle entity. More...

Inheritance diagram for DtGroundVehicleParameters:

List of all members.

Public Member Functions
	DtGroundVehicleParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	Constructor with parameters to set up read/writability correctly.
	DtGroundVehicleParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
const DtGroundVehicleParameters &	operator= (const DtGroundVehicleParameters &orig)
virtual	~DtGroundVehicleParameters ()
	destructor
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfObjectParameters *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor)
	Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (
virtual const DtVector &	rearSupport () const
virtual void	setRearSupport (const DtVector &rearSupport)
virtual DtSoilFactors *	lookupSoilFactors (const DtString &soilType)
virtual void	addSoilFactors (DtSoilFactors *soilFactors)
virtual void	removeSoilFactors (DtSoilFactors *soilFactors)
virtual DtString	type () const
	Should return the type of entity this is a parameter block for.
virtual void	inheritValuesFromThisType (const DtGroundVehicleParameters *benefactor)
virtual const DtSoilList &	soilList () const
	Accessor for mySoilList.
virtual DtSoilList &	soilList ()
	Accessor for mySoilList.
Static Public Member Functions
static DtVrfObjectParameters *	creator ()
Protected Member Functions
	DtGroundVehicleParameters (const DtGroundVehicleParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtGroundVehicleParameters (const DtGroundVehicleParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtSoilList	mySoilList
	Parameter Name: soil-list Parameter Description: List of soil factor parameters.

---

Detailed Description

Contains the set of readable/writeable parameters associated with a ground vehicle entity.

Developer Description: Used to hold parameters for the DtGroundVehicleStateRepository class.

---

Constructor & Destructor Documentation

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

Constructor with parameters to set up read/writability correctly.

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

DtGroundVehicleParameters::DtGroundVehicleParameters	(	const DtGroundVehicleParameters &	orig,
		const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[protected]

copy constructor

DtGroundVehicleParameters::DtGroundVehicleParameters	(	const DtGroundVehicleParameters &	orig,
		const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		[protected]

virtual DtGroundVehicleParameters::~DtGroundVehicleParameters

(

)

[virtual]

destructor

---

Member Function Documentation

const DtGroundVehicleParameters& DtGroundVehicleParameters::operator=

(

const DtGroundVehicleParameters &

orig

)

virtual DtVrfObjectParameters* DtGroundVehicleParameters::clone	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtIndividualLifeFormParameters.

virtual DtVrfObjectParameters* DtGroundVehicleParameters::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

Reimplemented from DtMovingObjectParameters.

virtual bool DtGroundVehicleParameters::inheritValues

(

const DtVrfObjectParameters *

benefactor

)

[virtual]

Values left unspecified may be inherited from a parameter block of the same type, typically an ancestor in the DIS/RPR entity type hierarchy. (

For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from. ( const DtVrfObjectParameters* benefactor)

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtIndividualLifeFormParameters.

virtual const DtSoilList& DtGroundVehicleParameters::soilList

(

)

const [virtual]

Accessor for mySoilList.

virtual DtSoilList& DtGroundVehicleParameters::soilList

(

)

[virtual]

Accessor for mySoilList.

virtual const DtVector& DtGroundVehicleParameters::rearSupport

(

)

const [virtual]

virtual void DtGroundVehicleParameters::setRearSupport

(

const DtVector &

rearSupport

)

[virtual]

virtual DtSoilFactors* DtGroundVehicleParameters::lookupSoilFactors

(

const DtString &

soilType

)

[virtual]

virtual void DtGroundVehicleParameters::addSoilFactors

(

DtSoilFactors *

soilFactors

)

[virtual]

virtual void DtGroundVehicleParameters::removeSoilFactors

(

DtSoilFactors *

soilFactors

)

[virtual]

virtual DtString DtGroundVehicleParameters::type

(

)

const [virtual]

Should return the type of entity this is a parameter block for.

Use the strings in vrfParamTypes.h.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtIndividualLifeFormParameters.

virtual void DtGroundVehicleParameters::inheritValuesFromThisType

(

const DtGroundVehicleParameters *

benefactor

)

[virtual]

static DtVrfObjectParameters* DtGroundVehicleParameters::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtMovingObjectParameters.

Reimplemented in DtIndividualLifeFormParameters.

---

Member Data Documentation

DtSoilList DtGroundVehicleParameters::mySoilList [protected]

Parameter Name: soil-list
Parameter Description: List of soil factor parameters.

Each soil factor has a name that identifies the soil type, which is one of:

• paved-road
• hard-packed
• rocks
• sand
• gravel
• shallow-water
• muck
• deep-water. The name is followed by 3 sub-parameters:
• acceleration-factor: (Optional) This value for the specified soil type is multiplied by the max-acceleration for the entity to determine the maximum acceleration for this soil type. Default: 1.0 (real number)
• stopping-factor: (Optional) This value for the specified soil type is multiplied by the max-deceleration for the entity to determine the maximum deceleration for this soil type. Default: 1.0 (real number)
• max-speed-factor: (Optional) This value for the specified soil type is multiplied by the max-speed for the entity to determine the max speed for this soil type. Default: 1.0 (real number)

---

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

• include/vrfobjparam/gndVehPar.h