VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtObstructionSensor Class Reference

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

Uses Descriptor Type: DtObstructionSensorDescriptor

Inheritance diagram for DtObstructionSensor:
Inheritance graph
[legend]

Public Member Functions

 DtObstructionSensor (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtObstructionSensor ()
 
virtual bool init ()
 
virtual void preFirstTickInit ()
 
virtual void tick ()
 
virtual const chartype () const
 
- Public Member Functions inherited from DtSimComponent
 DtSimComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtSimComponent ()
 
virtual void setParentSystem (DtComponentSystem *system)
 
DtComponentSystemparentSystem () const
 
virtual bool postAddComponentsInit ()
 
virtual void registerAttributeFunctions ()
 
virtual void postTick ()
 
virtual void timedTick ()
 
virtual void setMinTickPeriod (double minTickPeriod)
 
virtual double minTickPeriod () const
 
virtual void setMinTickPeriodVariance (double minTickPeriodVariance)
 
virtual double minTickPeriodVariance () const
 
virtual void setNextTickTime (double nextTickTime)
 
virtual double nextTickTime () const
 
virtual double calculateNextTickTime () const
 
virtual double calculateFirstTickTime () const
 
virtual void setEntity (DtLocalObject *entity)
 
virtual DtSimComponentnextComponent ()
 
virtual DtSimComponentprevComponent ()
 
virtual void setListItem (DtListItem *item)
 
virtual DtListItem * listItem ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void addInputPort (DtInputPort *port)
 
virtual void removeInputPort (DtInputPort *port)
 
virtual DtInputPortlookupInputPort (const DtString &portName)
 
virtual DtList inputPortList () const
 
virtual void addOutputPort (DtOutputPort *port)
 
virtual void removeOutputPort (DtOutputPort *port)
 
virtual DtOutputPortlookupOutputPort (const DtString &portName)
 
virtual DtList outputPortList () const
 
virtual void addInputPortGroup (DtInputPortGroup *group)
 
virtual void removeInputPortGroup (DtInputPortGroup *group)
 
virtual DtInputPortGrouplookupInputPortGroup (const DtString &groupName)
 
virtual DtList inputPortGroupList () const
 
virtual void addOutputPortGroup (DtOutputPortGroup *group)
 
virtual void removeOutputPortGroup (DtOutputPortGroup *group)
 
virtual DtOutputPortGrouplookupOutputPortGroup (const DtString &groupName)
 
virtual DtList outputPortGroupList () const
 
virtual int priority () const
 
virtual void setPriority (int priority)
 
double dT () const
 
virtual void setDT (double deltaT)
 
virtual void setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
 
virtual const
DtComponentDescriptor
componentDescriptor () const
 
virtual bool tickWhileDestroyed () const
 
DtVrfProcessStateRepositoryManagerpsrManager ()
 
virtual const DtSymbolStringcomponentFullName () const
 
DtPhysicalWorldphysicalWorld ()
 
const DtPhysicalWorldphysicalWorld () const
 
const DtAttachedTerrainterrainAttachedTo () const
 
DtLocalObjectentity ()
 
const DtLocalObjectentity () const
 
DtSimulationServicessimulationServices ()
 
const DtSimulationServicessimulationServices () const
 
const Coordinate_SystemcoordinateSystem () const
 
virtual bool taskVisualizationsActive () const
 
virtual bool taskVisualizationsEnabled () const
 
virtual void onRestore ()
 
makVrf::DtTaskVisualizationMaptaskVisualizations ()
 
virtual void enable ()
 
virtual void disable ()
 
virtual bool isEnabled ()
 
virtual void setIsEnabled (bool yesNo)
 
virtual DtOutputStream & objectConsoleDebug (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleVerbose (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleInfo (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleWarn (const DtString &channel="") const
 
virtual DtOutputStream & objectConsoleError (const DtString &channel="") const
 
virtual int notifyLevel () const
 
virtual DtSimResourceManagerresourceManager ()
 
virtual const
DtSimResourceManager
resourceManager () const
 
VRF4API_METHOD const
DtSimulationServices
simManager () const
 
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
 
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 
bool operator== (const DtReaderWriter &) const
 
bool operator!= (const DtReaderWriter &rhs)
 
virtual ~DtReaderWriter ()
 
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual void postPutSelf ()
 
virtual void prePutSelf ()
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
virtual void postGetSelf ()
 
virtual void preGetSelf ()
 
virtual void writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 
virtual DtSymbolString name () const
 
virtual void addAlias (const DtSymbolString &alias)
 
virtual void addAlias (const DtString &alias)
 
virtual bool hasAlias (const DtSymbolString &alias)
 
virtual const aliasContaineraliases () const
 
virtual void setReadonly (bool flag)
 
bool isReadonly () const
 
virtual void reset ()
 
virtual int alignment () const
 
virtual bool variableIsBound () const
 
virtual void unbindVariable ()
 
virtual void setName (const DtString &)
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual DtString prettyPrint () const
 
std::string debugText () const
 
virtual void bindVariables (DtVariableBindingsList variableBindings)
 
virtual std::list
< DtVariableNameType
unboundVariables () const
 
bool invalid () const
 
virtual bool hasChild (const DtReaderWriter *p) const
 
virtual bool hasVariableReference () const
 
virtual void bindLocalVariables (const DtVariableBindingsList &variableBindings)
 
virtual void recordUpdateTime () const
 
virtual bool wasUpdatedSince (DtTime t) const
 
virtual bool changedSinceLastChecked ()
 
virtual bool peekChangedSinceLastChecked () const
 
virtual void setValueSpecified (bool specified, bool recurse=false)
 
virtual bool valueSpecified () const
 
virtual bool isVariableReference () const
 
virtual void setIsVariableReference (bool value)
 
virtual void clearAllVariableReferenceFlags ()
 
virtual DtSymbolString variableName () const
 
virtual void setVariableName (const DtSymbolString variableName)
 
virtual const DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () const
 
virtual bool toXml (const DtFilename &) const
 
virtual bool fromXml (const DtString &)
 
virtual bool fromXmlFile (const DtFilename &)
 
virtual void putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual void unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
 
virtual void getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
 

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
- Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactoryfactory ()
 
static void setFactory (DtSimComponentFactory *factory)
 
static DtSimComponentcreateComponent (const DtString &name, const DtString &type, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentSystem *parentSystem, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 
static void addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
 
static VRF4API_METHOD
DtSimComponent
MarkThreadSafe (DtSimComponent *comp)
 
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (std::string &fp, int indentLevel)
 
static const
DtVariableBindingsList
nullVariableReference ()
 
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
 
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
 
static void setPutIndent (bool)
 
static bool putIndent ()
 
static const chartheXmlType ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Member Functions

virtual bool createPSR ()
 
virtual bool createCollisionDetector ()
 
virtual bool setObstructionIDsInCollisionDetector ()
 
virtual bool initializeCollisionBV ()
 
virtual bool calculateStoppingDistance (const DtObstructionSensorDescriptor &obstructionSensorDesc, double &stoppingDistance)
 
virtual bool calculateCollisionBV ()
 
virtual void registerMessageCallbacks ()
 
virtual void processCollisionAvoidTypes (DtSimMessage *msg)
 
virtual bool addFeatureTypeToAvoid (DtRwString featureType)
 
virtual bool removeFeatureTypeToAvoid (DtRwString featureType)
 
virtual DtRwString buildingFeatureType () const
 
virtual DtRwString treeFeatureType () const
 
virtual double decelerationSoilFactor () const
 
virtual bool createPorts ()
 
virtual bool createPortGroups ()
 
- Protected Member Functions inherited from DtSimComponent
virtual double computeCurrentTime ()
 
bool testInvariant () const
 
DtVrfProcessStateRepositorycreateComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
 
virtual void updateTaskVisualizations ()
 
virtual void destroyTaskVisualizations ()
 
virtual void destroyTaskVisualization (const DtString &name)
 
virtual
makVrf::DtPointTaskVisualizationPtr 
pointTaskVisualization (const DtString &name)
 
virtual
makVrf::DtLineTaskVisualizationPtr 
lineTaskVisualization (const DtString &name)
 
virtual
makVrf::DtAreaTaskVisualizationPtr 
areaTaskVisualization (const DtString &name)
 
virtual
makVrf::DtTextTaskVisualizationPtr 
textTaskVisualization (const DtString &name)
 
double calculateNextTaskVisTickTime () const
 
DtVrfObjectStateRepositorylocalStateRepository ()
 
const DtVrfObjectStateRepositorylocalStateRepository () const
 
void addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
 
void removeSimObjectPredicateCallback (const DtSimObject *, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)
 
void invokeSimObjectPredicateCallbacks ()
 
virtual void clearPredicateCallbacks ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 

Static Protected Member Functions

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

Protected Attributes

Dt3dBoundingVolume * myCollisionBV
 
DtCollisionDetectormyCollisionDetector
 
DtCollisionDetector::DtObjectObstructionIDContainer myObjectObstructionIDs
 
DtCollisionDetector::DtFeatureTypeContainer myFeatureObstructionTypes
 
const
DtObstructionSensorDescriptor
myObstructionSensorDesc
 
DtObstructionSensorPSRmyProcessState
 
DtCollisionmyPotentialCollision
 
DtPlatformLocalObjectFacade myPlatformLocalObjectFacade
 
Ports and Port Groups
DtCollisionOutputPortmyPotentialCollisionInfoPort
 
DtOutputPortGroupmyObstructionInfoPortGroup
 
- Protected Attributes inherited from DtSimComponent
DtLocalObjectmyEntity
 
DtComponentSystemmySystem
 
DtListItem * myListItem
 
DtInputPortMap myInputPortList
 
DtOutputPortMap myOutputPortList
 
DtInputPortGroupMap myInputPortGroupList
 
DtOutputPortGroupMap myOutputPortGroupList
 
int myPriority
 
double myMinTickPeriod
 
double myMinTickPeriodVariance
 
double myNextTickTime
 
double myLastTickSimTime
 
double myDT
 
bool myIsEnabled
 
bool myFirstTick
 
const DtComponentDescriptormyComponentDescriptor
 
std::list
< DtVrfProcessStateRepository * > 
myComponentPsrs
 
bool myTickEveryFrame
 
makVrf::DtTaskVisualizationMap myTaskVisualizations
 
double myNextTaskVisTickTime
 
DtSymbolString myFullComponentName
 
DtSimulationServicesmySimServices
 
DtPredicateCallbackManager myPredicateCallbackManager
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
aliasContainer myAliases
 
bool myInvalid
 
bool myChangedFlag
 

Private Member Functions

 DtObstructionSensor (const DtObstructionSensor &orig)
 
DtObstructionSensoroperator= (const DtObstructionSensor &orig)
 

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::vector< DtFilename > SearchPaths
 
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 DtSimComponentFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Constructor & Destructor Documentation

DtObstructionSensor::DtObstructionSensor ( const DtString name,
DtLocalObject owner,
DtSimulationServices simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

Parameters
nameReader writer name of this component.
ownerThe DtLocalObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
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
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.

Reimplemented in DtHumanObstructionSensor.

virtual const char* 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. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Returns
DtObstructionSensorType

Implements 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
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,
DtLocalObject owner,
DtSimulationServices simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)
static

Parameters
nameReader writer name of this component.
ownerThe DtLocalObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
Returns
New instance of this class.
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.

Reimplemented in DtHumanObstructionSensor.

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
DtPlatformLocalObjectFacade DtObstructionSensor::myPlatformLocalObjectFacade
protected

Member to allow for access to platform specific data.


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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)