DtMunitionLaunchController Class Reference

DtMunitionLaunchController models launch of a munition.

End User Description: Creates a new munition of the type specified in its parameters. Decrements the resource associated with the munition. Generates a plan for the munition, and passes it to the munition. Passes warhead detonation information to the munition's warhead actuator. Reports task complete.

Munitions are not tracked by the launcher once they are launched.

This controller does not register for task messages. It is expected that derived controllers will register for messages that launch specific munitions. (Or, the setAttribute("launch-munition") will be used to launch a munition.) Controllers derived from this one can register for launch tasks for specific munitions; e.g. cruise missile launcher.

Uses Descriptor Type: DtCruiseMissileLaunchControllerDescriptor

DtMunitionLaunchController model description

Inheritance diagram for DtMunitionLaunchController:

Public Member Functions
	DtMunitionLaunchController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *compDesc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtMunitionLaunchController () override
virtual const char *	type () const override
virtual bool	init () override
virtual void	setComponentDescriptor (DtComponentDescriptor *compDesc) override
virtual bool	createPSR ()
virtual void	tick () override
virtual DtCruiseMissileLaunchControllerPSR *	getPsr ()
virtual DtCruiseMissileLaunchControllerDescriptor *	getDescriptor ()
Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtSingleTaskControllerComponent () override
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	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 override
virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override
virtual void	disable () override
virtual void	updateImgui () override
virtual void	initializeTaskInformationStateProperty (const DtSimTaskMessageType &taskType)
virtual void	updateCurrentTaskInformationStatusProperty (const DtString &status)
virtual DtString	taskInformationStatusPropertyValue (const DtSimTaskMessageType &taskType) const
virtual DtString	currentTaskInformationStatusPropertyValue () const
virtual DtRwPropertiesStructure *	taskInformationProperty (const DtSimTaskMessageType &taskType)
virtual DtRwPropertiesStructure *	currentTaskInformationProperty ()
Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *compDesc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtTaskControllerComponent () override
virtual AcceptLevel	acceptTask (const DtTaskMessage &task)
virtual bool	showCurrentTaskInGui () const
virtual void	setRadio (DtSimRadio *radio) override
virtual void	registerTaskMsgCallbacks ()
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 () override
virtual bool	postAddComponentsInit () override
virtual DtSimRadio *	radio ()
virtual void	enableTaskTypes ()
virtual void	enableScriptedTask (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 () override
virtual void	setParentSystem (DtComponentSystem *system)
DtComponentSystem *	parentSystem () const
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) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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 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	taskVisualizationsEnabled () const
makVrf::DtTaskVisualizationMap &	taskVisualizations ()
virtual bool	debugActive () const
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)

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
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 DtReaderWriter *	processProvideMunitionName ()
virtual bool	processLaunchMunition (DtReaderWriter *dummy)
virtual bool	processCancelLaunch ()
virtual bool	munitionResourceAvailable () const
virtual void	consumeMunitionResource ()
virtual DtCreateObjectHandle	createMunitionObject (const DtString &eventId, DtVector &launcherGeocPos, DtVector &missileNetInitialGeocVelocity)
virtual DtSetWarheadInfo	createWarheadInfo (DtVrfLocalObjectCreateInformation &info, const DtString &eventId) const
virtual DtIfPlan	createMunitionPlan (const DtUUID &munition)
virtual DtUUID	getTargetFromTaskMessage (const DtTaskMessage *tm) const
virtual void	createAndSendFireInteraction (const DtCreateObjectHandle &munition, const DtString &eventId, const DtVector &launcherGeocPos, const DtVector &missileNetInitialGeocVelocity)
virtual void	addRangeItems ()
virtual void	clearTask () override
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 () override
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
DtCruiseMissileLaunchControllerDescriptor *	myDescriptor
DtCruiseMissileLaunchControllerPSR *	myProcessState
DtRwUUID	myTargetName
bool	myRangeItemsAdded
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
DtMovementLocalObjectFacade	myMovementLocalObjectFacade
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
bool	myLocalDebug
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
	DtMunitionLaunchController ()
	DtMunitionLaunchController (const DtMunitionLaunchController &orig)
DtMunitionLaunchController &	operator= (const DtMunitionLaunchController &orig)
virtual void	registerAttributeFunctions () override
static DtReaderWriter *	provideMunitionName (void *controller)
static bool	launchMunition (void *controller, DtReaderWriter *dummy)
static bool	cancelLaunch (void *controller, DtReaderWriter *dummy)

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 )()
Public Attributes inherited from DtSingleTaskControllerComponent
const DtString	TaskStatusRunning = "TaskRunning"
const DtString	TaskStatusNotActive = "TaskNotActive"
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

DtMunitionLaunchController::DtMunitionLaunchController ( )

private

Not implemented.

DtMunitionLaunchController::DtMunitionLaunchController ( const DtMunitionLaunchController &  orig )

private

Not implemented.

DtMunitionLaunchController::DtMunitionLaunchController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	compDesc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtMunitionLaunchController::~DtMunitionLaunchController ( )

overridevirtual

Destructor.

Member Function Documentation

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

private

Not implemented.

virtual const char* DtMunitionLaunchController::type ( ) const

overridevirtual

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

DtMunitionLaunchControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtCruiseMissileLaunchController, and DtLoiterMunitionLaunchController.

virtual bool DtMunitionLaunchController::init ( )

overridevirtual

Initialize the component. Calls createPSR() and registerRadioMessageCallbacks()

Reimplemented from DtControllerComponent.

Reimplemented in DtCruiseMissileLaunchController, and DtLoiterMunitionLaunchController.

virtual void DtMunitionLaunchController::setComponentDescriptor ( DtComponentDescriptor *  compDesc )

overridevirtual

Overridden to get the specialized DtMunitionLaunchControllerDescriptor.

Reimplemented from DtSimComponent.

Reimplemented in DtLoiterMunitionLaunchController, and DtCruiseMissileLaunchController.

virtual bool DtMunitionLaunchController::createPSR ( )

virtual

Creates myProcessState data member, and adds it to our process state repository manager. Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in psrTypes.h.

virtual void DtMunitionLaunchController::tick ( )

overridevirtual

Tick Function. When the component has a launch munition task and at least the minimum-time-between-launches has passed, create and task the new munition. Call createMunitionPlan and if the result isn't empty, assign it to the munition.

Reimplemented from DtSimComponent.

Reimplemented in DtLoiterMunitionLaunchController, and DtCruiseMissileLaunchController.

static DtSimComponent* DtMunitionLaunchController::creator ( const DtString &  name, DtLocalObject *  owner, DtSimulationServices *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject 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).

Returns

New instance of this class.

virtual DtCruiseMissileLaunchControllerPSR* DtMunitionLaunchController::getPsr ( )

virtual

Access functions for the PSR and Descriptor so that attribute query functions can provide data from them.

virtual DtCruiseMissileLaunchControllerDescriptor* DtMunitionLaunchController::getDescriptor ( )

virtual

Access functions for the PSR and Descriptor so that attribute query functions can provide data from them.

virtual void DtMunitionLaunchController::registerAttributeFunctions ( )

overridevirtual

Attribute functions:Overrides the simComponent version to register the functions below.

Reimplemented from DtSimComponent.

static DtReaderWriter* DtMunitionLaunchController::provideMunitionName ( void *  controller )

static

Function to be registered as a provider with the parent component system for the launched-munition-name attribute. Calls processProvideMunitionName.

static bool DtMunitionLaunchController::launchMunition ( void *  controller, DtReaderWriter *  dummy  )

static

Function to be registered as a setter with the parent component system for the launch-munition attribute. Calls processLaunchMunition.

static bool DtMunitionLaunchController::cancelLaunch ( void *  controller, DtReaderWriter *  dummy  )

static

Function to be registered as a setter with the parent component system for the cancel-launch attribute. Calls processCancelLaunch.

virtual DtReaderWriter* DtMunitionLaunchController::processProvideMunitionName ( )

protectedvirtual

Provides the name (DtRwString) of the munition that was last launched.

virtual bool DtMunitionLaunchController::processLaunchMunition ( DtReaderWriter *  dummy )

protectedvirtual

Does not actually set anything, but causes a munition to be launched. Resets the name of the last-launched munition to null until the munition is actually launched. Returns a boolean indicating error.

virtual bool DtMunitionLaunchController::processCancelLaunch ( )

protectedvirtual

Clears out variables set by a previous launch call to stop the launching of the missile (if it has not already been launched) Returns a boolean indicating error.

virtual bool DtMunitionLaunchController::munitionResourceAvailable ( ) const

protectedvirtual

Returns true if there is at least one munition resource remaining of the type specified in the parameter entry.

virtual void DtMunitionLaunchController::consumeMunitionResource ( )

protectedvirtual

Decrements the munition resource by one.

virtual DtCreateObjectHandle DtMunitionLaunchController::createMunitionObject ( const DtString &  eventId, DtVector &  launcherGeocPos, DtVector &  missileNetInitialGeocVelocity  )

protectedvirtual

Creates a new vrf object for the munition using the type and offset parameters specified in the descriptor. Returns a pointer to the newly created object.

virtual DtSetWarheadInfo DtMunitionLaunchController::createWarheadInfo ( DtVrfLocalObjectCreateInformation &  info, const DtString &  eventId  ) const

protectedvirtual

Sets parameters of the warhead in a SetDataRequestMessage. In this base munition launcher, the only information that is set is attacker, event ID, the warhead type and fuze type. The latter two come from the controller descriptor. Derived launchers can override this function to set different parameters. Also, other controllers and scripts can send additional set-warhead-info messages to the munition to change the warhead info.

Reimplemented in DtLoiterMunitionLaunchController, and DtCruiseMissileLaunchController.

virtual DtIfPlan DtMunitionLaunchController::createMunitionPlan ( const DtUUID &  munition )

protectedvirtual

Creates a new plan for the munition using the task saved in this controller. In this base munition launcher, the plan is empty.

Reimplemented in DtLoiterMunitionLaunchController, and DtCruiseMissileLaunchController.

virtual DtUUID DtMunitionLaunchController::getTargetFromTaskMessage ( const DtTaskMessage *  tm ) const

protectedvirtual

Gets the target name from the task message. Used in createAndSend FireInteraction. Can be different for classes that override this one, if their task messages are different.

Reimplemented in DtLoiterMunitionLaunchController, and DtCruiseMissileLaunchController.

virtual void DtMunitionLaunchController::createAndSendFireInteraction ( const DtCreateObjectHandle &  munition, const DtString &  eventId, const DtVector &  launcherGeocPos, const DtVector &  missileNetInitialGeocVelocity  )

protectedvirtual

Creates the fire interaction for launching of the specified munition. Target information is taken from currentTaskMessage().

virtual void DtMunitionLaunchController::addRangeItems ( )

protectedvirtual

Adds all items that have a range to the object state repository.

virtual void DtMunitionLaunchController::clearTask ( )

overrideprotectedvirtual

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

Reimplemented from DtSingleTaskControllerComponent.

Member Data Documentation

DtCruiseMissileLaunchControllerDescriptor* DtMunitionLaunchController::myDescriptor

protected

Pointer to my descriptor.

DtCruiseMissileLaunchControllerPSR* DtMunitionLaunchController::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

DtRwUUID DtMunitionLaunchController::myTargetName

protected

Temporary.

bool DtMunitionLaunchController::myRangeItemsAdded

protected

DtPlatformLocalObjectFacade DtMunitionLaunchController::myPlatformLocalObjectFacade

protected

Member to allow for access to platform specific data.

DtMovementLocalObjectFacade DtMunitionLaunchController::myMovementLocalObjectFacade

protected

---

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

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