DtTurretScanComponentDescriptor Class Reference

DtTurretScanComponentDescriptor is a DtComponentDescriptor that has additional information needed for providing scanning of an entity's sector of responsibility by a turret. More...

Inheritance diagram for DtTurretScanComponentDescriptor:

List of all members.

Public Member Functions
	DtTurretScanComponentDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtTurretScanComponentDescriptor (const DtTurretScanComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtTurretScanComponentDescriptor &	operator= (const DtTurretScanComponentDescriptor &orig)
	assignment
virtual	~DtTurretScanComponentDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	scanRate () const
	Accessor/mutator for myScanRate.
virtual void	setScanRate (DtReal scanRate)
	Accessor/mutator for myScanRate.
virtual DtReal	minimumScanWidth () const
	Accessor/mutator for myMinimumScanWidth.
virtual void	setMinimumScanWidth (DtReal scanWidth)
	Accessor/mutator for myMinimumScanWidth.
virtual bool	scanSor () const
	Accessor/mutator for myScanSor.
virtual void	setScanSor (bool scanSor)
	Accessor/mutator for myScanSor.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtTurretScanComponentDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myScanRate
	Parameter Name: scan-rate Parameter Description: The rate at which to slew the turret.
DtRwReal	myMinimumScanWidth
	Parameter Name: minimum-scan-width Parameter Description: The minimum with of the sector of responsibility within which the turret scan component will slew back and forth.
DtRwBoolean	myScanSor
	Parameter Name: scan-sor Parameter Description: Determines whether the turret will continually scan within the specified Sector of Responsibility, or remain centered.

---

Detailed Description

DtTurretScanComponentDescriptor is a DtComponentDescriptor that has additional information needed for providing scanning of an entity's sector of responsibility by a turret.

---

Constructor & Destructor Documentation

DtTurretScanComponentDescriptor::DtTurretScanComponentDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtTurretScanComponentDescriptor::~DtTurretScanComponentDescriptor

(

)

[virtual]

destructor

DtTurretScanComponentDescriptor::DtTurretScanComponentDescriptor

(

)

[protected]

default constructor

---

Member Function Documentation

DtTurretScanComponentDescriptor& DtTurretScanComponentDescriptor::operator=

(

const DtTurretScanComponentDescriptor &

orig

)

assignment

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

DtTurretScanComponentDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtReal DtTurretScanComponentDescriptor::scanRate

(

)

const [virtual]

Accessor/mutator for myScanRate.

virtual void DtTurretScanComponentDescriptor::setScanRate

(

DtReal

scanRate

)

[virtual]

Accessor/mutator for myScanRate.

virtual DtReal DtTurretScanComponentDescriptor::minimumScanWidth

(

)

const [virtual]

Accessor/mutator for myMinimumScanWidth.

virtual void DtTurretScanComponentDescriptor::setMinimumScanWidth

(

DtReal

scanWidth

)

[virtual]

Accessor/mutator for myMinimumScanWidth.

virtual bool DtTurretScanComponentDescriptor::scanSor

(

)

const [virtual]

Accessor/mutator for myScanSor.

virtual void DtTurretScanComponentDescriptor::setScanSor

(

bool

scanSor

)

[virtual]

Accessor/mutator for myScanSor.

virtual DtComponentDescriptor* DtTurretScanComponentDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtTurretScanComponentDescriptor::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 DtComponentDescriptor.

---

Member Data Documentation

DtRwReal DtTurretScanComponentDescriptor::myScanRate [protected]

Parameter Name: scan-rate
Parameter Description: The rate at which to slew the turret.

Parameter Default Value: pi / 2
Parameter Units: Radians / second
Parameter Range: positive real numbers

DtRwReal DtTurretScanComponentDescriptor::myMinimumScanWidth [protected]

Parameter Name: minimum-scan-width
Parameter Description: The minimum with of the sector of responsibility within which the turret scan component will slew back and forth.

In a smaller width, the turret will slew directly to the center of the SOR and remain there.
Parameter Default Value: 0.175 (10 degrees)
Parameter Units: Radians
Parameter Range: -pi .. pi

DtRwBoolean DtTurretScanComponentDescriptor::myScanSor [protected]

Parameter Name: scan-sor
Parameter Description: Determines whether the turret will continually scan within the specified Sector of Responsibility, or remain centered.

Parameter Default Value: True

---

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

• include/vrfobjparam/turScanDesc.h