READ ME!

Reactive task entries in the controller represent the state of reactive tasks for an entity. This is to say that it also represents whether it is disabled for a specific entity, enabled for a specific entity, or any other state it may be in (such as currently active). This is important to note when modifying the code in this class as doing things such as clearing out the reactive task list from the PSR is going to result in incorrect behavior.

For instance, if a reactive task is active (reacting), and someone disables it, the entry still exists even after the active reaction completes since we need to remember that it was disabled for this entity. When a scenario loads, all reactive task state is remembered and restored and is then diff'd against the current available reactive tasks and makes intelligent decisions on what to do with the entry (remove it? keep it? add new ones?).

Similarly, during runtime, straight removal of entries must be treated differently in that they should not be removed. Using the function to mark them for deletion (in the entry class, see DtRwScriptReactiveTaskEntry) will guarantee that they will no longer be used by this controller (and the PSR) and will take care of all of the necessary cleanup.

Adding a new entry takes a bit more thought as it does require you to add it to the three maps that contain the current state data in the PSR. See the code for instances in which entries are created and added to the various maps.

Inheritance diagram for DtScriptReactiveTaskController:

[legend]

Public Member Functions
	DtScriptReactiveTaskController (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc, DtReaderWriterRegistry parentRegistry)

virtual	~DtScriptReactiveTaskController ()

virtual const char *	type () const

virtual bool	init ()

virtual void	preFirstTickInit ()

virtual void	tick ()

virtual std::list < DtScriptedTaskTask >	reactiveTaskStatus () const

virtual bool	isReactiveTaskEnabled (const DtSimTaskMessageType &scriptId) const

virtual void	notifySuspend (const DtSimTaskMessageType &scriptId, int taskId)

virtual void	notifyResume (const DtSimTaskMessageType &scriptId, int taskId)

virtual void	processReturnScriptInterface (const DtSimTaskMessageType &scriptId, int taskId, boost::shared_ptr< DtScriptInterface > iFace)

virtual bool	enableReactiveTask (const DtSimTaskMessageType &scriptId, DtRwVariableBindings &params, const DtString &systemName, bool resetIfEnabled=false)

virtual bool	createPSR ()

virtual std::set < DtSimTaskMessageType >	availableReactiveTasks () const

virtual DtString	systemFor (const DtSimTaskMessageType &scriptId) const


virtual void	scriptSetTickPeriod (int taskId, const DtString &scriptId, double period)

virtual void	scriptSetTickWhilePaused (int taskId, const DtString &scriptId, bool enable)

virtual void	scriptSetRespondToNewSensorContacts (int taskId, const DtString &scriptId, bool tick)

virtual void	scriptTaskComplete (int taskId, bool success)

virtual void	scriptSetComplete (const DtString &)

virtual int	scriptSendSubtask (DtSimTask &task, int parentTaskId)

virtual std::vector< int >	scriptPendingSubstaskIds (int taskId)

virtual DtSubtaskStatusEntry *	scriptSubtaskStatus (int subtaskId, int parentTaskId)

virtual void	cleanupInactiveSubtaskStatus (int parentTaskId)

virtual void	scriptClearSubtask (int subtaskId, int parentTaskId)

virtual int	scriptSendTask (DtSimTask &task, const DtUUID &entityName, int parentTaskId, bool actAsSubtask=true, bool useRadio=false)

virtual void	setCheckpointModeUseCheckpointState (int taskId, const DtString &scriptId, bool)

virtual bool	checkpointModeUseCheckpointState (int taskId, const DtString &scriptId) const

virtual int	askUserQuestion (const DtString &scriptId, const DtTranslatableStream &title, const DtTranslatableStream &message, const std::vector< DtTranslatableStream > &options, int displayFlag)

virtual int	statusOfUserQuestion (int questionId)

virtual void	cancelUserQuestion (int questionId)

virtual void	addReactiveTaskType (const DtSimTaskMessageType &, const DtString &system="")

virtual void	notifyScriptTaskError (const DtString &scriptId, int taskId)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (int taskId, const DtString &visName)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (int taskId, const DtString &visName)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (int taskId, const DtString &visName)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (int taskId, const DtString &visName)

virtual void	deleteTaskVisualization (int taskId, const DtString &visName)

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()

virtual bool	postAddComponentsInit () override

virtual DtSimRadio *	radio ()

virtual void	taskNotify (const DtSimTask &task)

virtual void	clearTask ()

virtual void	enableTaskTypes ()

virtual void	enableScriptedTask (const DtString &scriptId)

virtual void	disableTaskTypes ()

virtual void	enable () override

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)

DtComponentSystem *	parentSystem () const

virtual void	registerAttributeFunctions ()

virtual void	postTick ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod, double minTickPeriodVariance)

virtual void	setupFirstTickTime ()

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

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 DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (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

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual void	isClutterChanged ()

virtual bool	taskVisualizationsActive () const

virtual bool	taskVisualizationsEnabled () const

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

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 DtSimResourceManager &	resourceManager ()

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 DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

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 aliasContainer &	aliases () 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 char *	readerWriterType () const

virtual const char *	xmlType () 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	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 DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () 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)

Public Member Functions inherited from DtScriptTaskControllerInterface
virtual	~DtScriptTaskControllerInterface ()

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc, DtReaderWriterRegistry parentRegistry)

static void	setReactiveTaskCallback (DtSimMessage msg, void usr)

static void	scriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info, void *usr)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (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 char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

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)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Types
typedef std::pair< int, DtSimTaskMessageType >	TaskAndScriptIds

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 Member Functions
	DtScriptReactiveTaskController ()

	DtScriptReactiveTaskController (const DtScriptReactiveTaskController &other)

DtScriptReactiveTaskController &	operator= (const DtScriptReactiveTaskController &other)

virtual bool	shouldInvokeCheck (DtRwScriptReactiveTaskEntry *entry)

virtual DtRwScriptReactiveTaskEntry *	createDefaultEntry (const DtString &scriptId, const DtString &system="")

virtual bool	createAndInitScriptInterface (DtRwScriptReactiveTaskEntry entry, DtRwVariableBindings params, bool loadState=false)

virtual void	activateReactiveTask (DtRwScriptReactiveTaskEntry *entry)

virtual void	disableReactiveTask (DtRwScriptReactiveTaskEntry *entry, bool cancelActive)

virtual void	processSetReactiveTaskCallback (DtSetDataRequest *setMsg)

virtual void	processSetCancel (DtSetReactiveTaskCancel *setMsg)

virtual void	processSetDisabled (DtSetReactiveTaskDisabled *setMsg)

virtual void	processSetEnabled (DtSetReactiveTaskEnabled *setMsg)

virtual void	processSetPriority (DtSetReactiveTaskPriority *setMsg)

virtual void	processSetTable (DtSetReactiveTaskTable *setMsg)

virtual void	setupReactiveTasks ()

virtual void	processScriptUpdatedCallback (const DtScriptedTaskManagerCallbackInfo &info)

virtual bool	doesScriptIdApply (const DtSimTaskMessageType &scriptId) const

virtual bool	isForMyEntityType (const DtScriptedTaskMetaData &metaData) const

virtual void	processUserQuestionOperation (DtSimMessage *)

virtual void	sendOffOutstandingQuestionFor (const DtSimTaskMessageType &scriptId)

virtual void	addReactiveTaskEntry (const DtSimTaskMessageType &scriptId, DtRwScriptReactiveTaskEntry *entry, bool deleteOnUpdate=true)

virtual void	queueReactiveTaskCallback (DtSetDataRequest *setMsg)


virtual void	processNewSensorContact ()

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore ()

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

virtual void	setRadio (DtSimRadio *radio)

virtual void	sendCapableSetsAndTasks ()

Protected Member Functions inherited from DtSimComponent
virtual void	setupTimedTickLogic (double minTickPeriod, double minTickPeriodVariance)

virtual double	computeCurrentTime ()

bool	testInvariant () const

virtual bool	createPortGroups ()

virtual bool	createPorts ()

DtVrfProcessStateRepository *	createComponentPsr (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

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

DtPropertyInterface *	cachedNextFrameStateProperty (DtPropertyInterface **prop, const DtString &propName)

template<typename ValType >
void	setCachedNextFrameStatePropertyValue (DtPropertyInterface **prop, const DtString &propName, ValType value)

const DtPropertyInterface *	cachedCurrentFrameStateProperty (const DtPropertyInterface **prop, const DtString &propName) const

template<typename ValType >
bool	getCachedCurrentFrameStatePropertyValue (const DtPropertyInterface **prop, const DtString &propName, ValType &value) 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)

Protected Member Functions inherited from DtScriptTaskControllerInterface
	DtScriptTaskControllerInterface ()

	DtScriptTaskControllerInterface (const DtScriptTaskControllerInterface &other)

DtScriptTaskControllerInterface &	operator= (const DtScriptTaskControllerInterface &other)

Static Protected Member Functions
static void	userQuestionOperationCallback (DtSimMessage msg, void usrData)

Protected Attributes
DtScriptReactiveTaskControllerPSR *	myProcessState

DtForceType	myCurrentForceType

std::map< DtSimTaskMessageType, DtString >	myAdditionalReactiveTasks

std::map< DtSimTaskMessageType, bool >	mySavedCheckpointMode

std::map< DtSimTaskMessageType, double >	mySavedTickPeriodSettings

std::map< DtSimTaskMessageType, bool >	mySavedTickWhilePausedSettings

std::vector< DtSetDataRequest * >	myQueuedReactiveTaskCallbacks

std::list< TaskAndScriptIds >	myRespondToNewSensorContactList

bool	mySetupReactiveTasks = false

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

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

bool	myInvalid

bool	myChangedFlag

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

Member Typedef Documentation

typedef std::pair<int, DtSimTaskMessageType> DtScriptReactiveTaskController::TaskAndScriptIds

protected

Constructor & Destructor Documentation

DtScriptReactiveTaskController::DtScriptReactiveTaskController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simServices,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *	parentRegistry
	)

virtual DtScriptReactiveTaskController::~DtScriptReactiveTaskController ( )

virtual

DtScriptReactiveTaskController::DtScriptReactiveTaskController ( )

protected

DtScriptReactiveTaskController::DtScriptReactiveTaskController ( const DtScriptReactiveTaskController & other )

protected

Member Function Documentation

static DtSimComponent* DtScriptReactiveTaskController::creator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simServices,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *	parentRegistry
	)

static

virtual const char* DtScriptReactiveTaskController::type ( ) const

virtual

This returns a string from compTypes.h, and identifies the type of component.

Implements DtControllerComponent.

virtual bool DtScriptReactiveTaskController::init ( )

virtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual void DtScriptReactiveTaskController::preFirstTickInit ( )

virtual

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 void DtScriptReactiveTaskController::tick ( )

virtual

This gives the thread of control to the component. The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

virtual std::list<DtScriptedTaskTask> DtScriptReactiveTaskController::reactiveTaskStatus ( ) const

virtual

virtual bool DtScriptReactiveTaskController::isReactiveTaskEnabled ( const DtSimTaskMessageType & scriptId ) const

virtual

virtual void DtScriptReactiveTaskController::notifySuspend	(	const DtSimTaskMessageType &	scriptId,
		int	taskId
	)

virtual

virtual void DtScriptReactiveTaskController::notifyResume	(	const DtSimTaskMessageType &	scriptId,
		int	taskId
	)

virtual

virtual void DtScriptReactiveTaskController::processReturnScriptInterface	(	const DtSimTaskMessageType &	scriptId,
		int	taskId,
		boost::shared_ptr< DtScriptInterface >	iFace
	)

virtual

virtual bool DtScriptReactiveTaskController::enableReactiveTask	(	const DtSimTaskMessageType &	scriptId,
		DtRwVariableBindings &	params,
		const DtString &	systemName,
		bool	resetIfEnabled = `false`
	)

virtual

static void DtScriptReactiveTaskController::setReactiveTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

static void DtScriptReactiveTaskController::scriptUpdatedCallback	(	const DtScriptedTaskManagerCallbackInfo &	info,
		void *	usr
	)

static

virtual void DtScriptReactiveTaskController::scriptSetTickPeriod	(	int	taskId,
		const DtString &	scriptId,
		double	period
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptSetTickWhilePaused	(	int	taskId,
		const DtString &	scriptId,
		bool	enable
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptSetRespondToNewSensorContacts	(	int	taskId,
		const DtString &	scriptId,
		bool	tick
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptTaskComplete	(	int	taskId,
		bool	success
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptSetComplete ( const DtString & )

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::scriptSendSubtask	(	DtSimTask &	task,
		int	parentTaskId
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual std::vector<int> DtScriptReactiveTaskController::scriptPendingSubstaskIds ( int taskId )

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual DtSubtaskStatusEntry* DtScriptReactiveTaskController::scriptSubtaskStatus	(	int	subtaskId,
		int	parentTaskId
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::cleanupInactiveSubtaskStatus ( int parentTaskId )

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::scriptClearSubtask	(	int	subtaskId,
		int	parentTaskId
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::scriptSendTask	(	DtSimTask &	task,
		const DtUUID &	entityName,
		int	parentTaskId,
		bool	actAsSubtask = `true`,
		bool	useRadio = `false`
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::setCheckpointModeUseCheckpointState	(	int	taskId,
		const DtString &	scriptId,
		bool
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual bool DtScriptReactiveTaskController::checkpointModeUseCheckpointState	(	int	taskId,
		const DtString &	scriptId
	)		const

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::askUserQuestion	(	const DtString &	scriptId,
		const DtTranslatableStream &	title,
		const DtTranslatableStream &	message,
		const std::vector< DtTranslatableStream > &	options,
		int	displayFlag
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual int DtScriptReactiveTaskController::statusOfUserQuestion ( int questionId )

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::cancelUserQuestion ( int questionId )

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::addReactiveTaskType	(	const DtSimTaskMessageType &	,
		const DtString &	system = `""`
	)

virtual

Adds this task to be considered a reactive task of this entity.

virtual void DtScriptReactiveTaskController::notifyScriptTaskError	(	const DtString &	scriptId,
		int	taskId
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual makVrf::DtPointTaskVisualizationPtr DtScriptReactiveTaskController::pointTaskVisualization	(	int	taskId,
		const DtString &	visName
	)

virtual

Returns null pointer. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual makVrf::DtLineTaskVisualizationPtr DtScriptReactiveTaskController::lineTaskVisualization	(	int	taskId,
		const DtString &	visName
	)

virtual

Returns null pointer. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual makVrf::DtAreaTaskVisualizationPtr DtScriptReactiveTaskController::areaTaskVisualization	(	int	taskId,
		const DtString &	visName
	)

virtual

Returns null pointer. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual makVrf::DtTextTaskVisualizationPtr DtScriptReactiveTaskController::textTaskVisualization	(	int	taskId,
		const DtString &	visName
	)

virtual

Returns null pointer. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual void DtScriptReactiveTaskController::deleteTaskVisualization	(	int	taskId,
		const DtString &	visName
	)

virtual

No-op. This is not relevant for reactive tasks.

Implements DtScriptTaskControllerInterface.

virtual bool DtScriptReactiveTaskController::createPSR ( )

virtual

virtual std::set<DtSimTaskMessageType> DtScriptReactiveTaskController::availableReactiveTasks ( ) const

virtual

virtual DtString DtScriptReactiveTaskController::systemFor ( const DtSimTaskMessageType & scriptId ) const

virtual

DtScriptReactiveTaskController& DtScriptReactiveTaskController::operator= ( const DtScriptReactiveTaskController & other )

protected

virtual bool DtScriptReactiveTaskController::shouldInvokeCheck ( DtRwScriptReactiveTaskEntry * entry )

protectedvirtual

virtual DtRwScriptReactiveTaskEntry* DtScriptReactiveTaskController::createDefaultEntry	(	const DtString &	scriptId,
		const DtString &	system = `""`
	)

protectedvirtual

virtual bool DtScriptReactiveTaskController::createAndInitScriptInterface	(	DtRwScriptReactiveTaskEntry *	entry,
		DtRwVariableBindings *	params,
		bool	loadState = `false`
	)

protectedvirtual

virtual void DtScriptReactiveTaskController::activateReactiveTask ( DtRwScriptReactiveTaskEntry * entry )

protectedvirtual

virtual void DtScriptReactiveTaskController::disableReactiveTask	(	DtRwScriptReactiveTaskEntry *	entry,
		bool	cancelActive
	)

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetReactiveTaskCallback ( DtSetDataRequest * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetCancel ( DtSetReactiveTaskCancel * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetDisabled ( DtSetReactiveTaskDisabled * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetEnabled ( DtSetReactiveTaskEnabled * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetPriority ( DtSetReactiveTaskPriority * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processSetTable ( DtSetReactiveTaskTable * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::setupReactiveTasks ( )

protectedvirtual

virtual void DtScriptReactiveTaskController::processScriptUpdatedCallback ( const DtScriptedTaskManagerCallbackInfo & info )

protectedvirtual

virtual bool DtScriptReactiveTaskController::doesScriptIdApply ( const DtSimTaskMessageType & scriptId ) const

protectedvirtual

virtual bool DtScriptReactiveTaskController::isForMyEntityType ( const DtScriptedTaskMetaData & metaData ) const

protectedvirtual

static void DtScriptReactiveTaskController::userQuestionOperationCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

staticprotected

virtual void DtScriptReactiveTaskController::processUserQuestionOperation ( DtSimMessage * )

protectedvirtual

virtual void DtScriptReactiveTaskController::sendOffOutstandingQuestionFor ( const DtSimTaskMessageType & scriptId )

protectedvirtual

virtual void DtScriptReactiveTaskController::addReactiveTaskEntry	(	const DtSimTaskMessageType &	scriptId,
		DtRwScriptReactiveTaskEntry *	entry,
		bool	deleteOnUpdate = `true`
	)

protectedvirtual

virtual void DtScriptReactiveTaskController::queueReactiveTaskCallback ( DtSetDataRequest * setMsg )

protectedvirtual

virtual void DtScriptReactiveTaskController::processNewSensorContact ( )

protectedvirtual

Callback for new sensor contacts. Whenever there is a new sensor contact, or a sensor contact has new information, each script that has called vrf:setRespondToNewSensorContacts(true) will have its tick time set to current sim time, and therefore tick again as soon as possible.

Member Data Documentation

DtScriptReactiveTaskControllerPSR* DtScriptReactiveTaskController::myProcessState

protected

DtForceType DtScriptReactiveTaskController::myCurrentForceType

protected

std::map<DtSimTaskMessageType,DtString> DtScriptReactiveTaskController::myAdditionalReactiveTasks

protected

std::map<DtSimTaskMessageType,bool> DtScriptReactiveTaskController::mySavedCheckpointMode

protected

std::map<DtSimTaskMessageType,double> DtScriptReactiveTaskController::mySavedTickPeriodSettings

protected

std::map<DtSimTaskMessageType,bool> DtScriptReactiveTaskController::mySavedTickWhilePausedSettings

protected

std::vector<DtSetDataRequest*> DtScriptReactiveTaskController::myQueuedReactiveTaskCallbacks

protected

std::list<TaskAndScriptIds> DtScriptReactiveTaskController::myRespondToNewSensorContactList

protected

List of task and script IDs for scripts that will respond to new sensor contacts.

bool DtScriptReactiveTaskController::mySetupReactiveTasks = false

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjcore/scriptReactiveTaskController.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation