DtMountingAzimuthActuator Class Reference

DtMountingAzimuthActuator is a simple model of a rotating mount point. More...

Inheritance diagram for DtMountingAzimuthActuator:

List of all members.

Public Member Functions
	DtMountingAzimuthActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtMountingAzimuthActuator ()
	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	setMaxSlewRate (DtReal maxSlewRate)
virtual DtReal	maxSlewRate () const
virtual void	setNominalAzimuth (DtReal nominalAzimuth)
virtual DtReal	nominalAzimuth () const
virtual void	setAzimuthSweepRange (DtReal azimuthSweepRange)
virtual DtReal	azimuthSweepRange () 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	computeDeltaOutsideAzimuthRange (double nominalAzimuth, double azimuthRange, double angleUnderTest)
	Returns the number of radians that the angleUnderTest is outside of the specified azimuth range.
Protected Member Functions
virtual bool	createPortGroups ()
	Overridden to create azimuth port groups.
virtual bool	createPorts ()
	Overridden to create azimuth ports.
	DtMountingAzimuthActuator ()
	default constructor; not implemented
	DtMountingAzimuthActuator (const DtMountingAzimuthActuator &orig)
	copy constructor; not implemented
const DtMountingAzimuthActuator &	operator= (const DtMountingAzimuthActuator &orig)
	assignment operator; not implemented
Protected Attributes
DtConstrainedAnalogInputPort *	myAzimuthPort
DtAzimuthMountComponentDescriptor *	myAzimuthCompDesc
DtReal	myMaxSlewRate
DtReal	myNominalAzimuth
DtReal	myAzimuthSweep
DtArticulatedPartStateRepository *	myRotatingBody
Ports and Port Groups
DtOutputPortGroup *	myAzimuthInfoPortGroup
	Output Port Group Name: mounting-info Output Port Group Description:
DtAnalogOutputPort *	myNominalAzimuthPort
	Output Port Name: nominal-azimuth Output Port Description: Nominal azimuth value.
DtAnalogOutputPort *	myAzimuthRangePort
	Output Port Name: azimuth-range Output Port Description: Azimuth sweep range.
DtAnalogOutputPort *	myMaxAzimuthRatePort
	Output Port Name: azimuth-rate Output Port Description: Maximum azimuth rate Output Port Range: Output Port Default Value: Output Group Parent: mounting-info.
DtIntegerOutputPort *	myAzimuthPartTypePort
	Output Port Name: azimuth-part-type Output Port Description: Type of articulated part.

---

Detailed Description

DtMountingAzimuthActuator is a simple model of a rotating mount point.

Uses Descriptor Type: DtAzimuthMountComponentDescriptor

---

Constructor & Destructor Documentation

DtMountingAzimuthActuator::DtMountingAzimuthActuator	(	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 DtMountingAzimuthActuator::~DtMountingAzimuthActuator

(

)

[virtual]

destructor

DtMountingAzimuthActuator::DtMountingAzimuthActuator

(

)

[protected]

default constructor; not implemented

DtMountingAzimuthActuator::DtMountingAzimuthActuator

(

const DtMountingAzimuthActuator &

orig

)

[protected]

copy constructor; not implemented

---

Member Function Documentation

virtual bool DtMountingAzimuthActuator::postAddComponentsInit

(

)

[virtual]

Overridden to set the values on myAzimuthInfoPortGroup.

Reimplemented from DtSimComponent.

virtual DtString DtMountingAzimuthActuator::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:

DtAzimuthMountActuatorType

Reimplemented from DtSimComponent.

virtual void DtMountingAzimuthActuator::tick

(

)

[virtual]

Calculate new kinematic state.

Reimplemented from DtSimComponent.

virtual void DtMountingAzimuthActuator::setMaxSlewRate

(

DtReal

maxSlewRate

)

[virtual]

virtual DtReal DtMountingAzimuthActuator::maxSlewRate

(

)

const [virtual]

virtual void DtMountingAzimuthActuator::setNominalAzimuth

(

DtReal

nominalAzimuth

)

[virtual]

virtual DtReal DtMountingAzimuthActuator::nominalAzimuth

(

)

const [virtual]

virtual void DtMountingAzimuthActuator::setAzimuthSweepRange

(

DtReal

azimuthSweepRange

)

[virtual]

virtual DtReal DtMountingAzimuthActuator::azimuthSweepRange

(

)

const [virtual]

static DtSimComponent* DtMountingAzimuthActuator::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 DtMountingAzimuthActuator::computeDeltaOutsideAzimuthRange	(	double	nominalAzimuth,
		double	azimuthRange,
		double	angleUnderTest
	)		[static]

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

A return value of zero indicates the angleUnderTest is within the azimuthRange centered at nominalAzimuth.

virtual bool DtMountingAzimuthActuator::createPortGroups

(

)

[protected, virtual]

Overridden to create azimuth port groups.

Reimplemented from DtSimComponent.

virtual bool DtMountingAzimuthActuator::createPorts

(

)

[protected, virtual]

Overridden to create azimuth ports.

Reimplemented from DtSimComponent.

const DtMountingAzimuthActuator& DtMountingAzimuthActuator::operator=

(

const DtMountingAzimuthActuator &

orig

)

[protected]

assignment operator; not implemented

---

Member Data Documentation

DtConstrainedAnalogInputPort* DtMountingAzimuthActuator::myAzimuthPort [protected]

DtOutputPortGroup* DtMountingAzimuthActuator::myAzimuthInfoPortGroup [protected]

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

DtAnalogOutputPort* DtMountingAzimuthActuator::myNominalAzimuthPort [protected]

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

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

DtAnalogOutputPort* DtMountingAzimuthActuator::myAzimuthRangePort [protected]

Output Port Name: azimuth-range
Output Port Description: Azimuth sweep range.

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

DtAnalogOutputPort* DtMountingAzimuthActuator::myMaxAzimuthRatePort [protected]

Output Port Name: azimuth-rate
Output Port Description: Maximum azimuth rate
Output Port Range:
Output Port Default Value:
Output Group Parent: mounting-info.

DtIntegerOutputPort* DtMountingAzimuthActuator::myAzimuthPartTypePort [protected]

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

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

DtAzimuthMountComponentDescriptor* DtMountingAzimuthActuator::myAzimuthCompDesc [protected]

DtReal DtMountingAzimuthActuator::myMaxSlewRate [protected]

DtReal DtMountingAzimuthActuator::myNominalAzimuth [protected]

DtReal DtMountingAzimuthActuator::myAzimuthSweep [protected]

DtArticulatedPartStateRepository* DtMountingAzimuthActuator::myRotatingBody [protected]

---

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

• include/vrfmodel/mountAzimAct.h