DtObstructionSensor Class Reference

DtObstructionSensor models a sensor able to detect potential collisions with other entities and/or terrain vector data. More...

Inheritance diagram for DtObstructionSensor:

Public Member Functions
	DtObstructionSensor (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtObstructionSensor ()
	destructor
virtual bool	init ()
	Initializes the Obstruction sensor for use.
virtual void	preFirstTickInit ()
	Calls setObstructionIDsInCollisionDetector()
virtual void	tick ()
	Determines if the entity is currently colliding with any of the specified potential Obstructions.
virtual DtString	type () const
	Returns a string identifies the class type of component.
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	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
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
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 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
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
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual bool	createCollisionDetector ()
	Creates the collision detector.
virtual bool	setObstructionIDsInCollisionDetector ()
	Sets the obstruction IDs in the collision detector based on the descriptor and the PSR.
virtual bool	initializeCollisionBV ()
	Initializes the collision bounding volume.
virtual bool	calculateStoppingDistance (const DtObstructionSensorDescriptor &obstructionSensorDesc, double &stoppingDistance)
	Calculates the current stopping distance of the entity.
virtual bool	calculateCollisionBV ()
	Calculates the bounding volume representing the potential collision volume occupied by the entity.
virtual void	registerMessageCallbacks ()
	Registers for DtSetCollisionAvoidTypes messages.
virtual void	processCollisionAvoidTypes (DtSimMessage *msg)
	Modifies the current obstruction detection types based on the contents of the message.
virtual bool	addFeatureTypeToAvoid (DtRwString featureType)
	Adds the specified obstruction type to the PSR's feature obstruction list unless this type of obstruction is already being checked for.
virtual bool	removeFeatureTypeToAvoid (DtRwString featureType)
	Removes the specified obstruction type from the PSR's feature obstruction list unless this type of obstruction if it is currently being checked for.
virtual DtRwString	buildingFeatureType () const
	Returns the vector obstruction type that will be added/removed when a DtSetCollisionAvoidTypes message arrives that adds/removes building avoidance.
virtual DtRwString	treeFeatureType () const
	Returns the vector obstruction type that will be added/removed when a DtSetCollisionAvoidTypes message arrives that adds/removes trees avoidance.
virtual double	decelerationSoilFactor () const
virtual bool	createPorts ()
	Creates, initializes, and adds to the port group, all the ports for this component.
virtual bool	createPortGroups ()
	Creates and adds all port groups for this component.
Protected Member Functions inherited from DtSimComponent
bool	testInvariant () 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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Static Protected Member Functions
static void	setCollisionAvoidTypesCallback (DtSimMessage *msg, void *usr)
	Calls processCollisionAvoidTypes().

Protected Attributes
Dt3dBoundingVolume *	myCollisionBV
DtCollisionDetector *	myCollisionDetector
DtCollisionDetector::DtObjectObstructionIDContainer	myObjectObstructionIDs
DtCollisionDetector::DtFeatureTypeContainer	myFeatureObstructionTypes
const DtObstructionSensorDescriptor *	myObstructionSensorDesc
DtObstructionSensorPSR *	myProcessState
	Container for state data associated with this component.
DtCollision *	myPotentialCollision
Ports and Port Groups
DtCollisionOutputPort *	myPotentialCollisionInfoPort
	Output Port Name: potential-collision-info Output Port Description: Information about an impending potential collision with an entity or terrain vector data feature.
DtOutputPortGroup *	myObstructionInfoPortGroup
	Output Port Group Name: obstruction-info Output Port Group Description:
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
	DtObstructionSensor (const DtObstructionSensor &orig)
	copy constructor; not implemented
DtObstructionSensor &	operator= (const DtObstructionSensor &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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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

DtObstructionSensor models a sensor able to detect potential collisions with other entities and/or terrain vector data.

Uses Descriptor Type: DtObstructionSensorDescriptor

Constructor & Destructor Documentation

DtObstructionSensor::DtObstructionSensor	(	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 DtObstructionSensor::~DtObstructionSensor ( )

virtual

destructor

DtObstructionSensor::DtObstructionSensor ( const DtObstructionSensor &  orig )

private

copy constructor; not implemented

Member Function Documentation

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

private

assignment operator; not implemented

virtual bool DtObstructionSensor::init ( )

virtual

Initializes the Obstruction sensor for use.

This involves calculating the initial collision bounding volume.

Returns

A boolean signifying success or failure.

See Also

initializeCollisionBV()

Reimplemented from DtSimComponent.

virtual void DtObstructionSensor::preFirstTickInit ( )

virtual

Calls setObstructionIDsInCollisionDetector()

Reimplemented from DtSimComponent.

virtual void DtObstructionSensor::tick ( )

virtual

Determines if the entity is currently colliding with any of the specified potential Obstructions.

If so, it fills the myPotentialCollisionInfoPort with the potential collision data if it can activate the ports. Otherwise, it releases any active ports.

See Also

calculateCollisionBV()

detectCollision()

Reimplemented from DtSimComponent.

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

DtObstructionSensorType

Reimplemented from DtSimComponent.

Reimplemented in DtHumanObstructionSensor.

virtual bool DtObstructionSensor::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 bool DtObstructionSensor::createCollisionDetector ( )

protectedvirtual

Creates the collision detector.

virtual bool DtObstructionSensor::setObstructionIDsInCollisionDetector ( )

protectedvirtual

Sets the obstruction IDs in the collision detector based on the descriptor and the PSR.

PSR values take precedence over values in the descriptor.

Returns

a boolean indicating success or failure.

virtual bool DtObstructionSensor::initializeCollisionBV ( )

protectedvirtual

Initializes the collision bounding volume.

Returns

A boolean signifying success or failure.

virtual bool DtObstructionSensor::calculateStoppingDistance ( const DtObstructionSensorDescriptor &  obstructionSensorDesc, double &  stoppingDistance  )

protectedvirtual

Calculates the current stopping distance of the entity.

To get this, it queries the ground auto controller component, if specified, and returns the current braking distance that that component calculates.

Returns

true if the stopping distance was calculated. false if the distance could not be calculated for any reason. This includes if the ground auto controller component member of the descriptor is not specified or if the component can't be found in the component manager (by name).

Note

If the function returns false, the stoppingDistance parameter is not modified.

To decouple this from any use of a ground auto controller component derive a child class and override this function.

Reimplemented in DtHumanObstructionSensor.

virtual bool DtObstructionSensor::calculateCollisionBV ( )

protectedvirtual

Calculates the bounding volume representing the potential collision volume occupied by the entity.

The entities oriented bounding volume is extended in the direction of travel. It represents a prediction of the entity's future movement for some period of time.

Returns

A boolean signifying success or failure. If the function fails, the bounding volume value is not defined to be correct.

virtual void DtObstructionSensor::registerMessageCallbacks ( )

protectedvirtual

Registers for DtSetCollisionAvoidTypes messages.

static void DtObstructionSensor::setCollisionAvoidTypesCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Calls processCollisionAvoidTypes().

virtual void DtObstructionSensor::processCollisionAvoidTypes ( DtSimMessage *  msg )

protectedvirtual

Modifies the current obstruction detection types based on the contents of the message.

virtual bool DtObstructionSensor::addFeatureTypeToAvoid ( DtRwString  featureType )

protectedvirtual

Adds the specified obstruction type to the PSR's feature obstruction list unless this type of obstruction is already being checked for.

Returns

True if the list was modified.

virtual bool DtObstructionSensor::removeFeatureTypeToAvoid ( DtRwString  featureType )

protectedvirtual

Removes the specified obstruction type from the PSR's feature obstruction list unless this type of obstruction if it is currently being checked for.

Returns

True if the list was modified.

virtual DtRwString DtObstructionSensor::buildingFeatureType ( ) const

protectedvirtual

Returns the vector obstruction type that will be added/removed when a DtSetCollisionAvoidTypes message arrives that adds/removes building avoidance.

Returns "BUILDING"

virtual DtRwString DtObstructionSensor::treeFeatureType ( ) const

protectedvirtual

Returns the vector obstruction type that will be added/removed when a DtSetCollisionAvoidTypes message arrives that adds/removes trees avoidance.

Returns "TREE"

virtual double DtObstructionSensor::decelerationSoilFactor ( ) const

protectedvirtual

static DtSimComponent* DtObstructionSensor::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 DtHumanObstructionSensor.

virtual bool DtObstructionSensor::createPorts ( )

protectedvirtual

Creates, initializes, and adds to the port group, all the ports for this component.

Returns

A boolean signifying success or failure.

Reimplemented from DtSimComponent.

virtual bool DtObstructionSensor::createPortGroups ( )

protectedvirtual

Creates and adds all port groups for this component.

Returns

A boolean signifying success or failure.

Reimplemented from DtSimComponent.

Member Data Documentation

DtCollisionOutputPort* DtObstructionSensor::myPotentialCollisionInfoPort

protected

Output Port Name: potential-collision-info
Output Port Description: Information about an impending potential collision with an entity or terrain vector data feature.

Output Port Range:
Output Port Default Value:
Output Group Parent: obstruction-info

DtOutputPortGroup* DtObstructionSensor::myObstructionInfoPortGroup

protected

Output Port Group Name: obstruction-info
Output Port Group Description:

Dt3dBoundingVolume* DtObstructionSensor::myCollisionBV

protected

DtCollisionDetector* DtObstructionSensor::myCollisionDetector

protected

DtCollisionDetector::DtObjectObstructionIDContainer DtObstructionSensor::myObjectObstructionIDs

protected

DtCollisionDetector::DtFeatureTypeContainer DtObstructionSensor::myFeatureObstructionTypes

protected

const DtObstructionSensorDescriptor* DtObstructionSensor::myObstructionSensorDesc

protected

DtObstructionSensorPSR* DtObstructionSensor::myProcessState

protected

Container for state data associated with this component.

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

DtCollision* DtObstructionSensor::myPotentialCollision

mutableprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/obstructionSens.h