DtWeaponController is a controller that extends the DtBaseWeaponController with the ability to accept a list of targets as input.

End User Description: The weapon controller accepts input from a target sensor, and provides ammunition type, load status, and trigger inputs to a weapon actuator. It also provides azimuth and elevation inputs to corresponding azimuth and elevation mount actuators (moveable components upon which a weapon may be mounted).The weapon controller designates its target as the first target that appears in the entity's sector of responsibility. Based on the target type, it loads the appropriate munition type. If a change in target occurs, requiring a change in munition type, or fuze type, or both (that is, the new target detected is of a different type than the original target), the weapon unloads the old munition, and then fuse type, or both (that is, the new target loads the new type of munition. If no target is available, and the preload-weapon parameter is set, then the first munition type specified in the munition table is loaded. The target is acquired when the azimuth and elevation of the weapon align with the azimuth and elevation to the target, within the ranges specified by the munition-maneuver-margin parameter. The controller reorients the weapon in azimuth and elevation as needed. Once a target has been acquired, the weapon is loaded, and the entity has permission to fire (given by the entity's rules of engagement, for example, �fire-at-will�), the weapon controller fires. It sets the trigger port to true, and depletes the resource associated with the munition type.

Uses Descriptor Type: DtWeaponControllerDescriptor

Inheritance diagram for DtWeaponController:

[legend]

Public Member Functions
	DtWeaponController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

virtual	~DtWeaponController () override

virtual const char *	type () const override

virtual bool	createMountingController () override

virtual bool	init () override

virtual void	preFirstTickInit () override

virtual void	tick () override

virtual void	fire () override

virtual const DtSimObject *	chooseTarget ()

virtual DtSimObjectReference	chooseTarget (const DtEntityTargetList &targetList) const

virtual const DtVector	chooseLocationTarget ()

virtual void	tickMunitionLoader (const DtSimObject *target)

virtual bool	acquireTarget (const DtSimObject *target)

virtual bool	acquireLocationTarget (const DtVector locTarget)

virtual void	maneuverRequiredToAcquireTarget (DtReal requiredHeading, DtReal requiredPitch, DtReal requiredMaxSpeed)

bool	outOfAmmo () const

virtual bool	loadedAmmoValidForTarget (const DtSimObject *target) const

virtual bool	chooseAmmo (const DtEntityType &entityType, DtSimMunition &munitionOut, DtDetonatorFuze &fuzeOut, bool setCurrentMunition=true)

virtual bool	acceptSensorTargettingInput ()

virtual bool	inSector (const DtSimObject *entity) const

virtual void	findBodyHeadingElevationToTarget (const DtSimObject *entity, DtReal &bodyHeadingOut, DtReal &bodyElevationOut) const

virtual DtSimObjectReference	easier (DtSimObjectReference entity1, DtSimObjectReference entity2) const

virtual void	enable () override

virtual void	disable () override

Public Member Functions inherited from DtBaseWeaponController
	DtBaseWeaponController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

virtual	~DtBaseWeaponController () override

virtual bool	postAddComponentsInit () override

virtual bool	waitingForFire ()

virtual void	setWaitingForFire (bool waiting)

virtual bool	createWeaponOutputPortGroup ()

virtual DtOutputPortGroup *	weaponOutputPortGroup ()

virtual bool	createWeaponInputPortGroup ()

virtual DtInputPortGroup *	weaponInputPortGroup ()

virtual bool	createTriggerPort ()

virtual DtBooleanOutputPort *	triggerPort () const

virtual bool	createLoadAmmunitionPort ()

virtual DtAmmunitionOutputPort *	loadAmmunitionPort () const

virtual bool	createLoadedPort ()

virtual DtBooleanOutputPort *	loadedPort () const

virtual bool	createArtPartTypePort ()

virtual DtIntegerInputPort *	artPartTypePort () const

virtual void	setPreloadWeapon (bool doPreload)

virtual bool	preloadWeapon () const

virtual void	setLoadAmmoTime (DtTime loadAmmoTime)

virtual DtTime	loadAmmoTime () const

virtual void	setUnloadAmmoTime (DtTime unloadAmmoTime)

virtual DtTime	unloadAmmoTime () const

virtual void	setMaxVehicleSpeedToFire (DtReal maxVehicleSpeedToFire)

virtual DtReal	maxVehicleSpeedToFire () const

virtual bool	weaponCorrectlyOriented () const

virtual void	initProcessSR ()

virtual DtBaseMountingController *	mountingController ()

virtual void	setCurrentMunitionType (const DtEntityType &currentMunitionName)

virtual const DtEntityType &	currentMunitionType () const

virtual DtVrfWeaponPSR *	weaponProcessState ()

virtual const DtVrfWeaponPSR *	weaponProcessState () const

virtual void	setMaxAzimuthAngleOffBoresight (DtReal maxAngle)

virtual DtReal	maxAzimuthAngleOffBoresight () const

virtual void	setMaxElevationAngleOffBoresight (DtReal maxAngle)

virtual DtReal	maxElevationAngleOffBoresight () const

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

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const 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	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 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	registerAttributeFunctions ()

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 void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual void	isClutterChanged ()

virtual bool	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=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

Static Public Member Functions inherited from DtBaseWeaponController
static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

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 bool	createPorts () override

virtual void	addRangeItems ()

virtual DtWeaponInfoInterface::TargetApplicability	targetApplicability (const DtEntityType &type)

virtual bool	positionWithinTargetRegion (const DtVector &localPosition)

virtual bool	targetAmmunition (const DtEntityType &type)

virtual void	setupRegionEvaluator ()

virtual void	updateRegionEvaluator ()

virtual double	maximumRange ()

virtual double	minimumRange ()

	DtWeaponController ()

	DtWeaponController (const DtWeaponController &orig)

const DtWeaponController &	operator= (const DtWeaponController &orig)


virtual bool	isFireMissileLauncherTasked () const

virtual const DtFireMissileLauncherTask *	getFireMissileLauncherTask () const

const DtEntityTargetInformation	createTargetInfo () const

bool	hasTarget () const

virtual const DtRwLocationReference::LocationType	targetLocationType () const

virtual const DtEntityTargetInformation	target () const

virtual const DtVector	locationTarget () const

void	setRoundsFiredUponTarget (const int &roundsFired)

const int	roundsFiredUponTarget () const

const int	totalRoundsToFireUponTarget () const

void	setIsExplicitlyTasked (const bool &explicitlyTasked)

const bool	isExplicitlyTasked () const

void	setWeaponStatus (const int weaponStatus)

const int	weaponStatus () const

void	addWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)

void	removeWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)

Protected Member Functions inherited from DtBaseWeaponController
virtual bool	createPortGroups () override

virtual void	lookupAndCacheProcessSR ()

virtual DtString	weaponId () const

virtual bool	weaponStowable ()

virtual bool	weaponStowed ()

virtual bool	weaponInTransition ()

virtual void	setWeaponStowed (bool v)

virtual void	processSetStowWeapon (DtSimMessage *msg)

	DtBaseWeaponController ()

	DtBaseWeaponController (const DtBaseWeaponController &orig)

const DtBaseWeaponController &	operator= (const DtBaseWeaponController &orig)

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

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

DtMountingController *	myMountingController

const DtWeaponControllerDescriptor *	myWeaponCtlrDesc

DtWeaponComponentInterface *	myWeaponComponentInterface

DtGenericWeaponInfo *	myWeaponInfo

std::map< DtString, DtSimMunition >	myUsableMunitions

double	myMaxMunitionEffectiveRange

std::shared_ptr < DtSpatialFilterEvaluator >	myRegionEvaluator

DtTime	myLastRegionEvaluatorUpdateTime

double	myTaskGiveUpTime = -1.0

Ports and Port Groups
DtBooleanInputPort *	myWeaponsHoldPort

Protected Attributes inherited from DtBaseWeaponController
bool	myDoWeaponPreload

bool	myWaitingForFire

DtReal	myFireMaxVehicleSpeed

DtReal	myMaxAzimuthAngleOffBoresight

DtReal	myMaxElevationAngleOffBoresight

const DtBaseWeaponControllerDescriptor *	myBaseWeaponCtlrDesc

DtBaseMountingController *	myBaseMountingController

DtVrfWeaponPSR *	myWeaponProcessState

DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade

DtOutputPortGroup *	myWeaponOutputPortGroup

DtAmmunitionOutputPort *	myLoadAmmunitionPort

DtBooleanOutputPort *	myTriggerPort

DtBooleanOutputPort *	myLoadedPort

DtInputPortGroup *	myWeaponInputPortGroup

DtIntegerInputPort *	myArtPartTypePort

DtIntegerInputPort *	myStowedStateInputPort

DtBooleanOutputPort *	myStowCommandOutputPort

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

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 Member Functions inherited from DtBaseWeaponController
static void	setStowWeaponCallback (DtSimMessage msg, void usrData)

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

DtWeaponController::DtWeaponController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc = `nullptr`,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

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 DtWeaponController::~DtWeaponController ( )

overridevirtual

destructor

DtWeaponController::DtWeaponController ( )

protected

default constructor; not implemented

DtWeaponController::DtWeaponController ( const DtWeaponController & orig )

protected

copy constructor; not implemented

Member Function Documentation

virtual const char* DtWeaponController::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: DtWeaponControllerType

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController, DtJavelinLauncherController, and DtVerticalLauncherController.

virtual bool DtWeaponController::createMountingController ( )

overridevirtual

Overridden to create a DtMountingController.

Reimplemented from DtBaseWeaponController.

virtual bool DtWeaponController::init ( )

overridevirtual

Overridden to initialize values obtained from the descriptor.

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController, and DtJavelinLauncherController.

virtual void DtWeaponController::preFirstTickInit ( )

overridevirtual

Starts with weapon loaded, if the weapon has a full complement of ammunition.

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual void DtWeaponController::tick ( )

overridevirtual

If the myWaitingForFire flag is set and the munition loader is still loaded, the weapon has not fired yet and the function immediately returns. Otherwise myWaitingForFire is set to false. If the output port group is activated and the simulation is not paused, chooseTarget() is called, the munition loader is ticked, and myLoadedPort is updated. If acquireTarget() and loadedAmmoValidForTarget() return true, fire() is called.

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual void DtWeaponController::fire ( )

overridevirtual

updates weapon interface

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual const DtSimObject* DtWeaponController::chooseTarget ( )

virtual

Called by tick() to find a target. Calls acceptSensorTargettingInput(), to see if it has a target. If this function returns true, it looks up the target DtObjectId in myWeaponProcessState, and then looks up the DtLocalObject* for that ID in the DtSimObjectManager. If the entity is found, it is set in the process state repository by calling myWeaponProcessState->setCurrentTarget and then the pointer is returned. If not, the current target is set to DtUUID::nullUUID(), and a NULL pointer is returned.

virtual DtSimObjectReference DtWeaponController::chooseTarget ( const DtEntityTargetList & targetList ) const

virtual

Calls acceptSensorTargettingInput to get a target from the weapon interface and put it in the PSR as the current target (this has nothing to do with sensors). Given this target (or null), the mounting controller targetPoint or useTargetPoint is set.

virtual const DtVector DtWeaponController::chooseLocationTarget ( )

virtual

Called by tick() if chooseTarget() does not return an object. Called when the controller is explicitly tasked and the target type is location. Sets the location in the process state repository by calling myWeaponProcessState->setCurrentLocationTarget Returns the location from the fire task. If the the target type is not a location - a DtVector(0,0,0) is returned. The function is closely related to the chooseTarget() , and has a similar name. Apart from that - chooseLocationTarget() does not really chooses target , and the name is misleading.

virtual void DtWeaponController::tickMunitionLoader ( const DtSimObject * target )

virtual

This method will set the flags myLoading, myUnloading, myLoaded as the load state of the weapon changes. The parameter is the entity object of the current target for the weapon. The loader will only perform an activity if it has a target, otherwise it remains idle.

virtual bool DtWeaponController::acquireTarget ( const DtSimObject * target )

virtual

Returns true when target has been acquired. If the target cannot be acquired given the azimuthSweep or elevationRange limitations of the weapon mounting, this method will invoke the method "maneuverToAcquireTarget" method. This function returns true if a given DtSimBaseEntity* target can be acquired, false if not. It starts by calling findBodyAzimuthElevationToTargetPoint() to get the azimuth and elevation angles to the target, in terms of the body coordinate system of the entity. It then calls desiredOrientationIsInRange(), testing to see if the azimuth and elevation angles are within the angular range given by myMunitionManeuverMargin (a parameter specified in the component descriptor). If this function return false, it calls maneuverRequiredToAcquireTarget(). Note: The base class version of this function is not implemented. Derived classes may implement a version that maneuvers the entity such that it can acquire the target. Similarly, if the entity is exceeding the maximum speed at which it can fire (myFireMaxVehicleSpeed), it calls maneuverRequiredToAcquireTarget(). If the target lies within myMunitionManeuverMargin, both in azimuth and elevation, it calls setTargetAcquired() in the entity local state repository, and returns true.

Reimplemented in DtVerticalLauncherController.

virtual bool DtWeaponController::acquireLocationTarget ( const DtVector locTarget )

virtual

Provides the same functionality as the acquireTarget(const DtSimObject* target) function. Takes a location input argument instaead of an object.

virtual void DtWeaponController::maneuverRequiredToAcquireTarget	(	DtReal	requiredHeading,
		DtReal	requiredPitch,
		DtReal	requiredMaxSpeed
	)

virtual

This function is called by acquireTarget() in cases manuvering of the entity is required to successfully acquire the target. Derived classes may implement a version that maneuvers the entity. The default implementation will give up the current task after this function is called for longer than the time specified in the component descriptor give-up-task-time parameter.

bool DtWeaponController::outOfAmmo ( ) const

Returns true if this weapon is entirely out of ammunition.

virtual bool DtWeaponController::loadedAmmoValidForTarget ( const DtSimObject * target ) const

virtual

Called by tick() as part of the check to see if the trigger should be pulled. Returns false if the munition loader is not loaded. Otherwise it checks the ammo selection table to make sure that the currently loaded munition matches the entity type of the target parameter.

virtual bool DtWeaponController::chooseAmmo	(	const DtEntityType &	entityType,
		DtSimMunition &	munitionOut,
		DtDetonatorFuze &	fuzeOut,
		bool	setCurrentMunition = `true`
	)

virtual

The chooseAmmo() function is passed a pointer to a target entity and returns the best ammunition to use for the target's entity type. Type of ammunition and availability, if any, is from the Ammo Select Table specified in the DtWeaponControllerDescriptor. The Ammo Select Table provides a list of ammunition types that are appropriate for a given target type, in order from most preferred to least preferred. The chooseAmmo() function starts at the beginning of the list of appropriate ammunition types, and returns the first one for which the resource is available. Note: Fuze types are not supported in the current version of VR-Forces; DtFuzeOther is returned for the fuze. If an entity type of DtEntityType::nullType() is passed in, the first munition in the Ammo Select Table is chosen.

If setCurrentMunition is false, then, this routine can be used to simply check to see if the munition exists for the particular entity without actually selecting it

virtual bool DtWeaponController::acceptSensorTargettingInput ( )

virtual

Returns true if we get a viable target from the weapon interface and sets this target in the PSR. If there is no target in the WI, then null is set into the PSR. Note: the "sensor" part of this is obsolete; there is not connection to sensors.

virtual bool DtWeaponController::inSector ( const DtSimObject * entity ) const

virtual

Sets the trigger port value to true, sets myLoaded flag to false, and depletes the resource associated with the current munition type in the entity's local state repository.

virtual void DtWeaponController::findBodyHeadingElevationToTarget	(	const DtSimObject *	entity,
		DtReal &	bodyHeadingOut,
		DtReal &	bodyElevationOut
	)		const

virtual

Given a target entity, computes the body heading (azimuth) and elevation angles to the target, in the body coordinates of the entity.

virtual DtSimObjectReference DtWeaponController::easier	(	DtSimObjectReference	entity1,
		DtSimObjectReference	entity2
	)		const

virtual

This function takes two DtLocalObject* entities as arguments, and returns the entity that is easier for the weapon to acquire. In this base class function, it chooses the first entity argument, and returns it.

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

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 void DtWeaponController::enable ( )

overridevirtual

Overridden to call registerTaskMsgCallbacks().

Reimplemented from DtTaskControllerComponent.

virtual void DtWeaponController::disable ( )

overridevirtual

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

Reimplemented from DtSingleTaskControllerComponent.

virtual bool DtWeaponController::createPorts ( )

overrideprotectedvirtual

Overridden to create the local ports.

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual void DtWeaponController::addRangeItems ( )

protectedvirtual

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

virtual DtWeaponInfoInterface::TargetApplicability DtWeaponController::targetApplicability ( const DtEntityType & type )

protectedvirtual

virtual bool DtWeaponController::positionWithinTargetRegion ( const DtVector & localPosition )

protectedvirtual

virtual bool DtWeaponController::targetAmmunition ( const DtEntityType & type )

protectedvirtual

Returns: True if there is ammunition available for the given entity type.

virtual void DtWeaponController::setupRegionEvaluator ( )

protectedvirtual

virtual void DtWeaponController::updateRegionEvaluator ( )

protectedvirtual

Checks sim time vs myLastRegionEvaluatorUpdateTime and updates the region evaluator if needed.

virtual double DtWeaponController::maximumRange ( )

protectedvirtual

virtual double DtWeaponController::minimumRange ( )

protectedvirtual

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

protected

assignment operator; not implemented

virtual bool DtWeaponController::isFireMissileLauncherTasked ( ) const

protectedvirtual

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

Reimplemented in DtLauncherController.

virtual const DtFireMissileLauncherTask* DtWeaponController::getFireMissileLauncherTask ( ) const

protectedvirtual

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

Reimplemented in DtLauncherController.

const DtEntityTargetInformation DtWeaponController::createTargetInfo ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

bool DtWeaponController::hasTarget ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

virtual const DtRwLocationReference::LocationType DtWeaponController::targetLocationType ( ) const

protectedvirtual

Returns the target type - object or location.

virtual const DtEntityTargetInformation DtWeaponController::target ( ) const

protectedvirtual

Returns the target object - if the target type is object.

virtual const DtVector DtWeaponController::locationTarget ( ) const

protectedvirtual

Returns the target position - if the target type is location.

void DtWeaponController::setRoundsFiredUponTarget ( const int & roundsFired )

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

const int DtWeaponController::roundsFiredUponTarget ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

const int DtWeaponController::totalRoundsToFireUponTarget ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

void DtWeaponController::setIsExplicitlyTasked ( const bool & explicitlyTasked )

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

const bool DtWeaponController::isExplicitlyTasked ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

void DtWeaponController::setWeaponStatus ( const int weaponStatus )

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

const int DtWeaponController::weaponStatus ( ) const

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

void DtWeaponController::addWeaponStatus ( const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus )

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

void DtWeaponController::removeWeaponStatus ( const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus )

protected

The following private function are created temporarily during the weapon system refactoring. Their purpose is to bypass the target weapon interface and the target selection controller, when the new DtFireMissileLauncherTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.

Some of these functions are used for pre VRF-5.1 scenarios Some of them should be deprecated

Member Data Documentation

DtUUID DtWeaponController::myCurrentTarget

protected

DtBooleanInputPort* DtWeaponController::myWeaponsHoldPort

protected

Input Port Name: weapons-hold
Input Port Description: When true, all firing of missiles is disabled. Connecting to this port is optional. If no connection is made, it will default to false.
Input Port Range: True/False
Input Port Default Value: False
.

DtMountingController* DtWeaponController::myMountingController

protected

const DtWeaponControllerDescriptor* DtWeaponController::myWeaponCtlrDesc

protected

DtWeaponComponentInterface* DtWeaponController::myWeaponComponentInterface

protected

DtGenericWeaponInfo* DtWeaponController::myWeaponInfo

protected

std::map<DtString, DtSimMunition> DtWeaponController::myUsableMunitions

protected

double DtWeaponController::myMaxMunitionEffectiveRange

protected

std::shared_ptr<DtSpatialFilterEvaluator> DtWeaponController::myRegionEvaluator

protected

DtTime DtWeaponController::myLastRegionEvaluatorUpdateTime

protected

double DtWeaponController::myTaskGiveUpTime = -1.0

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation