This class provides a base class for all controllers that are capable of executing a DtSimTask, and can only execute a single DtSimTask at a time. More...

Inherits DtTaskControllerComponent.

Public Member Functions
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()
	destructor More...

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)). More...

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task. More...

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. More...

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. More...

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. More...

virtual void	suspendTask ()
	This method is called when the currently running task is being suspended. More...

virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself. More...

virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()). More...

virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks. More...

virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks. More...

virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked. More...

virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component. More...

virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks. More...

virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller. More...

virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id. More...

virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity. More...

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. More...

virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true. More...

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared. More...

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type. More...

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller. More...

virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller. More...

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	disable ()
	Overridden to allow tasks controllers that can be disabled to call task complete. More...

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTaskControllerComponent ()
	destructor More...

virtual const char *	type () const =0
	Returns a string identifies the class type of component. More...

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks. More...

virtual void	registerTaskMsgCallbacks ()

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type. More...

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback. More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback(). More...

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback. More...

virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks(). More...

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message. More...

virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component. More...

virtual void	setTasked (bool tasked)
	The current tasked state of this controller. More...

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()
	destructor More...

virtual bool	init ()
	Calls setRadio() More...

virtual DtSimRadio *	radio ()
	The radio this component is listening to. More...

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()
	destructor More...

virtual void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component. More...

DtComponentSystem *	parentSystem () const

virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager. More...

virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values. More...

virtual void	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time. More...

virtual void	tick ()
	This gives the thread of control to the component. More...

virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived. More...

virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as More...

virtual double	minTickPeriod () const
	access the minimum tick period More...

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time More...

virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period More...

virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally. More...

virtual double	nextTickTime () const
	access the next tick time More...

virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2. More...

virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at. More...

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. More...

virtual DtSimComponent *	nextComponent ()
	List management functions. More...

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)
	Used by DtComponentList. More...

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. More...

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. More...

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. More...

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. More...

virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component. More...

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. More...

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. More...

virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component. More...

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. More...

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. More...

virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component. More...

virtual int	priority () const
	Return the current connection priority for this component. More...

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. More...

double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT. More...

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. More...

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. More...

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. More...

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in. More...

const DtPhysicalWorld *	physicalWorld () const

DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any. More...

const DtAttachedTerrain *	terrainAttachedTo () const

DtVrfObject *	entity ()
	Gets the entity. More...

const DtVrfObject *	entity () const

const DtVrfObject *	const_entity () const
	You would want to use this call if you could be either a const or non-const entity, and you wanted to be sure you only had const access. More...

DtSimManager *	simManager ()
	Gets the sim manager. More...

const DtSimManager *	simManager () const

const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state! More...

DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository. More...

const DtVrfObjectStateRepository *	localStateRepository () const

const DtVrfObjectStateRepository *	const_localStateRepository () const
	You would want to use this call if you could be either a const or non-const local state repository, and you wanted to be sure you only had const access. More...

virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component. More...

virtual bool	taskVisualizationsEnabled () const
	Returns true if task visualizations are enabled for this component. More...

virtual bool	isThreadSafe () const
	Returns true if this component is marked as being thread safe. More...

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. More...

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 More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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. More...

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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. More...

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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. More...

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. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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. More...

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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. More...

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

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. More...

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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. More...

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

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. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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. More...

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. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Protected Member Functions
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type. More...

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type. More...

virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller. More...

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. More...

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends a single running subtasks of taskId, and puts the suspend info into the provided suspendInfo. More...

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
	In case this is aliased, return the actual script id. More...

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor More...

	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor More...

const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator More...

virtual void	onRestore ()
	Override to iterate over the descriptor to see if there are any targetting control tables. More...

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT. More...

bool	testInvariant () const

virtual bool	createPortGroups ()
	Called by init. More...

virtual bool	createPorts ()
	Called by init. More...

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager. More...

virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick. More...

virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component. More...

virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization. More...

virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name. More...

virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name. More...

virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name. More...

virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name. More...

double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked. More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()

	DtObjectDebugger (const DtObjectDebugger &)

	~DtObjectDebugger ()

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

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)
	Task processor callback function that acts as an adapter for the deprecated forms of addTaskProcessorCallback and removeTaskProcessorCallback (the deprecated form is is version that. More...

Static Public Member Functions inherited from DtSimComponent
static DtSimComponent *	MarkThreadSafe (DtSimComponent *)
	Marks an instance of a component as being thread safe. More...

static DtSimComponentFactory *	factory ()
	A DtSimComponentFactory is allocated by the DtSimCreator, and this pointer is set. More...

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. More...

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)
	Adds a DtSimComponent creation function to the DtSimComponentFactory, using the given type as the key. More...

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 char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Static Public Member Functions inherited from DtObjectDebugger< DtSimComponent >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks. More...

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

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

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
	This list stores any DtTaskProcessorCallbackInfo allocated locally so that they can be deleted when the component is deleted. More...

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages. More...

Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity

DtVrfObjectStateRepository *	myLocalStateRepository

DtSimManager *	mySimManager

DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs. More...

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. More...

bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick. More...

bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false. More...

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed. More...

bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame. More...

DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component. More...

double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations. More...

DtSymbolString	myFullComponentName

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object. More...

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Detailed Description

This class provides a base class for all controllers that are capable of executing a DtSimTask, and can only execute a single DtSimTask at a time.

This is the typical case for most task controllers, so most controllers will be derived from this class.

Constructor & Destructor Documentation

DtSingleTaskControllerComponent::DtSingleTaskControllerComponent	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	compDesc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

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

virtual DtSingleTaskControllerComponent::~DtSingleTaskControllerComponent ( )

virtual

destructor

Member Function Documentation

virtual void DtSingleTaskControllerComponent::postTick ( )

virtual

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

Calls decideToGiveUpTask() to determine if we should give up. If true, calls giveUpTask().

Reimplemented from DtSimComponent.

virtual bool DtSingleTaskControllerComponent::beginProcessingTask	(	const DtTaskMessage &	task,
		DtSimTaskStatePtr	taskState
	)

virtual

Called by the task manager when this controller should start executing the specified task.

Parameters

taskState Used to convey at what point the task should begin execution. If taskState exists, execution of task may begin at some point other than the logical start of the task. If taskState is 0, begin processing at the logical start of the task.

Returns: True if the controller can successfully start the task.; False if the controller is failing the task.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtRotaryWingFlightCommandController, and DtFixedWingFlightCommandController.

virtual void DtSingleTaskControllerComponent::taskNotify ( const DtSimTask & task )

virtual

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.

Reimplemented from DtTaskControllerComponent.

virtual void DtSingleTaskControllerComponent::taskComplete ( bool success = true )

virtual

If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.

To indicate that the task has failed (and is being abandoned) call this method with success set to false.

Reimplemented in DtSurfaceEntityMoveAlongController, DtDiGuyController, DtFixedWingMoveToController, DtIndirectFireController, DtTargetSelectionController, DtLaunchExpendableResourceController, and DtDiGuyGestureController.

virtual void DtSingleTaskControllerComponent::clearTask ( )

virtual

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 DtControllerComponent.

Reimplemented in DtRoadMovementController, DtFixedWingMoveAlongController, DtFixedWingMoveToController, DtAggregatedMoveToController, DtMunitionLaunchController, DtHumanMoveToController, DtGroundMoveAlongControllerComponent, DtRailPathController, DtDiGuyController, DtHumanMoveAlongController, DtAggregatedMoveAlongController, DtRotaryWingMoveAlongControllerComponent, DtDisaggregatedEmbarkationController, DtHumanFollowController, DtParachuteController, DtDisaggregatedMoveAlongController, DtSurfaceEntityPilotController, DtHumanFleeController, DtRotaryWingFlightCommandController, DtSurfaceEntityFollowEntityController, DtGroundMoveToDestinationControllerComponent, DtEmbarkationController, DtSubSurfaceDepthController, DtLookAtPointController, DtFixedWingLandingController, DtFixedWingTakeoffController, DtCreateEngineeringObjectController, DtLasingController, DtHumanCoverPointController, DtFixedWingFlightCommandController, DtAggregateFollowController, DtDisaggregatedMoveIntoFormationController, DtConvoyTaskController, DtFixedWingPilotController, DtHumanTurnToController, DtIndirectFireController, DtDestroyEngineeringObjectController, DtSurfaceEntityMoveAlongController, DtDisaggregatedMoveToLocationController, DtScriptedMovementController, DtHumanStopMovingController, DtMoveAlongWithActionsController, DtRotaryWingLandingController, DtDisaggregatedMoveToController, DtGroundAutoControllerComponent, DtRotaryWingTaskController, DtSurfaceEntityMoveToController, and DtFascamController.

virtual void DtSingleTaskControllerComponent::suspendTask ( )

virtual

This method is called when the currently running task is being suspended.

The default implementation is to cancel all subtasks of this task.

Reimplemented in DtHumanMoveToController, and DtEmbarkationController.

virtual int DtSingleTaskControllerComponent::sendSubtask ( DtSimTask & task )

virtual

Sends subtask to ourself.

Creates task message and sends task to ourself through radio. Adds subtask Id to list of pending subtasks. Returns subtask Id.

virtual void DtSingleTaskControllerComponent::clearSubtask ( int subtaskId )

virtual

Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).

Also removed the subtask ID from the pending subtask ID list.

virtual void DtSingleTaskControllerComponent::addPendingSubtaskId ( int subtaskId )

virtual

Adds given subtask Id to list of pending subtasks.

This is done automatically by sendSubtask (user should not typically have to call this directly).

virtual bool DtSingleTaskControllerComponent::findPendingSubtaskId ( int subtaskId )

virtual

Checks to see if given subtaskId exists in our list of pending subtasks.

Typically checked from within a task complete callback, to determine if given report corresponds to the specific subtask we issued.

virtual bool DtSingleTaskControllerComponent::isSubtasked ( ) const

virtual

Returns true if this controller is currently subtasked.

virtual void DtSingleTaskControllerComponent::removePendingSubtaskId ( int subtaskId )

virtual

Removes pending subtask from list of subtasks for this component.

Users will typically call this from within a task complete callback, upon receipt of the specific subtasking task complete report they were waiting for.

virtual void DtSingleTaskControllerComponent::removeAllPendingSubtaskIds ( )

virtual

Clear all pending subtasks from our list of subtasks.

Users should not typically have to call this.

virtual std::vector<int> DtSingleTaskControllerComponent::currentPendingSubstaskIds ( ) const

virtual

Returns the list of all currently pending subtask ids for this controller.

virtual void DtSingleTaskControllerComponent::clearCurrentTaskMessage ( )

virtual

Returns the current subtask with the specified id.

Also returns the controller that is responsible. If NULL, no task was found Clear the current task message.

Reimplemented in DtEmbarkationController, and DtFixedWingLandingController.

virtual DtTaskMessage* DtSingleTaskControllerComponent::currentTaskMessage ( ) const

virtual

Get a pointer to the message that was used to task this entity.

virtual DtSimTaskStatePtr DtSingleTaskControllerComponent::currentTaskState ( ) const

virtual

Returns: Current execution state of the task. At the base class level, returns 0. Derived classes that have tasks with DtTaskState (data associated with execution of the task) may return a new DtTaskState instance, filled out with the appropriate information about the current task execution state. Task controllers that do not need to return task state do not need to override this function.

Reimplemented in DtAggregatedMoveAlongController, DtFixedWingMoveAlongController, DtDisaggregatedMoveAlongController, DtRailPathController, DtHumanMoveAlongController, DtDisaggregatedPatrolAlongController, DtWaitController, DtRotaryWingWaitController, DtDisaggregatedPatrolBetweenController, DtFixedWingPatrolRouteController, DtHumanPatrolController, DtAggregatedPatrolController, DtGroundMoveAlongControllerComponent, DtRotaryWingMoveAlongControllerComponent, DtRotaryWingPatrolBetweenController, DtRotaryWingPatrolRouteController, DtFixedWingPatrolBetweenController, DtGroundPatrolRouteController, DtLaunchExpendableResourceController, and DtGroundPatrolBetweenController.

virtual bool DtSingleTaskControllerComponent::decideToGiveUpTask ( ) const

virtual

This function is used to determine if the controller should give up trying to execute the current task.

Override this function to provide the test for determining if the task controller should give up. For example, a derived move-to-waypoint controller tasked to reach an unreachable waypoint might decide to give up after a certain amount of time, or after circling the point and failing to reach it. This function is called from within tick. If the controller is tasked and this function returns true, it calls giveUp(). The implementation in this class always returns false.

Reimplemented in DtFixedWingPilotController, DtSurfaceEntityPilotController, DtSurfaceEntityFollowEntityController, DtGroundAutoControllerComponent, DtGroundMoveToDestinationControllerComponent, DtHumanMoveToController, DtGroundMoveAlongControllerComponent, and DerivedMoveToController.

virtual void DtSingleTaskControllerComponent::giveUpTask ( )

virtual

Called when controller is tasked and decideToGiveUp() returns true.

Base class implementation calls clearTask(). Derived classes may override this function to perform some specific handling.

Reimplemented in DerivedMoveToController.

virtual bool DtSingleTaskControllerComponent::taskActive ( int taskId ) const

virtual

Returns: True if a task of this ID is current active in this controller.

Implements DtTaskControllerComponent.

virtual bool DtSingleTaskControllerComponent::clearTopLevelTasks ( )

virtual

If this controller has any top level tasks (not subtasks), they are cleared.

Returns: True if any tasks were cleared.

Implements DtTaskControllerComponent.

virtual void DtSingleTaskControllerComponent::clearConflictingTopLevelTasks ( const DtSimTaskMessageType & conflictType )

virtual

Clears any top level tasks on this controller that conflict with the conflict task type.

The task manager is used to determine what tasks conflict.

Implements DtTaskControllerComponent.

virtual void DtSingleTaskControllerComponent::clearTasksByType ( const DtSimTaskMessageType & taskType )

virtual

Clears any tasks of the specified type running in this controller.

Implements DtTaskControllerComponent.

virtual void DtSingleTaskControllerComponent::clearTaskById ( int taskId )

virtual

Clears any task of the specified ID running in this controller.

Implements DtTaskControllerComponent.

virtual DtSuspendedTaskInfo* DtSingleTaskControllerComponent::suspendTaskById ( int taskId )

virtual

Implements DtTaskControllerComponent.

virtual DtSuspendedTaskInfo* DtSingleTaskControllerComponent::suspendSubtaskById	(	int	taskId,
		int	subtaskId
	)

virtual

Implements DtTaskControllerComponent.

virtual std::list<DtTaskMessage*> DtSingleTaskControllerComponent::currentTaskMessages ( ) const

virtual

Returns: A list of pointers to task messages currently being run on this controller.

Implements DtTaskControllerComponent.

virtual DtTaskWithTaskStateListPtr DtSingleTaskControllerComponent::topLevelTasks ( ) const

virtual

Returns: A list of all top level tasks currently in this controller along with their task state, if any.

Implements DtTaskControllerComponent.

virtual void DtSingleTaskControllerComponent::disable ( )

virtual

Overridden to allow tasks controllers that can be disabled to call task complete.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtEmbarkationController, DtLasingController, DtWaitController, and DtHoldController.

virtual void DtSingleTaskControllerComponent::clearPendingSubtasks ( )

protectedvirtual

Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.

virtual void DtSingleTaskControllerComponent::clearSubtasksByType ( const DtSimTaskMessageType & taskType )

protectedvirtual

Clear all subtasks of a given type.

Should not normally be called (call clearSubtask(int subtaskId) to clear a given subtask instead). Provided as a utility function as an aid to backwards compatibility.

virtual void DtSingleTaskControllerComponent::cleanupInactiveSubtaskStatus ( )

protectedvirtual

Clears out subtask status entries that are either completed or canceled which were started by this controller.

This typically is not necessary to call. Cleanup happens automatically when the parent task ends.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/singleTaskControllerComponent.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation