DtLaserDetector Class Reference

Class Description: DtLaserDetector Determines if the object that it is attached to is being lased and sends a laser spot report message that contains the distance and azimuth of the laser that is lasing the object. More...

Inheritance diagram for DtLaserDetector:

List of all members.

Public Member Functions
	DtLaserDetector (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=0)
	constructor
virtual	~DtLaserDetector ()
	destructor
virtual bool	init ()
	Calls createRelfectedEmitterList() and createEmitterListPort().
virtual bool	createReflectedDesignatorList ()
	Called by init().
virtual DtString	type ()
	This returns a string that uniquely identifies this type of component.
virtual void	setEntity (DtVrfObject *entity)
	This is the entity we're detecting for.
virtual void	tick ()
	Detects emitters and places them on our port.
virtual DtLaserDetectorOutputPort *	laserListPort () const
	Returns the list of lasers we've detected.
virtual void	getProcessSR ()
	This function gets the name of the process state repository being shared by all components in the laser sensor and then gets a pointer to it via the entity's processStateRepositoryManager.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Protected Member Functions
virtual bool	createPorts ()
	Overridden to create myEmitterListPort.
	DtLaserDetector ()
	Default constructor; should not be called.
	DtLaserDetector (const DtLaserDetector &orig)
	copy constructor, not implemented
DtLaserDetector &	operator= (const DtLaserDetector &orig)
	assignment operator, not implemented
Protected Attributes
DtReflectedDesignatorList *	myReflectedDesignatorList
	List of all remote emitter systems.
DtLaserDetectorOutputPort *	myLaserDetectorListPort
	Port used to communicate the list of detected emitter systems to other components.
DtGlobalObjectDesignator	myGlobalId
	The id of the entity this receiver is mounted on.
DtLaserDetectorDescriptor *	myComponentDescriptor
DtLaserDetectorPSR *	myProcessState
	Container for state data associated with this component.

---

Detailed Description

Class Description: DtLaserDetector Determines if the object that it is attached to is being lased and sends a laser spot report message that contains the distance and azimuth of the laser that is lasing the object.

---

Constructor & Destructor Documentation

DtLaserDetector::DtLaserDetector	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

virtual DtLaserDetector::~DtLaserDetector

(

)

[virtual]

destructor

DtLaserDetector::DtLaserDetector

(

)

[protected]

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtLaserDetector::DtLaserDetector

(

const DtLaserDetector &

orig

)

[protected]

copy constructor, not implemented

---

Member Function Documentation

virtual bool DtLaserDetector::init

(

)

[virtual]

Calls createRelfectedEmitterList() and createEmitterListPort().

Reimplemented from DtSimComponent.

virtual bool DtLaserDetector::createReflectedDesignatorList

(

)

[virtual]

Called by init().

Creates the VR-Link list of all reflected emitter objects in the simulation.

virtual DtString DtLaserDetector::type

(

)

[virtual]

This returns a string that uniquely identifies this type of component.

virtual void DtLaserDetector::setEntity

(

DtVrfObject *

entity

)

[virtual]

This is the entity we're detecting for.

We override because we want to grab and cache the global object designator.

Reimplemented from DtSimComponent.

virtual void DtLaserDetector::tick

(

)

[virtual]

Detects emitters and places them on our port.

Reimplemented from DtSimComponent.

virtual DtLaserDetectorOutputPort* DtLaserDetector::laserListPort

(

)

const [virtual]

Returns the list of lasers we've detected.

virtual void DtLaserDetector::getProcessSR

(

)

[virtual]

This function gets the name of the process state repository being shared by all components in the laser sensor and then gets a pointer to it via the entity's processStateRepositoryManager.

static DtSimComponent* DtLaserDetector::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *	parentRegistry
	)		[static]

Returns a newly created instance of this class.

We need to provide this function so that we can register this class with the component factory.

virtual bool DtLaserDetector::createPorts

(

)

[protected, virtual]

Overridden to create myEmitterListPort.

Reimplemented from DtSimComponent.

DtLaserDetector& DtLaserDetector::operator=

(

const DtLaserDetector &

orig

)

[protected]

assignment operator, not implemented

---

Member Data Documentation

DtReflectedDesignatorList* DtLaserDetector::myReflectedDesignatorList [protected]

List of all remote emitter systems.

DtLaserDetectorOutputPort* DtLaserDetector::myLaserDetectorListPort [protected]

Port used to communicate the list of detected emitter systems to other components.

DtGlobalObjectDesignator DtLaserDetector::myGlobalId [protected]

The id of the entity this receiver is mounted on.

DtLaserDetectorDescriptor* DtLaserDetector::myComponentDescriptor [protected]

Reimplemented from DtSimComponent.

DtLaserDetectorPSR* DtLaserDetector::myProcessState [protected]

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).

---

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

• include/vrfmodel/laserDetector.h