DtDetonationController Class Reference

DtDetonationController is used to detonate a bomb like munition. More...

Inheritance diagram for DtDetonationController:

Public Member Functions
	DtDetonationController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtDetonationController ()
	destructor
virtual bool	postAddComponentsInit ()
	Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it).
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Initialize the component.
virtual void	preFirstTickInit ()
	Before the first call to tick will restore the checkpointed values of myCurrentMunition, myCurrentFuze, myDetonationTime, myAmArmed from the munition loader of the DtVrfBalGunPSR.
virtual void	tick ()
	Calculate new control values.
virtual bool	createTriggerPort ()
	These are called in init to create the ports used to communicate with the actuator.
virtual DtBooleanOutputPort *	triggerPort () const
virtual bool	createArmedPort ()
	These are called in init to create the ports used to communicate with the actuator.
virtual DtBooleanOutputPort *	armedPort () const
virtual bool	createQuantityOutputPort ()
virtual DtIntegerOutputPort *	quantityOutputPort () const
virtual void	setDetonationTime (DtTime detTime)
virtual DtTime	detonationTime () const
virtual void	detonate ()
	Sets myTriggerPort to true and myLoaded to false.
virtual void	beginSensing ()
	If the fuse is a proximity fuse we want to activate the objects to detect port to let the object's sensor know what to sense.
virtual bool	tripped (const DtRwSensorContactInfo *potentialVictim)
	Checks to see if the sensor contact has come with in range of the detonator's proximity trigger.
virtual bool	setMunitionToDetonate (DtSimMunition &munition)
	Finds the munition to use with this detonator from the entity's ammo resources.
virtual void	processSetDetonation (DtSimMessage *msg)
virtual void	processSetArmed (DtSimMessage *msg)
virtual void	processSetRestore (DtSimMessage *msg)
virtual DtDetonatorFuze	fuseStringToEnum (const DtString &fuseString)
	Given a string return the detonatorFuze enumeration that goes with it.
virtual DtString	fuseStringToEnum (DtDetonatorFuze fuse)
	Given a detonatorFuze enumeration return the string that goes with it.
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtSingleTaskControllerComponent ()
	destructor
virtual void	postTick ()
	Override to check if we're tasked and we want to give up (only performs the check if we're in play mode (dT() > 0)).
virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)
	Called by the task manager when this controller should start executing the specified task.
virtual void	taskNotify (const DtSimTask &task)
	This is called to let us know when some other component receives a task In the case of this component, we don't care what the task actually is.
virtual void	taskComplete (bool success=true)
	If we are currently tasked, this will cause us to notify the entity that we're done and delete the task.
virtual void	clearTask ()
	If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false, and calls clearCurrentTaskMesage() to clear out the current task message.
virtual void	suspendTask ()
	This method is called when the currently running task is being suspended.
virtual int	sendSubtask (DtSimTask &task)
	Sends subtask to ourself.
virtual void	clearSubtask (int subtaskId)
	Clears subtask with the given subtaskId (subtaskId is returned sendSubtask()).
virtual void	addPendingSubtaskId (int subtaskId)
	Adds given subtask Id to list of pending subtasks.
virtual bool	findPendingSubtaskId (int subtaskId)
	Checks to see if given subtaskId exists in our list of pending subtasks.
virtual bool	isSubtasked () const
	Returns true if this controller is currently subtasked.
virtual void	removePendingSubtaskId (int subtaskId)
	Removes pending subtask from list of subtasks for this component.
virtual void	removeAllPendingSubtaskIds ()
	Clear all pending subtasks from our list of subtasks.
virtual std::vector< int >	currentPendingSubstaskIds () const
	Returns the list of all currently pending subtask ids for this controller.
virtual void	clearCurrentTaskMessage ()
	Returns the current subtask with the specified id.
virtual DtTaskMessage *	currentTaskMessage () const
	Get a pointer to the message that was used to task this entity.
virtual DtSimTaskStatePtr	currentTaskState () const
virtual bool	decideToGiveUpTask () const
	This function is used to determine if the controller should give up trying to execute the current task.
virtual void	giveUpTask ()
	Called when controller is tasked and decideToGiveUp() returns true.
virtual bool	taskActive (int taskId) const
virtual bool	clearTopLevelTasks ()
	If this controller has any top level tasks (not subtasks), they are cleared.
virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)
	Clears any top level tasks on this controller that conflict with the conflict task type.
virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)
	Clears any tasks of the specified type running in this controller.
virtual void	clearTaskById (int taskId)
	Clears any task of the specified ID running in this controller.
virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)
virtual std::list < DtTaskMessage * >	currentTaskMessages () const
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtTaskControllerComponent ()
	destructor
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio)
	Calls registerTaskMsgCallbacks.
virtual void	registerTaskMsgCallbacks ()
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Adds a new function for processing the specified task type.
virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Deprecated form of addTaskProcessorCallback.
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)
	Undoes anything done by addTaskProcessorCallback().
virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)
	Deprecated form of removeTaskProcessorCallback.
virtual void	enable ()
	Overridden to call registerTaskMsgCallbacks().
virtual void	disable ()
	Overridden to 1) remove any task message callbacks registered by this controller 2) call clear task.
virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)
	Sends the task canceled report for the specified message.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	setTasked (bool tasked)
	The current tasked state of this controller.
virtual bool	tasked () const
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	isEnabled ()
virtual void	setIsEnabled (bool yesNo)
virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const
virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static void	setDetonationCallback (DtSimMessage *msg, void *usrData)
	Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of detonation tasks.
static void	setArmedCallback (DtSimMessage *msg, void *usr)
	Calls processSetArmed().
static void	setRestoreCallback (DtSimMessage *msg, void *usrData)
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions
virtual bool	createPorts ()
	Called by init to create the output ports.
virtual bool	createTypesToDetectPort ()
virtual void	lookupAndCacheProcessSR ()
	This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState.
virtual void	registerRadioMessageCallbacks ()
	Registers for setArmedDataRequest and setDetonate messages from the local entity's radio.
	DtDetonationController ()
	Not implemented.
	DtDetonationController (const DtDetonationController &orig)
	Not implemented.
const DtDetonationController &	operator= (const DtDetonationController &orig)
	Not implemented.
Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()
	Iterates over collection of all pending subtasks for this controller, and calls clearSubtask() for each subtask type.
virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)
	Clear all subtasks of a given type.
virtual void	cleanupInactiveSubtaskStatus ()
	Clears out subtask status entries that are either completed or canceled which were started by this controller.
Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)
	Suspends all running subtasks of taskId, and puts the suspend info for each of them as subtasks into the provided suspendInfo.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtSimMunition	myCurrentMunition
	The muntition and fuse to be used in the detonation.
DtDetonatorFuze	myCurrentFuze
DtTime	myDetonationTime
bool	myAmArmed
double	myDetonationProximity
DtWarheadDetonationActuatorPSR *	myProcessState
	Pointer to a process state repository used to store state data associated with this component.
const DtDetonationControllerDescriptor *	myDetonationDescriptor
Ports and Port Groups
DtSensorContactListMultiInputPort *	myDetectedObjectsInputPort
	Input Port Name: detected-objects Input Port Description: List of contacts that fall within our range.
DtObjectTypesListOutputPort *	myTypesToDetectOutputPort
	Output Port Name: object-types-to-spot-report Output Port Description: List of types of object the spot report controller should generate spot reports on.
DtBooleanOutputPort *	myTriggerPort
	Output Port Name: trigger Output Port Description: Sends a new True value when trigger is pulled.
DtBooleanOutputPort *	myArmedPort
	Output Port Name: armed Output Port Description: Set to true when the object is armed so warhead can detonate when appropriate.
DtIntegerOutputPort *	myQuantityOutputPort
	Output Port Name: quantity Output Port Description: Sends the number of rounds to be fired with a single trigger pull.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair
	This map stores callbacks that have been registered to processes various tasks.
typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtDetonationController is used to detonate a bomb like munition.

End User Description: The munition doesn't require any kind of loading. This controller checks if the munition is armed and if the fuse has been triggered. If these 2 conditions are met, it sets the trigger output port to true. It registers for detonationTasks which will be used to detonate the munition Uses Descriptor Type: DtDetonationControllerDescriptor

Constructor & Destructor Documentation

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

(const DtString&,DtVrfObject*,DtSimManager*,

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtDetonationController::~DtDetonationController ( )

virtual

destructor

DtDetonationController::DtDetonationController ( )

protected

Not implemented.

DtDetonationController::DtDetonationController ( const DtDetonationController &  orig )

protected

Not implemented.

Member Function Documentation

virtual bool DtDetonationController::postAddComponentsInit ( )

virtual

Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it).

Also calls initProcessSR().

Reimplemented from DtSimComponent.

virtual const char* DtDetonationController::type ( ) const

virtual

Returns a string identifies the class type of component.

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

Returns

DtDetonationControllerType

Implements DtTaskControllerComponent.

virtual bool DtDetonationController::init ( )

virtual

Initialize the component.

Calls registerRadioMessageCallbacks()

Reimplemented from DtControllerComponent.

virtual void DtDetonationController::preFirstTickInit ( )

virtual

Before the first call to tick will restore the checkpointed values of myCurrentMunition, myCurrentFuze, myDetonationTime, myAmArmed from the munition loader of the DtVrfBalGunPSR.

If the fuze is a proximity fuse, beginSensing() is called and myDetonationProximity is set from the PSR. Otherwise, the fuze, proximity and armed state are all taken from myDetonationDescriptor and if the armed state is true, setMunitionToDetonate is called with the current munition.

Reimplemented from DtSimComponent.

virtual void DtDetonationController::tick ( )

virtual

Calculate new control values.

Reimplemented from DtSimComponent.

virtual bool DtDetonationController::createTriggerPort ( )

virtual

These are called in init to create the ports used to communicate with the actuator.

virtual DtBooleanOutputPort* DtDetonationController::triggerPort ( ) const

virtual

virtual bool DtDetonationController::createArmedPort ( )

virtual

These are called in init to create the ports used to communicate with the actuator.

virtual DtBooleanOutputPort* DtDetonationController::armedPort ( ) const

virtual

virtual bool DtDetonationController::createQuantityOutputPort ( )

virtual

virtual DtIntegerOutputPort* DtDetonationController::quantityOutputPort ( ) const

virtual

virtual void DtDetonationController::setDetonationTime ( DtTime  detTime )

virtual

virtual DtTime DtDetonationController::detonationTime ( ) const

virtual

virtual void DtDetonationController::detonate ( )

virtual

Sets myTriggerPort to true and myLoaded to false.

It also looks up the resource named by myCurrentMunitionName and if found, calls DtIntegerResource::deplete().

virtual void DtDetonationController::beginSensing ( )

virtual

If the fuse is a proximity fuse we want to activate the objects to detect port to let the object's sensor know what to sense.

virtual bool DtDetonationController::tripped ( const DtRwSensorContactInfo *  potentialVictim )

virtual

Checks to see if the sensor contact has come with in range of the detonator's proximity trigger.

virtual bool DtDetonationController::setMunitionToDetonate ( DtSimMunition &  munition )

virtual

Finds the munition to use with this detonator from the entity's ammo resources.

static void DtDetonationController::setDetonationCallback ( DtSimMessage *  msg, void *  usrData  )

static

Instances of this component will register this callback with their own 'this' pointer as user data with the msg executive requesting notification of detonation tasks.

virtual void DtDetonationController::processSetDetonation ( DtSimMessage *  msg )

virtual

static void DtDetonationController::setArmedCallback ( DtSimMessage *  msg, void *  usr  )

static

Calls processSetArmed().

virtual void DtDetonationController::processSetArmed ( DtSimMessage *  msg )

virtual

static void DtDetonationController::setRestoreCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtDetonationController::processSetRestore ( DtSimMessage *  msg )

virtual

virtual DtDetonatorFuze DtDetonationController::fuseStringToEnum ( const DtString &  fuseString )

virtual

Given a string return the detonatorFuze enumeration that goes with it.

virtual DtString DtDetonationController::fuseStringToEnum ( DtDetonatorFuze  fuse )

virtual

Given a detonatorFuze enumeration return the string that goes with it.

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

static

(const DtString&,DtVrfObject*,DtSimManager*,

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

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

virtual bool DtDetonationController::createPorts ( )

protectedvirtual

Called by init to create the output ports.

Reimplemented from DtSimComponent.

virtual bool DtDetonationController::createTypesToDetectPort ( )

protectedvirtual

virtual void DtDetonationController::lookupAndCacheProcessSR ( )

protectedvirtual

This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState.

The name (if it exists) is given in the component descriptor (DtComponentDescriptor::processStateRepositoryName). If the name does not exist, it uses the appropriate default name defined in procSRTypes.h. Another component is responsible for creating and destroying the process state repository.

virtual void DtDetonationController::registerRadioMessageCallbacks ( )

protectedvirtual

Registers for setArmedDataRequest and setDetonate messages from the local entity's radio.

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

protected

Not implemented.

Member Data Documentation

DtSensorContactListMultiInputPort* DtDetonationController::myDetectedObjectsInputPort

protected

Input Port Name: detected-objects
Input Port Description: List of contacts that fall within our range.

If this list is not empty then we try to detonate
Input Port Range:
Input Port Default Value:
Input Group Parent:

DtObjectTypesListOutputPort* DtDetonationController::myTypesToDetectOutputPort

protected

Output Port Name: object-types-to-spot-report
Output Port Description: List of types of object the spot report controller should generate spot reports on.

Connects to the sensors.
Output Port Range:
Output Port Default Value:
Output Group Parent:

DtBooleanOutputPort* DtDetonationController::myTriggerPort

protected

Output Port Name: trigger
Output Port Description: Sends a new True value when trigger is pulled.

Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control

DtBooleanOutputPort* DtDetonationController::myArmedPort

protected

Output Port Name: armed
Output Port Description: Set to true when the object is armed so warhead can detonate when appropriate.

Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control

DtIntegerOutputPort* DtDetonationController::myQuantityOutputPort

protected

Output Port Name: quantity
Output Port Description: Sends the number of rounds to be fired with a single trigger pull.

Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control

DtSimMunition DtDetonationController::myCurrentMunition

protected

The muntition and fuse to be used in the detonation.

DtDetonatorFuze DtDetonationController::myCurrentFuze

protected

DtTime DtDetonationController::myDetonationTime

protected

bool DtDetonationController::myAmArmed

protected

double DtDetonationController::myDetonationProximity

protected

DtWarheadDetonationActuatorPSR* DtDetonationController::myProcessState

protected

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

This process state repository is shared with other components. Another component is responsible for creating and destroying the process state repository. This state is saved and restored as part of a scenario (or checkpoint).

const DtDetonationControllerDescriptor* DtDetonationController::myDetonationDescriptor

protected

---

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

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