DtSurfaceEntityStateRepository Class Reference

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

Inheritance diagram for DtSurfaceEntityStateRepository:

List of all members.

Public Member Functions
	DtSurfaceEntityStateRepository (DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	Constructor with parameters to set up read/writability correctly.
	DtSurfaceEntityStateRepository (const DtSurfaceEntityStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSurfaceEntityStateRepository &	operator= (const DtSurfaceEntityStateRepository &orig)
	assignment operator
virtual	~DtSurfaceEntityStateRepository ()
	destructor
virtual DtString	type () const
virtual bool	init ()
	Our 'virtual' constructor. Calls all the create<>() methods.
virtual const int	vrfMovingObjectStateRepositorySubType () const
virtual const int	surfaceEntityStateRepositorySubType () const
virtual bool	createParameters ()
virtual void	initializeFromParameters ()
virtual const DtSurfaceEntityParameters *	surfaceEntityParameters () const
virtual const DtVector &	throttleAcceleration ()
	Acceleration due to throttle in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateThrottleAcceleration()
virtual void	setThrottleAcceleration (const DtVector &throttle)
virtual const DtVector &	dragAcceleration ()
	Acceleration due to drag in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateDragAcceleration()
virtual void	setDragAcceleration (const DtVector &drag)
virtual double	rudderYawAcceleration ()
	Yaw acceleration due to rudder in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateRudderYawAcceleration()
virtual void	setRudderYawAcceleration (double rudder)
virtual double	resistanceYawAcceleration ()
	Yaw acceleration due to drag in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateResistanceYawAcceleration()
virtual void	setResistanceYawAcceleration (double resistance)
Static Public Member Functions
static DtVrfObjectStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, const DtObjectType &objectType, DtVrfObjectParameters *parameters, DtReaderWriterRegistry *parentRegistry)
static DtSurfaceEntityStateRepository *	isSurfaceEntityStateRepository (DtVrfObjectStateRepository *repository)
static const DtSurfaceEntityStateRepository *	isSurfaceEntityStateRepository (const DtVrfObjectStateRepository *repository)
Protected Member Functions
	DtSurfaceEntityStateRepository ()
	default constructor cannot be used
Protected Attributes
DtVector	myThrottleAcceleration
	Acceleration due to throttle in body coordinates.
DtVector	myDragAcceleration
	Acceleration due to drag in body coordinates.
double	myRudderYawAcceleration
	Yaw acceleration due to rudder in body coordinates as calculated and set by.
double	myResistanceYawAcceleration
	Yaw acceleration due to drag in body coordinates as calculated and set by.

---

Detailed Description

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

It contains a pointer to the surface entity parameters, and provides accessors and mutators for all parameter values.

---

Constructor & Destructor Documentation

DtSurfaceEntityStateRepository::DtSurfaceEntityStateRepository

(

)

[protected]

default constructor cannot be used

DtSurfaceEntityStateRepository::DtSurfaceEntityStateRepository	(	DtVrfObject *	vrfObject,
		const DtObjectType &	objectType,
		DtVrfObjectParameters *	parameters,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor with parameters to set up read/writability correctly.

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

copy constructor

virtual DtSurfaceEntityStateRepository::~DtSurfaceEntityStateRepository

(

)

[virtual]

destructor

---

Member Function Documentation

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

Reimplemented from DtVrfMovingObjectStateRepository.

const DtSurfaceEntityStateRepository& DtSurfaceEntityStateRepository::operator=

(

const DtSurfaceEntityStateRepository &

orig

)

assignment operator

virtual DtString DtSurfaceEntityStateRepository::type

(

)

const [virtual]

Returns:

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

Reimplemented from DtVrfMovingObjectStateRepository.

virtual bool DtSurfaceEntityStateRepository::init

(

)

[virtual]

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

Reimplemented from DtVrfObjectStateRepository.

static DtSurfaceEntityStateRepository* DtSurfaceEntityStateRepository::isSurfaceEntityStateRepository

(

DtVrfObjectStateRepository *

repository

)

[static]

Returns:

A pointer to the repository of the appropriate type, if the repository specified is of type DtSurfaceEntityStateRepository, 0 if not.

static const DtSurfaceEntityStateRepository* DtSurfaceEntityStateRepository::isSurfaceEntityStateRepository

(

const DtVrfObjectStateRepository *

repository

)

[static]

virtual const int DtSurfaceEntityStateRepository::vrfMovingObjectStateRepositorySubType

(

)

const [virtual]

Returns:

DtVrfMovingObjectStateRepositorySubTypeSurface.

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const int DtSurfaceEntityStateRepository::surfaceEntityStateRepositorySubType

(

)

const [virtual]

Returns:

DtSurfaceEntityStateRepositorySubTypeBase.

virtual bool DtSurfaceEntityStateRepository::createParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

virtual void DtSurfaceEntityStateRepository::initializeFromParameters

(

)

[virtual]

Reimplemented from DtVrfMovingObjectStateRepository.

virtual const DtSurfaceEntityParameters* DtSurfaceEntityStateRepository::surfaceEntityParameters

(

)

const [virtual]

virtual const DtVector& DtSurfaceEntityStateRepository::throttleAcceleration

(

)

[virtual]

Acceleration due to throttle in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateThrottleAcceleration()

virtual void DtSurfaceEntityStateRepository::setThrottleAcceleration

(

const DtVector &

throttle

)

[virtual]

virtual const DtVector& DtSurfaceEntityStateRepository::dragAcceleration

(

)

[virtual]

Acceleration due to drag in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateDragAcceleration()

virtual void DtSurfaceEntityStateRepository::setDragAcceleration

(

const DtVector &

drag

)

[virtual]

virtual double DtSurfaceEntityStateRepository::rudderYawAcceleration

(

)

[virtual]

Yaw acceleration due to rudder in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateRudderYawAcceleration()

virtual void DtSurfaceEntityStateRepository::setRudderYawAcceleration

(

double

rudder

)

[virtual]

virtual double DtSurfaceEntityStateRepository::resistanceYawAcceleration

(

)

[virtual]

Yaw acceleration due to drag in body coordinates as calculated and set by DtSurfaceEntityActuator::calculateResistanceYawAcceleration()

virtual void DtSurfaceEntityStateRepository::setResistanceYawAcceleration

(

double

resistance

)

[virtual]

---

Member Data Documentation

DtVector DtSurfaceEntityStateRepository::myThrottleAcceleration [protected]

Acceleration due to throttle in body coordinates.

DtVector DtSurfaceEntityStateRepository::myDragAcceleration [protected]

Acceleration due to drag in body coordinates.

double DtSurfaceEntityStateRepository::myRudderYawAcceleration [protected]

Yaw acceleration due to rudder in body coordinates as calculated and set by.

double DtSurfaceEntityStateRepository::myResistanceYawAcceleration [protected]

Yaw acceleration due to drag in body coordinates as calculated and set by.

---

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

• include/vrfobjcore/surfEntSR.h