DtHumanCoverPointController Class Reference

DtHumanCoverPointController is a controller that models finding cover from a particular group of entities and finding a point that cannot be seen from those entities within a certain distance. More...

Inheritance diagram for DtHumanCoverPointController:

Public Member Functions
	DtHumanCoverPointController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
virtual	~DtHumanCoverPointController ()
	Destructor.
virtual bool	init ()
	Init. Call immediately after construction.
virtual const char *	type () const
virtual void	tick ()
	This components simulation tick.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual void	suspendTask ()
	This method is called when the currently running task is being suspended.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
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	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 (std::string &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 DtReaderWriter::SearchPaths &searchPaths, 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 DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component.
virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe.
virtual void	addVRLinkDeferredJob (const boost::function< void()> &callback)
	Adds a deferred job to the VRLink job queue in the DtParallelTickManager, but only if this component is marked at thread safe.
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 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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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 void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static void	coverPointCallback (DtSimMessage *msg, void *usr)
	Callback function that handles DtScriptedTask of find_cover_point script id.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Static creator function for factory registration.

Protected Member Functions
virtual bool	usingNavBot () const
virtual void	processCoverPointTask (DtSimMessage *msg)
virtual void	registerTaskMsgCallbacks ()
	Overridden to register interest in move to messages.
virtual void	processNavAreaChanged ()
virtual DtVector	findCoverFromPoint (DtScriptedTaskTask *)
	Get the original find cover from from point. If there are no entities to find cover from assumes current entity location.
virtual void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual bool	findCoverPoint (DtVector &)
	Search for a cover point that is cloest to the enities current position that is hidden from the target entities and that cover point is within the cover distance defined in the descriptor.
virtual DtOnGraphVertexVisitedResult	processCoverPoint (const DtVector &localCheck)
virtual void	processCoverPointCostPointModification (const DtVector &localCheck, float *costmod)
virtual void	processObjectAboutToBeRemoved (DtVrfObject *msg)
virtual void	offsetForEntity (DtVector &localPosition) const
virtual void	useNavBotData ()
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
virtual void	stop (bool success)
virtual void	moveToDestination ()
virtual void	processCoverPointTask (DtScriptedTaskTask *)
	Processes cover task by finding destination point and then moving torwards it.
virtual void	showCoverPoint ()
virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
virtual bool	createPSR ()
virtual bool	destinationIsInsideObstruction (const DtVector &localDestination)
	Returns whether or not current destination is inside an obstruction.
virtual void	setupPathFollowing ()
virtual DtVector	targetPoint (const DtVector &from, double heading, double distance) const
	Get the target point as a max distance along the angle of check from source to target given the distance (in meters)
virtual bool	hasLosTo (const DtVector &origin, double headingOffOfOrigin, double offsetFromOrigin, double headingToTargetPoint, double distanceToTargetPoint)
	Check for LOS from point to the "left" or "right" of the target point and distance away from that.
virtual bool	entityInDestination (const DtVector &dest)
virtual void	processNavigationInterfaceChanged (DtVrfObject *)
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.
virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller.
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables.
virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	navAreaChangedCallback (void *usr)
static DtOnGraphVertexVisitedResult	coverPointCheckCallback (const DtVector &localCheck, void *usr)
	Callback when searching to look at point.
static void	coverPointCostPointModificationCallback (const DtVector &localCheck, float *costmod, void *usr)
	Modify cost of point after initial cost calculation.
static void	objectAboutToBeRemoved (DtVrfObject *msg, void *usr)
	If cover point, clear it out.
static void	navigationInterfaceChanged (DtVrfObject *, void *usr)

Protected Attributes
DtHumanCoverPointControllerDescriptor *	myHumanCoverPointControllerDescriptor
DtActiveBotNavInterface *	myNavInterface
bool	myIgnoreNavData
std::vector< DtUUID >	myFindCoverFrom
const DtHumanStateRepository *	myHumanSR
DtNavAreaQuery::Ptr	myCoverPointQuery
DtCollisionInputPort *	myCollisionAvoidancePort
	Input Port Name: potential-collision-info Input Port Description: information about an impending potential collision with an entity or terrain vector data feature.
DtInputPortGroup *	myCollisionAvoidancePortGroup
	Input Port Group Name: collision-avoidance-control Input Port Group Description:
DtHumanMovementControlOutputPortGroup *	myHumanMovementControlOutputPortGroup
	Output Group Name: movement-control .
DtVectorOutputPort *	myDestinationOutputPort
	Output Port Name: destination Output Port Description: Specifies the current destination of the entity in geocentric coordinates.
DtBooleanOutputPort *	myIsMovingPort
	Output Port Name: is-moving Output Port Description: Indicates the entity is being actively moved by this controller.
DtHumanCoverPointPSR *	myProcessState
bool	myResetRouteWhenCan
bool	mySetupFromTaskWhenCan
int	myOnPass
double	myPostSpacing
double	mySearchRadius
DtVector	mySearchStartPoint
DtVector	myFindCoverFromPoint
bool	myCalculatingCoverPoint
boost::unordered_set< std::string >	myCheckedPoints
int	myCoverPointEvalCounter

Private Member Functions
	DtHumanCoverPointController ()
	Not Implemented.
	DtHumanCoverPointController (const DtHumanCoverPointController &orig)
	Not Implemented.
DtHumanCoverPointController &	operator= (const DtHumanCoverPointController &orig)
	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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtHumanCoverPointController is a controller that models finding cover from a particular group of entities and finding a point that cannot be seen from those entities within a certain distance.

Uses Descriptor Type: DtHumanCoverPointControllerDescriptor

Constructor & Destructor Documentation

DtHumanCoverPointController::DtHumanCoverPointController ( )

private

Not Implemented.

DtHumanCoverPointController::DtHumanCoverPointController ( const DtHumanCoverPointController &  orig )

private

Not Implemented.

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

Constructor.

virtual DtHumanCoverPointController::~DtHumanCoverPointController ( )

virtual

Destructor.

Member Function Documentation

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

private

Not Implemented.

virtual bool DtHumanCoverPointController::init ( )

virtual

Init. Call immediately after construction.

Reimplemented from DtControllerComponent.

virtual const char* DtHumanCoverPointController::type ( ) const

virtual

Returns

DtHumanCoverPointControllerType

Implements DtTaskControllerComponent.

virtual void DtHumanCoverPointController::tick ( )

virtual

This components simulation tick.

Reimplemented from DtSimComponent.

static void DtHumanCoverPointController::coverPointCallback ( DtSimMessage *  msg, void *  usr  )

static

Callback function that handles DtScriptedTask of find_cover_point script id.

Calls processCoverPointTask().

Parameters

msg	Message containing DtMoveToTask.
usr	Pointer to an instance of this class.

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

static

Static creator function for factory registration.

virtual bool DtHumanCoverPointController::usingNavBot ( ) const

protectedvirtual

virtual void DtHumanCoverPointController::processCoverPointTask ( DtSimMessage *  msg )

protectedvirtual

virtual void DtHumanCoverPointController::registerTaskMsgCallbacks ( )

protectedvirtual

Overridden to register interest in move to messages.

Reimplemented from DtTaskControllerComponent.

static void DtHumanCoverPointController::navAreaChangedCallback ( void *  usr )

staticprotected

virtual void DtHumanCoverPointController::processNavAreaChanged ( )

protectedvirtual

virtual DtVector DtHumanCoverPointController::findCoverFromPoint ( DtScriptedTaskTask *  )

protectedvirtual

Get the original find cover from from point. If there are no entities to find cover from assumes current entity location.

virtual void DtHumanCoverPointController::clearTask ( )

protectedvirtual

If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.

Reimplemented from DtSingleTaskControllerComponent.

virtual bool DtHumanCoverPointController::findCoverPoint ( DtVector &  )

protectedvirtual

Search for a cover point that is cloest to the enities current position that is hidden from the target entities and that cover point is within the cover distance defined in the descriptor.

static DtOnGraphVertexVisitedResult DtHumanCoverPointController::coverPointCheckCallback ( const DtVector &  localCheck, void *  usr  )

staticprotected

Callback when searching to look at point.

Return false if want to continue looking at points or true if done looking at possible cover points

virtual DtOnGraphVertexVisitedResult DtHumanCoverPointController::processCoverPoint ( const DtVector &  localCheck )

protectedvirtual

static void DtHumanCoverPointController::coverPointCostPointModificationCallback ( const DtVector &  localCheck, float *  costmod, void *  usr  )

staticprotected

Modify cost of point after initial cost calculation.

virtual void DtHumanCoverPointController::processCoverPointCostPointModification ( const DtVector &  localCheck, float *  costmod  )

protectedvirtual

static void DtHumanCoverPointController::objectAboutToBeRemoved ( DtVrfObject *  msg, void *  usr  )

staticprotected

If cover point, clear it out.

virtual void DtHumanCoverPointController::processObjectAboutToBeRemoved ( DtVrfObject *  msg )

protectedvirtual

virtual void DtHumanCoverPointController::offsetForEntity ( DtVector &  localPosition ) const

protectedvirtual

virtual void DtHumanCoverPointController::useNavBotData ( )

protectedvirtual

virtual bool DtHumanCoverPointController::createPortGroups ( )

protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output port groups.

Reimplemented from DtSimComponent.

virtual bool DtHumanCoverPointController::createPorts ( )

protectedvirtual

Called by init.

Derived classes should override this method to create all their input/output ports and port groups.

Reimplemented from DtSimComponent.

virtual void DtHumanCoverPointController::stop ( bool  success )

protectedvirtual

virtual void DtHumanCoverPointController::moveToDestination ( )

protectedvirtual

virtual void DtHumanCoverPointController::processCoverPointTask ( DtScriptedTaskTask *  )

protectedvirtual

Processes cover task by finding destination point and then moving torwards it.

virtual void DtHumanCoverPointController::showCoverPoint ( )

protectedvirtual

virtual void DtHumanCoverPointController::preFirstTickInit ( )

protectedvirtual

This function can be overridden to initialize a component before it is ticked for the first time.

The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

virtual bool DtHumanCoverPointController::createPSR ( )

protectedvirtual

virtual bool DtHumanCoverPointController::destinationIsInsideObstruction ( const DtVector &  localDestination )

protectedvirtual

Returns whether or not current destination is inside an obstruction.

virtual void DtHumanCoverPointController::setupPathFollowing ( )

protectedvirtual

virtual DtVector DtHumanCoverPointController::targetPoint ( const DtVector &  from, double  heading, double  distance  ) const

protectedvirtual

Get the target point as a max distance along the angle of check from source to target given the distance (in meters)

virtual bool DtHumanCoverPointController::hasLosTo ( const DtVector &  origin, double  headingOffOfOrigin, double  offsetFromOrigin, double  headingToTargetPoint, double  distanceToTargetPoint  )

protectedvirtual

Check for LOS from point to the "left" or "right" of the target point and distance away from that.

virtual bool DtHumanCoverPointController::entityInDestination ( const DtVector &  dest )

protectedvirtual

static void DtHumanCoverPointController::navigationInterfaceChanged ( DtVrfObject *  , void *  usr  )

staticprotected

virtual void DtHumanCoverPointController::processNavigationInterfaceChanged ( DtVrfObject *  )

protectedvirtual

Member Data Documentation

DtHumanCoverPointControllerDescriptor* DtHumanCoverPointController::myHumanCoverPointControllerDescriptor

protected

DtActiveBotNavInterface* DtHumanCoverPointController::myNavInterface

protected

bool DtHumanCoverPointController::myIgnoreNavData

protected

std::vector<DtUUID> DtHumanCoverPointController::myFindCoverFrom

protected

const DtHumanStateRepository* DtHumanCoverPointController::myHumanSR

protected

DtNavAreaQuery::Ptr DtHumanCoverPointController::myCoverPointQuery

protected

DtCollisionInputPort* DtHumanCoverPointController::myCollisionAvoidancePort

protected

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

Input Port Range:
Input Port Default Value:
Input Group Parent: collision-avoidance-control

DtInputPortGroup* DtHumanCoverPointController::myCollisionAvoidancePortGroup

protected

Input Port Group Name: collision-avoidance-control
Input Port Group Description:

DtHumanMovementControlOutputPortGroup* DtHumanCoverPointController::myHumanMovementControlOutputPortGroup

protected

Output Group Name: movement-control
.

DtVectorOutputPort* DtHumanCoverPointController::myDestinationOutputPort

protected

Output Port Name: destination
Output Port Description: Specifies the current destination of the entity in geocentric coordinates.

Output Port Range:
Output Group Parent:

DtBooleanOutputPort* DtHumanCoverPointController::myIsMovingPort

protected

Output Port Name: is-moving
Output Port Description: Indicates the entity is being actively moved by this controller.

Output Port Range:
Output Group Parent:

DtHumanCoverPointPSR* DtHumanCoverPointController::myProcessState

protected

bool DtHumanCoverPointController::myResetRouteWhenCan

protected

bool DtHumanCoverPointController::mySetupFromTaskWhenCan

protected

int DtHumanCoverPointController::myOnPass

protected

double DtHumanCoverPointController::myPostSpacing

protected

double DtHumanCoverPointController::mySearchRadius

protected

DtVector DtHumanCoverPointController::mySearchStartPoint

protected

DtVector DtHumanCoverPointController::myFindCoverFromPoint

protected

bool DtHumanCoverPointController::myCalculatingCoverPoint

protected

boost::unordered_set<std::string> DtHumanCoverPointController::myCheckedPoints

protected

int DtHumanCoverPointController::myCoverPointEvalCounter

protected

---

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

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