DtObjectSensor Class Reference

DtObjectSensor is a base level sensor component. More...

Inheritance diagram for DtObjectSensor:

Public Member Functions
	DtObjectSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtObjectSensor ()
	destructor
virtual bool	init ()
	Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry().
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	Processes only if the simulation is not paused.
virtual bool	tickWhileDestroyed () const
virtual int	sensorType () const
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 void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
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
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=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
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	createPortGroups ()
	Creates and initializes port groups.
virtual bool	createPorts ()
	Creates the target list port.
virtual DtObjectSensorPSR *	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual const char *	defaultPSRType () const
virtual void	updateDetectableObjectsList ()
	Sets up myDetectableObjectList as a list that contains all entity types/forces specified in both the descriptor and the myObjectsToDetectInputPort input port.
virtual bool	initSensorGeometry ()
	Creates the geometry evaluator based on the sensor-geometry entry in the descriptor, and the sensor geometry evaluator factory.
virtual void	setupGeometryForDetection ()
	Sets up the current sensor geometry evaluator with the current position and orientation of the sensor.
virtual DtVector	localSensorPosition () const
virtual DtTaitBryan	localSensorOrientation () const
virtual bool	processObjects ()
	Checks detectability of each of the detectable objects.
virtual bool	detectObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo)
virtual bool	continueDetectingObject (DtVrfObject *object, DtRwSensorContactInfo *contactInfo, bool &contactInfoModified)
virtual bool	objectWithinSensorGeometry (DtVrfObject *object) const
virtual double	rangeSquaredToObject (const DtVrfObject *object) const
virtual double	rangeToObject (const DtVrfObject *object) const
virtual void	clearObjectRangeCache () const
	Invalidates the current object range cache.
virtual void	printTargets () const
	Prints the current target list to the console.
virtual void	updateDetectedObjectListPort ()
	Clears the list port, then adds all target infos from the previous target list in the PSR, and sends the data.
virtual bool	createAndInitSensorMonitor ()
	Creates a DtObjectSensorMonitor, and calls init() on it.
virtual bool	objectInDetectableList (DtVrfObject *) const
	Returns true if the object is in the myDetectableObjectList.
virtual void	processHostilitiesChanged (DtU8 force)
DtCompositePredicate	objectTypeForcePredicate (const DtObjectType &, const DtNLengthIntegerVector &forceTypes)
	Specifies force types as s DtNLenghtIntegerVector.
DtCompositePredicate	objectTypeForcePredicate (const DtObjectType &, const std::list< DtU8 > &forceTypes)
	Specifies force types as a std::list.
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () const
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.

Static Protected Member Functions
static void	hostilitiesChangedCallback (DtU8 force, void *usr)
	If who were hostile towards has changed we will need to update our myDetectableObjectList.

Protected Attributes
DtManagedObjectListConstPtr	myDetectableObjectList
const DtObjectSensorDescriptor *	myObjectSensorDescriptor
DtObjectSensorPSR *	myProcessState
	Container for state data associated with this component.
DtObjectSensorMonitor *	myMonitor
	Sends out sensor contact information to the GUI if the GUI or other application has requested the information.
DtSpatialFilterEvaluator *	mySensorGeometryEvaluator
const DtVrfObject *	myMutableObjectCached
	The VrfObject whose range is currently cached.
bool	myMutableObjectRangeCalculated
	Keeps track of whether the range has been calculated for the current cached object.
double	myMutableObjectRangeCache
	The current range to the cached object, if calculated.
bool	myMutableObjectRangeSquaredCalculated
	Keeps track of whether the range squared has been calculated for the current cached object.
double	myMutableObjectRangeSquaredCache
	The current range squared to the cached object, if calculated.
Ports and Port Groups
DtSensorContactListOutputPort *	myDetectedObjectListPort
	Outputs: Output Port Name: detected-objects Output Port Description: The list of contacts detected by this sensor.
DtObjectTypesListMultiInputPort *	myObjectsToDetectInputPort
	Inputs: DtObjectTypesListMultiInputPort : object-types-to-detect Input Port Name: object-types-to-detect Input Port Description: List of contacts to be considered for target selection.
DtInputPortGroup *	mySensorOffsetInputPortGroup
	Input Port Group Name: sensor-offset Input Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity's position.
DtOrientationInputPort *	myOrientationInputPort
	Input Port Name: orientation Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted.
DtVectorInputPort *	myPositionInputPort
	Input Port Name: position Input Port Description: Specifies the position of the sensor in body coordinates relative to the entity which it is mounted on.
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.

Private Member Functions
	DtObjectSensor ()
	default constructor; not implemented
	DtObjectSensor (const DtObjectSensor &orig)
	copy constructor; not implemented
const DtObjectSensor &	operator= (const DtObjectSensor &orig)
	assignment operator; not implemented

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

DtObjectSensor is a base level sensor component.

End User Description: Manages a filtered list of detectable targets, as specified in the descriptor, and sets up infrastructure for specific sensor types to run their algorithms on the list. Manages sending of sensor data to the GUI though messages. Manages sensor geometry. Configuring a DtObjectSensor on an entity will cause it to detect all entities of types specified in the descriptor within the geometric region specified by the sensor geometry. No tests for terrain obstruction or sensor signatures will be done. For this functionality, use a DtSignatureObjectSensor.

Uses Descriptor Type: DtObjectSensorDescriptor.

Constructor & Destructor Documentation

DtObjectSensor::DtObjectSensor ( )

private

default constructor; not implemented

DtObjectSensor::DtObjectSensor ( const DtObjectSensor &  orig )

private

copy constructor; not implemented

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

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtObjectSensor::~DtObjectSensor ( )

virtual

destructor

Member Function Documentation

const DtObjectSensor& DtObjectSensor::operator= ( const DtObjectSensor &  orig )

private

assignment operator; not implemented

virtual bool DtObjectSensor::init ( )

virtual

Calls createPSR(), createDetectableObjectList(), createAndInitSensorMonitor() and initSensorGeometry().

This must be called after construction and before the sensor is used on an entity.

Reimplemented from DtSimComponent.

Reimplemented in DtRadarObjectSensor, and DtSignatureObjectSensor.

virtual DtString DtObjectSensor::type ( ) const

virtual

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns

DtObjectSensorType

Reimplemented from DtSimComponent.

Reimplemented in DtRadarObjectSensor, and DtSignatureObjectSensor.

virtual void DtObjectSensor::tick ( )

virtual

Processes only if the simulation is not paused.

Calls attemptToActivate() on myDetectedObjectListPort. Calls clearObjectRangeCache(). Calls setupGeometryForDetection() Calls processObjects(). When processObjects() returns true, calls notifyTargetsChanged() on the DtObjectSensorModitor. Calls updateDetectedObjectListPort().

Reimplemented from DtSimComponent.

Reimplemented in DtRadarObjectSensor, and DtSignatureObjectSensor.

virtual bool DtObjectSensor::tickWhileDestroyed ( ) const

virtual

Returns

true. This sensor ticks when the entity is destroyed so that it can notify any subscribed GUIs that it is no longer detecting objects.

Reimplemented from DtSimComponent.

virtual int DtObjectSensor::sensorType ( ) const

virtual

Returns

an enumeration indicating what type of sensor this is. (Visual, radar, etc) Types specified in ifSensorData.h

Reimplemented in DtSignatureObjectSensor, and DtRadarObjectSensor.

static DtSimComponent* DtObjectSensor::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

Reimplemented in DtRadarObjectSensor, and DtSignatureObjectSensor.

virtual bool DtObjectSensor::createPortGroups ( )

protectedvirtual

Creates and initializes port groups.

Reimplemented from DtSimComponent.

virtual bool DtObjectSensor::createPorts ( )

protectedvirtual

Creates the target list port.

Reimplemented from DtSimComponent.

virtual DtObjectSensorPSR* DtObjectSensor::createPSR ( )

protectedvirtual

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual const char* DtObjectSensor::defaultPSRType ( ) const

protectedvirtual

Returns

DtVrfObjectSensorProcessStateRepositoryType. Derived classes may override this to return their own default PSR type, if a different PSR type is desired.

Reimplemented in DtRadarObjectSensor.

virtual void DtObjectSensor::updateDetectableObjectsList ( )

protectedvirtual

Sets up myDetectableObjectList as a list that contains all entity types/forces specified in both the descriptor and the myObjectsToDetectInputPort input port.

DtTargetSelectionController and DtSpotReportGeneratorController are examples of controllers that provide lists of types of objects to detect. Uses objectTypeForcePredicate() to create the predicate for each type/force specified.

DtCompositePredicate DtObjectSensor::objectTypeForcePredicate ( const DtObjectType &  , const DtNLengthIntegerVector &  forceTypes  )

protected

Specifies force types as s DtNLenghtIntegerVector.

Returns

A predicate that will match the specified object type and force types. If the force types list is empty, the predicate will not include any check for force types, and will therefore match all force types.

DtCompositePredicate DtObjectSensor::objectTypeForcePredicate ( const DtObjectType &  , const std::list< DtU8 > &  forceTypes  )

protected

Specifies force types as a std::list.

virtual bool DtObjectSensor::initSensorGeometry ( )

protectedvirtual

Creates the geometry evaluator based on the sensor-geometry entry in the descriptor, and the sensor geometry evaluator factory.

virtual void DtObjectSensor::setupGeometryForDetection ( )

protectedvirtual

Sets up the current sensor geometry evaluator with the current position and orientation of the sensor.

Called once per detection cycle.

virtual DtVector DtObjectSensor::localSensorPosition ( ) const

protectedvirtual

Returns

The position of the sensor in local coordinates. If myPositionInputPort is active, this offset it used, otherwise it returns the entity's origin position.

Reimplemented in DtSignatureObjectSensor.

virtual DtTaitBryan DtObjectSensor::localSensorOrientation ( ) const

protectedvirtual

Returns

The orientation of the sensor in local coordinates. If myOrientationInputPort is active, this orientation is used, otherwise it is just the entity's orientation.

virtual bool DtObjectSensor::processObjects ( )

protectedvirtual

Checks detectability of each of the detectable objects.

This is done by calling continueDetectingObject() for all objects previously detected. For any that return false, they are removed from the list. For all objects that weren't previously detected, detectObject() is called. For any where the return value is true, they are added to the detected objects list in the PSR.

virtual bool DtObjectSensor::detectObject ( DtVrfObject *  object, DtRwSensorContactInfo *  contactInfo  )

protectedvirtual

Returns

true if the specified object should be detected by the sensor, when it has not been detected on the previous detection cycle. Deriving classes should override this to implement their own detection constraints. A blank DtRwSensorContactInfo structure is provided, and may be filled in by deriving class code. This implementation returns true if objectWithinSensorGeometry() returns true, and the entity meets the detectDestroyedObjects criteria.

Reimplemented in DtSignatureObjectSensor, and DtRadarObjectSensor.

virtual bool DtObjectSensor::continueDetectingObject ( DtVrfObject *  object, DtRwSensorContactInfo *  contactInfo, bool &  contactInfoModified  )

protectedvirtual

Returns

true if the specified object should continue to be detected by the sensor, when it was detected on the previous detection cycle. Deriving classes should override this to implement their own detection constraints. The current DtRwSensorContactInfo structure is provided for this contact, and may be modified in deriving class code. If any modifications are made, contactInfoModified should be set to true for notification of the ObjectSensorMonitor. This implementation returns true if objectWithinSensorGeometry() returns true, and the entity meets the detectDestroyedObjects criteria.

Reimplemented in DtSignatureObjectSensor, and DtRadarObjectSensor.

virtual bool DtObjectSensor::objectWithinSensorGeometry ( DtVrfObject *  object ) const

protectedvirtual

Returns

true only if the specified object is within the defined geometry of the sensor. Uses the sensor geometry evaluator.

virtual double DtObjectSensor::rangeSquaredToObject ( const DtVrfObject *  object ) const

protectedvirtual

Returns

the square of the range from the host object to the specified object. Uses the objectRangeCache to avoid recalculation when possible.

virtual double DtObjectSensor::rangeToObject ( const DtVrfObject *  object ) const

protectedvirtual

Returns

the range from the host object to the specified object. Uses the objectRangeCache to avoid recalculation when possible.

virtual void DtObjectSensor::clearObjectRangeCache ( ) const

protectedvirtual

Invalidates the current object range cache.

virtual void DtObjectSensor::printTargets ( ) const

protectedvirtual

Prints the current target list to the console.

virtual void DtObjectSensor::updateDetectedObjectListPort ( )

protectedvirtual

Clears the list port, then adds all target infos from the previous target list in the PSR, and sends the data.

virtual bool DtObjectSensor::createAndInitSensorMonitor ( )

protectedvirtual

Creates a DtObjectSensorMonitor, and calls init() on it.

virtual bool DtObjectSensor::objectInDetectableList ( DtVrfObject *  ) const

protectedvirtual

Returns true if the object is in the myDetectableObjectList.

static void DtObjectSensor::hostilitiesChangedCallback ( DtU8  force, void *  usr  )

staticprotected

If who were hostile towards has changed we will need to update our myDetectableObjectList.

virtual void DtObjectSensor::processHostilitiesChanged ( DtU8  force )

protectedvirtual

Member Data Documentation

DtSensorContactListOutputPort* DtObjectSensor::myDetectedObjectListPort

protected

Outputs: Output Port Name: detected-objects
Output Port Description: The list of contacts detected by this sensor.

Output Port Range:
Output Port Default Value:
Output Group Parent:

DtObjectTypesListMultiInputPort* DtObjectSensor::myObjectsToDetectInputPort

protected

Inputs: DtObjectTypesListMultiInputPort : object-types-to-detect Input Port Name: object-types-to-detect
Input Port Description: List of contacts to be considered for target selection.

As many contact lists as desired can be connected and work simultaneously.
Input Port Range:
Input Port Default Value:
Input Group Parent: object-types-to-detect

DtInputPortGroup* DtObjectSensor::mySensorOffsetInputPortGroup

protected

Input Port Group Name: sensor-offset
Input Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity's position.

DtOrientationInputPort* DtObjectSensor::myOrientationInputPort

protected

Input Port Name: orientation
Input Port Description: Specifies the orientation of the sensor relative to the entity on which it is mounted.

Input Port Range:
Input Port Default Value: 0,0,0
Input Group Parent: sensor-offset

DtVectorInputPort* DtObjectSensor::myPositionInputPort

protected

Input Port Name: position
Input Port Description: Specifies the position of the sensor in body coordinates relative to the entity which it is mounted on.

If this port is not connected localSensorPosition() simply returns the local position of the entity.
Input Port Range:
Input Port Default Value: 0,0,0
Input Group Parent: sensor-offset

DtManagedObjectListConstPtr DtObjectSensor::myDetectableObjectList

protected

const DtObjectSensorDescriptor* DtObjectSensor::myObjectSensorDescriptor

protected

DtObjectSensorPSR* DtObjectSensor::myProcessState

protected

Container for state data associated with this component.

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

DtObjectSensorMonitor* DtObjectSensor::myMonitor

protected

Sends out sensor contact information to the GUI if the GUI or other application has requested the information.

DtSpatialFilterEvaluator* DtObjectSensor::mySensorGeometryEvaluator

protected

const DtVrfObject* DtObjectSensor::myMutableObjectCached

mutableprotected

The VrfObject whose range is currently cached.

bool DtObjectSensor::myMutableObjectRangeCalculated

mutableprotected

Keeps track of whether the range has been calculated for the current cached object.

double DtObjectSensor::myMutableObjectRangeCache

mutableprotected

The current range to the cached object, if calculated.

bool DtObjectSensor::myMutableObjectRangeSquaredCalculated

mutableprotected

Keeps track of whether the range squared has been calculated for the current cached object.

double DtObjectSensor::myMutableObjectRangeSquaredCache

mutableprotected

The current range squared to the cached object, if calculated.

---

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

• include/vrfmodel/objectSensor.h