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:

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.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
virtual DtOutputStream &	objectConsoleDebug () const
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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.
Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtSimComponentFactory *factory)
static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtVrfObject *owner, DtSimManager *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Creates a DtSimComponent using the factory, then initializes it via the MTL stream.
static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.

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 Member Functions inherited from DtSimComponent
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.

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.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap
typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap
typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap
typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

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 ( )

protectedvirtual

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

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