DtSwingingPartActuatorDescriptor Class Reference

DtSwingingPartActuatorDescriptor is the descriptor for DtSwingingPartActuator components. More...

Inheritance diagram for DtSwingingPartActuatorDescriptor:

List of all members.

Public Member Functions
	DtSwingingPartActuatorDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtSwingingPartActuatorDescriptor (const DtSwingingPartActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtSwingingPartActuatorDescriptor &	operator= (const DtSwingingPartActuatorDescriptor &orig)
	Assignment operator.
virtual	~DtSwingingPartActuatorDescriptor ()
	Destructor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	Returns a copy of this class using the copy constructor.
virtual DtString	type () const
	Returns swinging-part-actuator-descriptor.
virtual double	closedAngle () const
	Accessor/mutator for myClosedAngle.
virtual void	setClosedAngle (const double &newValue)
	Accessor/mutator for myClosedAngle.
virtual double	openAngle () const
	Accessor/mutator for myOpenAngle.
virtual void	setOpenAngle (const double &newValue)
	Accessor/mutator for myOpenAngle.
virtual DtString	swingAxis () const
	Accessor/mutator for mySwingAxis.
virtual void	setSwingAxis (const DtString &newValue)
	Accessor/mutator for mySwingAxis.
virtual double	swingRate () const
	Accessor/mutator for mySwingRate.
virtual void	setSwingRate (const double &newValue)
	Accessor/mutator for mySwingRate.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
	Static creator function for factory registration.
Protected Attributes
parameters
Parameter Name: closed-angle Parameter Description: Rotation angle in radians which represents the rotation value when the part is closed. Parameter Default Value: 0.0
DtRwReal	myClosedAngle
	Parameter Name: open-angle Parameter Description: Rotation angle in radians which represents the rotation value when the part is open.
DtRwReal	myOpenAngle
	Parameter Name: open-angle Parameter Description: Rotation angle in radians which represents the rotation value when the part is open.
DtRwString	mySwingAxis
	Parameter Name: swing-axis Parameter Description: Axis about which the part swings.
DtRwReal	mySwingRate
	Parameter Name: swing-rate Parameter Description: Rate at which the part swings in radians per second.

---

Detailed Description

DtSwingingPartActuatorDescriptor is the descriptor for DtSwingingPartActuator components.

It contains all parameters which can be specified in the OPD file for this component. For an example of using a swinging part actuator and how it is described in an OPD file see fixed-wing-fighter-jet.sysdef in the systems/movement folder.

---

Constructor & Destructor Documentation

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

Constructor.

DtSwingingPartActuatorDescriptor::DtSwingingPartActuatorDescriptor	(	const DtSwingingPartActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Copy constructor.

virtual DtSwingingPartActuatorDescriptor::~DtSwingingPartActuatorDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtSwingingPartActuatorDescriptor& DtSwingingPartActuatorDescriptor::operator=

(

const DtSwingingPartActuatorDescriptor &

orig

)

Assignment operator.

virtual DtComponentDescriptor* DtSwingingPartActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns a copy of this class using the copy constructor.

Reimplemented from DtActuatorComponentDescriptor.

virtual DtString DtSwingingPartActuatorDescriptor::type

(

)

const [virtual]

Returns swinging-part-actuator-descriptor.

Reimplemented from DtActuatorComponentDescriptor.

static DtComponentDescriptor* DtSwingingPartActuatorDescriptor::creator

(

)

[static]

Static creator function for factory registration.

Reimplemented from DtActuatorComponentDescriptor.

virtual double DtSwingingPartActuatorDescriptor::closedAngle

(

)

const [virtual]

Accessor/mutator for myClosedAngle.

virtual void DtSwingingPartActuatorDescriptor::setClosedAngle

(

const double &

newValue

)

[virtual]

Accessor/mutator for myClosedAngle.

virtual double DtSwingingPartActuatorDescriptor::openAngle

(

)

const [virtual]

Accessor/mutator for myOpenAngle.

virtual void DtSwingingPartActuatorDescriptor::setOpenAngle

(

const double &

newValue

)

[virtual]

Accessor/mutator for myOpenAngle.

virtual DtString DtSwingingPartActuatorDescriptor::swingAxis

(

)

const [virtual]

Accessor/mutator for mySwingAxis.

virtual void DtSwingingPartActuatorDescriptor::setSwingAxis

(

const DtString &

newValue

)

[virtual]

Accessor/mutator for mySwingAxis.

virtual double DtSwingingPartActuatorDescriptor::swingRate

(

)

const [virtual]

Accessor/mutator for mySwingRate.

virtual void DtSwingingPartActuatorDescriptor::setSwingRate

(

const double &

newValue

)

[virtual]

Accessor/mutator for mySwingRate.

---

Member Data Documentation

DtRwReal DtSwingingPartActuatorDescriptor::myClosedAngle [protected]

Parameter Name: open-angle
Parameter Description: Rotation angle in radians which represents the rotation value when the part is open.

Parameter Default Value: 1.57

DtRwReal DtSwingingPartActuatorDescriptor::myOpenAngle [protected]

Parameter Name: open-angle
Parameter Description: Rotation angle in radians which represents the rotation value when the part is open.

Parameter Default Value: 1.57

DtRwString DtSwingingPartActuatorDescriptor::mySwingAxis [protected]

Parameter Name: swing-axis
Parameter Description: Axis about which the part swings.

Possible values are "X", "Y" and "Z". Parameter Default Value: "Z"

DtRwReal DtSwingingPartActuatorDescriptor::mySwingRate [protected]

Parameter Name: swing-rate
Parameter Description: Rate at which the part swings in radians per second.

Parameter Default Value: 0.175

---

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

• include/vrfobjparam/swingingPartActuatorDesc.h