DtAffectEngineeringObjectController Class Reference

This is the base class for controllers which affect the creation and destruction of engineering objects.

Inheritance diagram for DtAffectEngineeringObjectController:

Public Member Functions
	DtAffectEngineeringObjectController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=NULL, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtAffectEngineeringObjectController ()
virtual bool	init ()
virtual bool	createPSR ()
virtual const char *	type () const =0
virtual void	tick ()
virtual void	registerTaskMsgCallbacks ()
virtual void	processTaskCompleteReport (DtSimMessage *msg)
virtual bool	tickWhileDestroyed () const
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtSingleTaskControllerComponent ()
virtual void	postTick () override
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState) override
virtual void	taskNotify (const DtSimTask &task) override
virtual void	taskComplete (bool success=true)
virtual void	clearTask () override
virtual void	suspendTask ()
virtual int	sendSubtask (DtSimTask &task)
virtual void	clearSubtask (int subtaskId)
virtual void	addPendingSubtaskId (int subtaskId)
virtual bool	findPendingSubtaskId (int subtaskId)
virtual bool	isSubtasked () const
virtual void	removePendingSubtaskId (int subtaskId)
virtual void	removeAllPendingSubtaskIds ()
virtual std::vector< int >	currentPendingSubstaskIds () const
virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId)
virtual void	clearCurrentTaskMessage ()
virtual DtTaskMessage *	currentTaskMessage () const
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
virtual void	giveUpTask ()
virtual bool	taskActive (int taskId) const override
virtual bool	clearTopLevelTasks () override
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override
virtual void	clearTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override
virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override
virtual void	disable () override
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtTaskControllerComponent ()
virtual AcceptLevel	acceptTask (const DtTaskMessage &task)
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio) override
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
virtual void	enable () override
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
virtual bool	taskVisualizationsActive () const override
virtual void	setTasked (bool tasked)
virtual bool	tasked () const
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	enableTaskTypes ()
virtual void	enableScritedTask (const DtString &scriptId)
virtual void	disableTaskTypes ()
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	preFirstTickInit ()
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
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	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
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)
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)

Static Public Member Functions
static void	taskCompleteReportCallback (DtSimMessage *msg, void *usr)
Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage *msg, void *usr, DtSimTaskStatePtr taskState)
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 Member Functions
virtual void	processIdleState ()=0
virtual void	processSettingUpState ()=0
virtual void	processAffectingState ()=0
virtual void	processAffectingPausedState ()=0
virtual void	processMovingIntoRangeState ()=0
virtual void	moveInRange (const DtSimObject *obj, double range, double objectRadius)
virtual void	moveInRange (const DtLocalVertexList &vertices, double range, double objectRadius)
virtual void	moveInRange (const DtVector &location, double range, double objectRadius)
virtual bool	isInRange (const DtSimObject *obj, double range, double objectRadius) const
virtual bool	isInRange (const DtLocalVertexList &vertices, double range, double objectRadius) const
virtual bool	isInRange (const DtVector &location, double range, double objectRadius) const
virtual bool	isArealEngineeringObject (const DtObjectType &objectType) const
virtual bool	isLinearEngineeringObject (const DtObjectType &objectType) const
virtual bool	isPointEngineeringObject (const DtObjectType &objectType) const
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
virtual void	cleanupInactiveSubtaskStatus ()
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)
virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const
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	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 Attributes
DtAffectEngineeringObjectPSR *	myProcessState
Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap
std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList
bool	myTaskIsRunning
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

Private Member Functions
	DtAffectEngineeringObjectController (const DtAffectEngineeringObjectController &orig)
DtAffectEngineeringObjectController &	operator= (const DtAffectEngineeringObjectController &orig)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }
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
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
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

Constructor & Destructor Documentation

DtAffectEngineeringObjectController::DtAffectEngineeringObjectController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = NULL,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

virtual DtAffectEngineeringObjectController::~DtAffectEngineeringObjectController ( )

virtual

destructor

DtAffectEngineeringObjectController::DtAffectEngineeringObjectController ( const DtAffectEngineeringObjectController &  orig )

private

Not implemented.

Member Function Documentation

virtual bool DtAffectEngineeringObjectController::init ( )

virtual

Initializes the controller.

Reimplemented from DtControllerComponent.

Reimplemented in DtCreateEngineeringObjectController, DtDestroyEngineeringObjectController, DtBreachObstacleController, and DtFascamController.

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

private

Not implemented.

virtual bool DtAffectEngineeringObjectController::createPSR ( )

virtual

Creates the PSR to be used by this controller.

virtual const char* DtAffectEngineeringObjectController::type ( ) const

pure virtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Implements DtTaskControllerComponent.

Implemented in DtCreateEngineeringObjectController, DtDestroyEngineeringObjectController, DtBreachObstacleController, and DtFascamController.

virtual void DtAffectEngineeringObjectController::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 void DtAffectEngineeringObjectController::registerTaskMsgCallbacks ( )

virtual

Registers interest in create engineering object tasks by calling addTaskProcessorCallback.

Reimplemented from DtTaskControllerComponent.

Reimplemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

static void DtAffectEngineeringObjectController::taskCompleteReportCallback ( DtSimMessage *  msg, void *  usr  )

static

virtual void DtAffectEngineeringObjectController::processTaskCompleteReport ( DtSimMessage *  msg )

virtual

virtual bool DtAffectEngineeringObjectController::tickWhileDestroyed ( ) const

virtual

Returns

true. Necessary in order to stop affecting engineering objects when entity is destroyed.

Reimplemented from DtSimComponent.

virtual void DtAffectEngineeringObjectController::processIdleState ( )

protectedpure virtual

Determines the next step to take during tick when in the idle state.

Implemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

virtual void DtAffectEngineeringObjectController::processSettingUpState ( )

protectedpure virtual

Determines the next step to take during tick when in the setting up state (preparing to affect an object).

Implemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

virtual void DtAffectEngineeringObjectController::processAffectingState ( )

protectedpure virtual

Determines the next step to take during tick when in the affecting state (while actively affecting an existing object).

Implemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

virtual void DtAffectEngineeringObjectController::processAffectingPausedState ( )

protectedpure virtual

Determines the next step to take during tick when in the affecting paused state (something has caused us to stop in the middle of affecting the object).

Implemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

virtual void DtAffectEngineeringObjectController::processMovingIntoRangeState ( )

protectedpure virtual

Determines the next step to take during tick when in the moving into range state.

Implemented in DtCreateEngineeringObjectController, and DtDestroyEngineeringObjectController.

virtual void DtAffectEngineeringObjectController::moveInRange ( const DtSimObject *  obj, double  range, double  objectRadius  )

protectedvirtual

Moves the entity within the specified range of the object.

virtual void DtAffectEngineeringObjectController::moveInRange ( const DtLocalVertexList &  vertices, double  range, double  objectRadius  )

protectedvirtual

Moves the entity within the specified range of the list of vertices that define where an object is (or will be) located.

Reimplemented in DtFascamController.

virtual void DtAffectEngineeringObjectController::moveInRange ( const DtVector &  location, double  range, double  objectRadius  )

protectedvirtual

Moves the entity within the specified range of the location where an object is (or will be) located.

virtual bool DtAffectEngineeringObjectController::isInRange ( const DtSimObject *  obj, double  range, double  objectRadius  ) const

protectedvirtual

Returns true if the specified object is in the specified range.

virtual bool DtAffectEngineeringObjectController::isInRange ( const DtLocalVertexList &  vertices, double  range, double  objectRadius  ) const

protectedvirtual

Returns true if the specified vertices are in the specified range.

virtual bool DtAffectEngineeringObjectController::isInRange ( const DtVector &  location, double  range, double  objectRadius  ) const

protectedvirtual

Returns true if the specified location is in the specified range.

virtual bool DtAffectEngineeringObjectController::isArealEngineeringObject ( const DtObjectType &  objectType ) const

protectedvirtual

Returns true if the object type is for an areal engineering object.

virtual bool DtAffectEngineeringObjectController::isLinearEngineeringObject ( const DtObjectType &  objectType ) const

protectedvirtual

Returns true if the object type is for a linear engineering object.

virtual bool DtAffectEngineeringObjectController::isPointEngineeringObject ( const DtObjectType &  objectType ) const

protectedvirtual

Returns true if the object type is for a point engineering object.

Member Data Documentation

DtAffectEngineeringObjectPSR* DtAffectEngineeringObjectController::myProcessState

protected

Pointer to a process state repository used to store state data associated with this component.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmodel/affectEngineeringObjectController.h