DtAzimuthMountComponentDescriptor Class Reference

Instances of DtAzimuthMountComponentDescriptor are used to specify the parameters for a DtMountingAzimuthActuator object. More...

Inheritance diagram for DtAzimuthMountComponentDescriptor:

List of all members.

Public Member Functions
	DtAzimuthMountComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtAzimuthMountComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtAzimuthMountComponentDescriptor (const DtAzimuthMountComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtAzimuthMountComponentDescriptor &	operator= (const DtAzimuthMountComponentDescriptor &orig)
	assignment
virtual	~DtAzimuthMountComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtReal	maxSlewRate () const
	Accessor/mutator for myMaxSlewRate.
virtual void	setMaxSlewRate (DtReal maxSlewRate)
	Accessor/mutator for myMaxSlewRate.
virtual DtReal	nominalAzimuth () const
	Accessor/mutator for myNominalAzimuth.
virtual void	setNominalAzimuth (DtReal nominalAzimuth)
	Accessor/mutator for myNominalAzimuth.
virtual DtReal	azimuthSweepRange () const
	Accessor/mutator for myAzimuthSweepRange.
virtual void	setAzimuthSweepRange (DtReal azimuthSweepRange)
	Accessor/mutator for myAzimuthSweepRange.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtAzimuthMountComponentDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxSlewRate
	Parameter Name: max-slew-rate Parameter Description: Sets and gets the maximum slew rate.
DtRwReal	myNominalAzimuth
	Parameter Name: nominal-azimuth Parameter Description: Sets and gets the nominal azimuth.
DtRwReal	myAzimuthSweepRange
	Parameter Name: azimuth-range Parameter Description: Sets and gets the azimuth sweep.

---

Detailed Description

Instances of DtAzimuthMountComponentDescriptor are used to specify the parameters for a DtMountingAzimuthActuator object.

---

Constructor & Destructor Documentation

DtAzimuthMountComponentDescriptor::DtAzimuthMountComponentDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtAzimuthMountComponentDescriptor::DtAzimuthMountComponentDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtAzimuthMountComponentDescriptor::DtAzimuthMountComponentDescriptor	(	const DtAzimuthMountComponentDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtAzimuthMountComponentDescriptor::~DtAzimuthMountComponentDescriptor

(

)

[virtual]

destructor

DtAzimuthMountComponentDescriptor::DtAzimuthMountComponentDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtAzimuthMountComponentDescriptor& DtAzimuthMountComponentDescriptor::operator=

(

const DtAzimuthMountComponentDescriptor &

orig

)

assignment

virtual DtString DtAzimuthMountComponentDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtAzimuthMountComponentDescriptorType.

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtAzimuthMountComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Returns:

Newly created copy of this class.

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtAzimuthMountComponentDescriptor::maxSlewRate

(

)

const [virtual]

Accessor/mutator for myMaxSlewRate.

virtual void DtAzimuthMountComponentDescriptor::setMaxSlewRate

(

DtReal

maxSlewRate

)

[virtual]

Accessor/mutator for myMaxSlewRate.

virtual DtReal DtAzimuthMountComponentDescriptor::nominalAzimuth

(

)

const [virtual]

Accessor/mutator for myNominalAzimuth.

virtual void DtAzimuthMountComponentDescriptor::setNominalAzimuth

(

DtReal

nominalAzimuth

)

[virtual]

Accessor/mutator for myNominalAzimuth.

virtual DtReal DtAzimuthMountComponentDescriptor::azimuthSweepRange

(

)

const [virtual]

Accessor/mutator for myAzimuthSweepRange.

virtual void DtAzimuthMountComponentDescriptor::setAzimuthSweepRange

(

DtReal

azimuthSweepRange

)

[virtual]

Accessor/mutator for myAzimuthSweepRange.

static DtComponentDescriptor* DtAzimuthMountComponentDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

---

Member Data Documentation

DtRwReal DtAzimuthMountComponentDescriptor::myMaxSlewRate [protected]

Parameter Name: max-slew-rate
Parameter Description: Sets and gets the maximum slew rate.

This is the maximum rate at which the azimuth mount can rotate.
Parameter Default Value: 0.0
Parameter Units: radians/second

DtRwReal DtAzimuthMountComponentDescriptor::myNominalAzimuth [protected]

Parameter Name: nominal-azimuth
Parameter Description: Sets and gets the nominal azimuth.

This angle is the center of the azimuth mount's range.
Parameter Default Value: 0.0
Parameter Units: radians

DtRwReal DtAzimuthMountComponentDescriptor::myAzimuthSweepRange [protected]

Parameter Name: azimuth-range
Parameter Description: Sets and gets the azimuth sweep.

This is the angular extent through which the azimuth mount can rotate.
Parameter Default Value: 0.0
Parameter Units: radians

---

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

• include/vrfobjparam/azMntCompDesc.h