DtGroundVehicleStateRepository Class Reference

Description: This repository holds all information that is common to all the forms of local ground entities within the system. More...

Inheritance diagram for DtGroundVehicleStateRepository:

List of all members.

Public Member Functions
	DtGroundVehicleStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor with parameters to set up read/writability correctly
	DtGroundVehicleStateRepository (const DtGroundVehicleStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtGroundVehicleStateRepository &	operator= (const DtGroundVehicleStateRepository &orig)
	assignment operator
virtual	~DtGroundVehicleStateRepository ()
	destructor
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	Clone.
virtual bool	init ()
	Our 'virtual' constructor. Calls all the create<>() methods.
virtual DtString	type () const
virtual const int	vrfMovingObjectStateRepositorySubType () const
virtual const int	groundEntityStateRepositorySubType () const
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtGroundVehicleParameters *	groundVehicleParameters () const
virtual DtSoilFactors *	lookupSoilFactors (const DtString &soilType)
virtual void	addSoilFactors (DtSoilFactors *soilFactors)
virtual void	removeSoilFactors (DtSoilFactors *soilFactors)
virtual const DtGroundInteractionPt *	rearSupport () const
	These are used to alias the base class otherSupport member - to help remind modelers that the 3rd support point for a ground vehicle is supposed to be to the rear of the vehicle.
virtual DtGroundInteractionPt *	rearSupport ()
virtual void	setRearSupport (const DtVector &rearSupport)
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static DtGroundVehicleStateRepository *	isGroundVehicleStateRepository (DtSimObjectStateRepository *repository)
static const DtGroundVehicleStateRepository *	isGroundVehicleStateRepository (const DtSimObjectStateRepository *repository)
Protected Member Functions
	DtGroundVehicleStateRepository ()
	default constructor cannot be used
Protected Attributes
DtSoilList	mySoilList

---

Detailed Description

Description: This repository holds all information that is common to all the forms of local ground entities within the system.

---

Constructor & Destructor Documentation

DtGroundVehicleStateRepository::DtGroundVehicleStateRepository

(

)

[protected]

default constructor cannot be used

DtGroundVehicleStateRepository::DtGroundVehicleStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor with parameters to set up read/writability correctly

DtGroundVehicleStateRepository::DtGroundVehicleStateRepository	(	const DtGroundVehicleStateRepository &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtGroundVehicleStateRepository::~DtGroundVehicleStateRepository

(

)

[virtual]

destructor

---

Member Function Documentation

const DtGroundVehicleStateRepository& DtGroundVehicleStateRepository::operator=

(

const DtGroundVehicleStateRepository &

orig

)

assignment operator

virtual DtSimObjectStateRepository* DtGroundVehicleStateRepository::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Clone.

Reimplemented from DtVrfMovingObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

virtual bool DtGroundVehicleStateRepository::init

(

)

[virtual]

Our 'virtual' constructor. Calls all the create<>() methods.

Reimplemented from DtVrfObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

virtual DtString DtGroundVehicleStateRepository::type

(

)

const [virtual]

Returns:

The string type of the repository, as defined in vrfSRTypes.h.

Reimplemented from DtVrfMovingObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

virtual const int DtGroundVehicleStateRepository::vrfMovingObjectStateRepositorySubType

(

)

const [virtual]

Returns:

DtVrfMovingObjectStateRepositorySubTypeGround.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtGroundVehicleStateRepository::groundEntityStateRepositorySubType

(

)

const [virtual]

Returns:

DtGroundEntityStateRepositorySubTypeBase.

virtual bool DtGroundVehicleStateRepository::createParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

virtual void DtGroundVehicleStateRepository::initializeFromParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

virtual const DtGroundVehicleParameters* DtGroundVehicleStateRepository::groundVehicleParameters

(

)

const [virtual]

virtual DtSoilFactors* DtGroundVehicleStateRepository::lookupSoilFactors

(

const DtString &

soilType

)

[virtual]

virtual void DtGroundVehicleStateRepository::addSoilFactors

(

DtSoilFactors *

soilFactors

)

[virtual]

virtual void DtGroundVehicleStateRepository::removeSoilFactors

(

DtSoilFactors *

soilFactors

)

[virtual]

virtual const DtGroundInteractionPt* DtGroundVehicleStateRepository::rearSupport

(

)

const [virtual]

These are used to alias the base class otherSupport member - to help remind modelers that the 3rd support point for a ground vehicle is supposed to be to the rear of the vehicle.

virtual DtGroundInteractionPt* DtGroundVehicleStateRepository::rearSupport

(

)

[virtual]

virtual void DtGroundVehicleStateRepository::setRearSupport

(

const DtVector &

rearSupport

)

[virtual]

static DtVrfObjectStateRepository* DtGroundVehicleStateRepository::creator	(	const DtString &	name,
		DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Reimplemented from DtVrfMovingObjectStateRepository.

Reimplemented in DtIndividualLifeFormStateRepository.

static DtGroundVehicleStateRepository* DtGroundVehicleStateRepository::isGroundVehicleStateRepository

(

DtSimObjectStateRepository *

repository

)

[static]

Returns:

A the pointer the repository, if the repository passed in is of type DtGroundVehicleStateRepository, 0 if not.

static const DtGroundVehicleStateRepository* DtGroundVehicleStateRepository::isGroundVehicleStateRepository

(

const DtSimObjectStateRepository *

repository

)

[static]

---

Member Data Documentation

DtSoilList DtGroundVehicleStateRepository::mySoilList [protected]

---

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

• include/vrfobjcore/gndVehSR.h