DtObjectSensorDescriptor Class Reference

DtObjectSensorDescriptor; descriptor for the DtObjectSensor component. More...

Inheritance diagram for DtObjectSensorDescriptor:

List of all members.

Public Member Functions
	DtObjectSensorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtObjectSensorDescriptor (const DtObjectSensorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtObjectSensorDescriptor &	operator= (const DtObjectSensorDescriptor &orig)
	assignment
virtual	~DtObjectSensorDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual bool	detectOnlyHostileForces () const
	See myDetectOnlyHostileForces.
virtual void	setDetectOnlyHostileForces (bool value)
	See myDetectOnlyHostileForces.
virtual void	setDetectionTypes (const DtRwObjectTypeList &objectTypes)
	Accessor/mutator for myDetectionTypes.
virtual DtRwObjectTypeList &	detectionTypes ()
	Accessor/mutator for myDetectionTypes.
virtual const DtRwObjectTypeList &	detectionTypes () const
	Accessor/mutator for myDetectionTypes.
virtual void	setDetectDestroyedObjects (bool value)
	Accessor/mutator for myDetectDestroyedObjects.
virtual bool	detectDestroyedObjects () const
	Accessor/mutator for myDetectDestroyedObjects.
virtual DtRwSpatialFilterContainer *	sensorGeometry ()
	Accessor for mySensorGeometry.
virtual const DtRwSpatialFilterContainer *	sensorGeometry () const
	Accessor for mySensorGeometry.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myDetectOnlyHostileForces
	Parameter Name: detect-only-hostile-forces Parameter Description: If true, this sensor will detect only entities that are of a force type hostile to the entity this sensor is on.
DtRwObjectTypeList	myDetectionTypes
	Parameter Name: detection-types Parameter Description: Types of objects to detect.
DtRwBoolean	myDetectDestroyedObjects
	Parameter Name: detect-destroyed-objects Parameter Description: Flag indicating whether or not to detected destroyed objects.
DtRwSpatialFilterContainer	mySensorGeometry
	Parameter Name: sensor-geometry Parameter Description: Geometry of the sensor coverage, such as range and/or a sensor frustum.
Private Member Functions
	DtObjectSensorDescriptor ()
	default constructor; not implemented

---

Detailed Description

DtObjectSensorDescriptor; descriptor for the DtObjectSensor component.

DtComponentDescriptor for the DtObjectSensor component. Includes types of objects to detect, geometry of covered area, force type of objects to detect, and whether to detect destroyed objects.

---

Constructor & Destructor Documentation

DtObjectSensorDescriptor::DtObjectSensorDescriptor

(

)

[private]

default constructor; not implemented

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

constructor

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

copy constructor

virtual DtObjectSensorDescriptor::~DtObjectSensorDescriptor

(

)

[virtual]

destructor

---

Member Function Documentation

DtObjectSensorDescriptor& DtObjectSensorDescriptor::operator=

(

const DtObjectSensorDescriptor &

orig

)

assignment

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

DtObjectSensorDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSignatureObjectSensorDescriptor, and DtRadarObjectSensorDescriptor.

virtual bool DtObjectSensorDescriptor::detectOnlyHostileForces

(

)

const [virtual]

See myDetectOnlyHostileForces.

virtual void DtObjectSensorDescriptor::setDetectOnlyHostileForces

(

bool

value

)

[virtual]

See myDetectOnlyHostileForces.

virtual void DtObjectSensorDescriptor::setDetectionTypes

(

const DtRwObjectTypeList &

objectTypes

)

[virtual]

Accessor/mutator for myDetectionTypes.

virtual DtRwObjectTypeList& DtObjectSensorDescriptor::detectionTypes

(

)

[virtual]

Accessor/mutator for myDetectionTypes.

virtual const DtRwObjectTypeList& DtObjectSensorDescriptor::detectionTypes

(

)

const [virtual]

Accessor/mutator for myDetectionTypes.

virtual void DtObjectSensorDescriptor::setDetectDestroyedObjects

(

bool

value

)

[virtual]

Accessor/mutator for myDetectDestroyedObjects.

virtual bool DtObjectSensorDescriptor::detectDestroyedObjects

(

)

const [virtual]

Accessor/mutator for myDetectDestroyedObjects.

virtual DtRwSpatialFilterContainer* DtObjectSensorDescriptor::sensorGeometry

(

)

[virtual]

Accessor for mySensorGeometry.

virtual const DtRwSpatialFilterContainer* DtObjectSensorDescriptor::sensorGeometry

(

)

const [virtual]

Accessor for mySensorGeometry.

virtual DtComponentDescriptor* DtObjectSensorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtSignatureObjectSensorDescriptor, and DtRadarObjectSensorDescriptor.

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

Reimplemented in DtSignatureObjectSensorDescriptor, and DtRadarObjectSensorDescriptor.

virtual void DtObjectSensorDescriptor::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

---

Member Data Documentation

DtRwBoolean DtObjectSensorDescriptor::myDetectOnlyHostileForces [protected]

Parameter Name: detect-only-hostile-forces
Parameter Description: If true, this sensor will detect only entities that are of a force type hostile to the entity this sensor is on.

This effects only the detection-types listed in this descriptor. If other force types are specified in the input port, those will be detected as well.
When false, all force types are detected. Parameter Default Value: true

DtRwObjectTypeList DtObjectSensorDescriptor::myDetectionTypes [protected]

Parameter Name: detection-types
Parameter Description: Types of objects to detect.

Parameter Default Value:

DtRwBoolean DtObjectSensorDescriptor::myDetectDestroyedObjects [protected]

Parameter Name: detect-destroyed-objects
Parameter Description: Flag indicating whether or not to detected destroyed objects.

Parameter Default Value: false

DtRwSpatialFilterContainer DtObjectSensorDescriptor::mySensorGeometry [protected]

Parameter Name: sensor-geometry
Parameter Description: Geometry of the sensor coverage, such as range and/or a sensor frustum.

Spatial filters can be combined with logical and/or/not operators as well.
Example 1: Every entity within 4000 meters of this sensor.
(in-range
(range 4000.000000)
)
Example 2: Every entity within 4000 meters of this sensor, and within the defined frustum of the look-direction of the sensor.
(and
(in-range
(range 4000.000000)
)
(in-frustum
(az-max 1.0472)
(az-min -1.0472)
(el-max 1.5708)
(el-min -1.5708)
)
)
Custom geometry filters can be created though the toolkit.
See documentation for DtRwSpatialFilter for more information.
Parameter Default Value:

---

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

• include/vrfobjparam/objectSensorDesc.h