DtMountingElevationActuator Class Reference

DtMountingElevationActuator is a simple model of elevating a mounting point. More...

Inheritance diagram for DtMountingElevationActuator:

List of all members.

Public Member Functions
	DtMountingElevationActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtMountingElevationActuator ()
	destructor
virtual bool	postAddComponentsInit ()
	Overridden to set the values on myAzimuthInfoPortGroup.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Calculate new kinematic state.
virtual void	setMaxElevateRate (DtReal maxElevateRate)
virtual DtReal	maxElevateRate () const
virtual void	setNominalElevation (DtReal nominalElevation)
virtual DtReal	nominalElevation () const
virtual void	setElevationRange (DtReal elevationRange)
virtual DtReal	elevationRange () const
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
static double	computeDeltaOutsideElevationRange (double nominalElevation, double elevationRange, double angleUnderTest)
	Returns the number of radians that the angleUnderTest is outside of the specified elevation range.
Protected Member Functions
virtual bool	createPortGroups ()
	Overridden to create azimuth port groups.
virtual bool	createPorts ()
	Overridden to create azimuth ports.
	DtMountingElevationActuator ()
	default constructor; not implemented
	DtMountingElevationActuator (const DtMountingElevationActuator &orig)
	copy constructor; not implemented
const DtMountingElevationActuator &	operator= (const DtMountingElevationActuator &orig)
	assignment operator; not implemented
Protected Attributes
const DtElevationMountComponentDescriptor *	myElevationCompDesc
DtReal	myMaxElevateRate
DtReal	myNominalElevation
DtReal	myElevationRange
DtArticulatedPartStateRepository *	myRotatingBody
Ports and Port Groups
DtConstrainedAnalogInputPort *	myElevationPort
	Input Port Name: elevation Input Port Description: Input Port Range: -1.
DtOutputPortGroup *	myElevationInfoPortGroup
	Output Port Group Name: mounting-info Output Port Group Description:
DtAnalogOutputPort *	myNominalElevationPort
	Output Port Name: nominal-elevation Output Port Description: Nominal elevation value.
DtAnalogOutputPort *	myElevationRangePort
	Output Port Name: elevation-range Output Port Description: Elevation sweep range.
DtAnalogOutputPort *	myMaxElevationRatePort
	Output Port Name: elevation-rate Output Port Description: Maximum elevation rate.
DtIntegerOutputPort *	myElevationPartTypePort
	Output Port Name: elevation-part-type Output Port Description: Type of articulated part.

---

Detailed Description

DtMountingElevationActuator is a simple model of elevating a mounting point.

Uses Descriptor Type: DtElevationMountComponentDescriptor

---

Constructor & Destructor Documentation

DtMountingElevationActuator::DtMountingElevationActuator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtMountingElevationActuator::~DtMountingElevationActuator

(

)

[virtual]

destructor

DtMountingElevationActuator::DtMountingElevationActuator

(

)

[protected]

default constructor; not implemented

DtMountingElevationActuator::DtMountingElevationActuator

(

const DtMountingElevationActuator &

orig

)

[protected]

copy constructor; not implemented

---

Member Function Documentation

virtual bool DtMountingElevationActuator::postAddComponentsInit

(

)

[virtual]

Overridden to set the values on myAzimuthInfoPortGroup.

Reimplemented from DtSimComponent.

virtual DtString DtMountingElevationActuator::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtElevationMountActuatorType

Reimplemented from DtSimComponent.

virtual void DtMountingElevationActuator::tick

(

)

[virtual]

Calculate new kinematic state.

Reimplemented from DtSimComponent.

virtual void DtMountingElevationActuator::setMaxElevateRate

(

DtReal

maxElevateRate

)

[virtual]

virtual DtReal DtMountingElevationActuator::maxElevateRate

(

)

const [virtual]

virtual void DtMountingElevationActuator::setNominalElevation

(

DtReal

nominalElevation

)

[virtual]

virtual DtReal DtMountingElevationActuator::nominalElevation

(

)

const [virtual]

virtual void DtMountingElevationActuator::setElevationRange

(

DtReal

elevationRange

)

[virtual]

virtual DtReal DtMountingElevationActuator::elevationRange

(

)

const [virtual]

static DtSimComponent* DtMountingElevationActuator::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

static double DtMountingElevationActuator::computeDeltaOutsideElevationRange	(	double	nominalElevation,
		double	elevationRange,
		double	angleUnderTest
	)		[static]

Returns the number of radians that the angleUnderTest is outside of the specified elevation range.

A return value of zero indicates the angleUnderTest is within the elevationRange centered at nominalElevation. This method assumes angleUnderTest is between +90deg and -90deg.

virtual bool DtMountingElevationActuator::createPortGroups

(

)

[protected, virtual]

Overridden to create azimuth port groups.

Reimplemented from DtSimComponent.

virtual bool DtMountingElevationActuator::createPorts

(

)

[protected, virtual]

Overridden to create azimuth ports.

Reimplemented from DtSimComponent.

const DtMountingElevationActuator& DtMountingElevationActuator::operator=

(

const DtMountingElevationActuator &

orig

)

[protected]

assignment operator; not implemented

---

Member Data Documentation

DtConstrainedAnalogInputPort* DtMountingElevationActuator::myElevationPort [protected]

Input Port Name: elevation
Input Port Description:
Input Port Range: -1.

to 1.
Input Port Default Value:
Input Group Parent:

DtOutputPortGroup* DtMountingElevationActuator::myElevationInfoPortGroup [protected]

Output Port Group Name: mounting-info
Output Port Group Description:

DtAnalogOutputPort* DtMountingElevationActuator::myNominalElevationPort [protected]

Output Port Name: nominal-elevation
Output Port Description: Nominal elevation value.

Output Port Range:
Output Port Default Value:
Output Group Parent: mounting-info

DtAnalogOutputPort* DtMountingElevationActuator::myElevationRangePort [protected]

Output Port Name: elevation-range
Output Port Description: Elevation sweep range.

Output Port Range:
Output Port Default Value:
Output Group Parent: mounting-info

DtAnalogOutputPort* DtMountingElevationActuator::myMaxElevationRatePort [protected]

Output Port Name: elevation-rate
Output Port Description: Maximum elevation rate.

Output Port Range:
Output Port Default Value:
Output Group Parent: mounting-info

DtIntegerOutputPort* DtMountingElevationActuator::myElevationPartTypePort [protected]

Output Port Name: elevation-part-type
Output Port Description: Type of articulated part.

Output Port Range:
Output Port Default Value:
Output Group Parent: mounting-info

const DtElevationMountComponentDescriptor* DtMountingElevationActuator::myElevationCompDesc [protected]

DtReal DtMountingElevationActuator::myMaxElevateRate [protected]

DtReal DtMountingElevationActuator::myNominalElevation [protected]

DtReal DtMountingElevationActuator::myElevationRange [protected]

DtArticulatedPartStateRepository* DtMountingElevationActuator::myRotatingBody [protected]

---

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

• include/vrfmodel/mountElevAct.h