DtBaseWeaponController Class Reference

DtBaseWeaponController is a controller that creates the ports needed to choose ammo for, load, and trigger a weapon (a DtWeaponActuator).

Uses Descriptor Type: DtBaseWeaponControllerDescriptor

Inheritance diagram for DtBaseWeaponController:

Public Member Functions
	DtBaseWeaponController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=nullptr, DtReaderWriterRegistry *parentRegistry=nullptr)
virtual	~DtBaseWeaponController () override
virtual bool	init () override
virtual bool	postAddComponentsInit () override
virtual bool	createMountingController ()
virtual const char *	type () const override
virtual void	fire ()
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	tick () override
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	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 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 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	createPortGroups () override
virtual bool	createPorts () override
virtual void	lookupAndCacheProcessSR ()
virtual void	preFirstTickInit () override
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)

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

Protected Attributes
bool	myDoWeaponPreload
bool	myWaitingForFire
DtReal	myFireMaxVehicleSpeed
DtReal	myMaxAzimuthAngleOffBoresight
DtReal	myMaxElevationAngleOffBoresight
const DtBaseWeaponControllerDescriptor *	myBaseWeaponCtlrDesc
DtBaseMountingController *	myBaseMountingController
DtVrfWeaponPSR *	myWeaponProcessState
DtPlatformLocalObjectFacade	myPlatformLocalObjectFacade
Ports and Port Groups
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 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

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

overridevirtual

destructor

DtBaseWeaponController::DtBaseWeaponController ( )

protected

default constructor; not implemented

DtBaseWeaponController::DtBaseWeaponController ( const DtBaseWeaponController &  orig )

protected

copy constructor; not implemented

Member Function Documentation

virtual bool DtBaseWeaponController::init ( )

overridevirtual

Overridden to initialize values obtained from the descriptor.

Reimplemented from DtControllerComponent.

Reimplemented in DtWeaponController, DtLauncherController, DtIndirectFireWeaponController, and DtJavelinLauncherController.

virtual bool DtBaseWeaponController::postAddComponentsInit ( )

overridevirtual

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

Reimplemented from DtControllerComponent.

virtual bool DtBaseWeaponController::createMountingController ( )

virtual

Creates myBaseMountingController.

Reimplemented in DtWeaponController, and DtIndirectFireWeaponController.

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

DtBaseWeaponControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtLauncherController, DtWeaponController, DtIndirectFireWeaponController, DtJavelinLauncherController, and DtVerticalLauncherController.

virtual void DtBaseWeaponController::fire ( )

virtual

fires the weapon

Reimplemented in DtLauncherController, and DtWeaponController.

virtual bool DtBaseWeaponController::waitingForFire ( )

virtual

Returns true if the trigger has been set but the actuator has not yet fired.

virtual void DtBaseWeaponController::setWaitingForFire ( bool  waiting )

virtual

Sets myWaitingForFire.

virtual bool DtBaseWeaponController::createWeaponOutputPortGroup ( )

virtual

Initializes myWeaponOutputPortGroup.

virtual DtOutputPortGroup* DtBaseWeaponController::weaponOutputPortGroup ( )

virtual

Returns myWeaponOutputPortGroup.

virtual bool DtBaseWeaponController::createWeaponInputPortGroup ( )

virtual

Initializes myWeaponInputPortGroup.

virtual DtInputPortGroup* DtBaseWeaponController::weaponInputPortGroup ( )

virtual

Returns myWeaponInputPortGroup.

virtual bool DtBaseWeaponController::createTriggerPort ( )

virtual

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

virtual DtBooleanOutputPort* DtBaseWeaponController::triggerPort ( ) const

virtual

virtual bool DtBaseWeaponController::createLoadAmmunitionPort ( )

virtual

virtual DtAmmunitionOutputPort* DtBaseWeaponController::loadAmmunitionPort ( ) const

virtual

virtual bool DtBaseWeaponController::createLoadedPort ( )

virtual

virtual DtBooleanOutputPort* DtBaseWeaponController::loadedPort ( ) const

virtual

virtual bool DtBaseWeaponController::createArtPartTypePort ( )

virtual

virtual DtIntegerInputPort* DtBaseWeaponController::artPartTypePort ( ) const

virtual

virtual void DtBaseWeaponController::setPreloadWeapon ( bool  doPreload )

virtual

If setPreloadWeapon to true, the loader will load the first munition from the ammoselect table if there is no target. This has the advantage of having the weapon ready to fire, but the disadvantage of possibly having the wrong munition loaded when a target appears. Setting it to false means the weapon isn't loaded until a target appears.

virtual bool DtBaseWeaponController::preloadWeapon ( ) const

virtual

virtual void DtBaseWeaponController::setLoadAmmoTime ( DtTime  loadAmmoTime )

virtual

virtual DtTime DtBaseWeaponController::loadAmmoTime ( ) const

virtual

virtual void DtBaseWeaponController::setUnloadAmmoTime ( DtTime  unloadAmmoTime )

virtual

virtual DtTime DtBaseWeaponController::unloadAmmoTime ( ) const

virtual

virtual void DtBaseWeaponController::setMaxVehicleSpeedToFire ( DtReal  maxVehicleSpeedToFire )

virtual

Some vehicles must stop to shoot, others have a maximum speed to launch a munition. This is the maximum speed the vehicle can be moving when it fires this weapon.

virtual DtReal DtBaseWeaponController::maxVehicleSpeedToFire ( ) const

virtual

virtual bool DtBaseWeaponController::weaponCorrectlyOriented ( ) const

virtual

virtual void DtBaseWeaponController::setMaxAzimuthAngleOffBoresight ( DtReal  maxAngle )

virtual

Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon.

virtual DtReal DtBaseWeaponController::maxAzimuthAngleOffBoresight ( ) const

virtual

Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon.

virtual void DtBaseWeaponController::setMaxElevationAngleOffBoresight ( DtReal  maxAngle )

virtual

Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon.

virtual DtReal DtBaseWeaponController::maxElevationAngleOffBoresight ( ) const

virtual

Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians off of boresight the target can be and still reasonably fire the weapon.

virtual void DtBaseWeaponController::initProcessSR ( )

virtual

Sets the load & unload ammo time from the component descriptor.

virtual DtBaseMountingController* DtBaseWeaponController::mountingController ( )

virtual

returns the DtBaseMountingController

virtual void DtBaseWeaponController::setCurrentMunitionType ( const DtEntityType &  currentMunitionName )

virtual

sets the current munition name in the DtVrfWeaponPSR

virtual const DtEntityType& DtBaseWeaponController::currentMunitionType ( ) const

virtual

gets the current munition name from the DtVrfWeaponPSR

virtual DtVrfWeaponPSR* DtBaseWeaponController::weaponProcessState ( )

virtual

Returns the DtVrfWeaponPSR.

virtual const DtVrfWeaponPSR* DtBaseWeaponController::weaponProcessState ( ) const

virtual

Returns the DtVrfWeaponPSR.

virtual void DtBaseWeaponController::tick ( )

overridevirtual

Sets the current dT on the base mounting controller and ticks it.

Reimplemented from DtSimComponent.

Reimplemented in DtWeaponController, DtLauncherController, and DtIndirectFireWeaponController.

static DtSimComponent* DtBaseWeaponController::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 bool DtBaseWeaponController::createPortGroups ( )

overrideprotectedvirtual

Overridden to add port groups from myBaseMountingController, allowing OPD connections to be specified using the name of this component.

Reimplemented from DtSimComponent.

virtual bool DtBaseWeaponController::createPorts ( )

overrideprotectedvirtual

Overridden to create input & output ports.

Reimplemented from DtSimComponent.

Reimplemented in DtWeaponController, DtIndirectFireWeaponController, and DtLauncherController.

virtual void DtBaseWeaponController::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 myWeaponProcessState. 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 psrTypes.h. Another component is responsible for creating and destroying the process state repository.

Reimplemented in DtIndirectFireWeaponController.

virtual void DtBaseWeaponController::preFirstTickInit ( )

overrideprotectedvirtual

This function can be overridden to initialize a component before it is ticked for the first time. The implementation for this function is empty. It is called by timedTick if myFirstTick is true.

Reimplemented from DtSimComponent.

Reimplemented in DtLauncherController, DtWeaponController, and DtIndirectFireWeaponController.

virtual DtString DtBaseWeaponController::weaponId ( ) const

protectedvirtual

Returns

The weaponID used for this weapon.

virtual bool DtBaseWeaponController::weaponStowable ( )

protectedvirtual

Returns

True if this weapon is able to be stowed.

virtual bool DtBaseWeaponController::weaponStowed ( )

protectedvirtual

Returns

True if the weapon is in a stowed state. Will also return true if it is transitioning to/from a stowed state.

virtual bool DtBaseWeaponController::weaponInTransition ( )

protectedvirtual

Returns

True if the weapon is transitioning to/from a stowed state.

False if the weapon is in a stowed or deployed state.

virtual void DtBaseWeaponController::setWeaponStowed ( bool  v )

protectedvirtual

If stowable, this call will set the stow/deploy state. If the desired state is different that the current state, this may initiate a multi-tick transition to the desired state.

static void DtBaseWeaponController::setStowWeaponCallback ( DtSimMessage *  msg, void *  usrData  )

staticprotected

virtual void DtBaseWeaponController::processSetStowWeapon ( DtSimMessage *  msg )

protectedvirtual

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

protected

assignment operator; not implemented

Member Data Documentation

DtOutputPortGroup* DtBaseWeaponController::myWeaponOutputPortGroup

protected

Output Port Group Name: weapon-control
Output Port Group Description:

DtAmmunitionOutputPort* DtBaseWeaponController::myLoadAmmunitionPort

protected

Output Port Name: ammunition
Output Port Description: Type of ammunition to use
Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control.

DtBooleanOutputPort* DtBaseWeaponController::myTriggerPort

protected

Output Port Name: trigger
Output Port Description: True to fire.
Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control.

DtBooleanOutputPort* DtBaseWeaponController::myLoadedPort

protected

Output Port Name: loaded
Output Port Description: True if loaded.
Output Port Range:
Output Port Default Value:
Output Group Parent: weapon-control.

DtInputPortGroup* DtBaseWeaponController::myWeaponInputPortGroup

protected

Input Port Group Name: weapon-info
Input Port Group Description:

DtIntegerInputPort* DtBaseWeaponController::myArtPartTypePort

protected

Input Port Name: art-part-type
Input Port Description: Type of articulated part.
Input Port Range:
Input Port Default Value:
Input Group Parent: weapon-info.

DtIntegerInputPort* DtBaseWeaponController::myStowedStateInputPort

protected

Input Port Name: stowed-state
Input Port Description: Receives the current stowed/deployed state of the weapon. If not in the Deployed state, weapon is not operational. If no connection is made, then this is ignored. Input Port Range: 0: Stowed, 1: IN_TRANSITION, 2: Deployed
.

DtBooleanOutputPort* DtBaseWeaponController::myStowCommandOutputPort

protected

Output Port Name: stow-command
Output Port Description: Indicates if the controller wants to stow the weapon. True for deploying, False for stowing the weapon. Output Port Range: True/False
Output Port Default Value: True
.

bool DtBaseWeaponController::myDoWeaponPreload

protected

If myDoWeaponPreload is true, the loader will load the first munition from the ammoselect table if there is no target. This has the advantage of having the weapon ready to fire, but the disadvantage of possibly having the wrong munition loaded when a target appears.

bool DtBaseWeaponController::myWaitingForFire

protected

This flag is set to true when the controller pulls the trigger, and set back to false when the controllers sees that the loaded munition has been unloaded (by the gun).

DtReal DtBaseWeaponController::myFireMaxVehicleSpeed

protected

Some vehicles must stop to shoot, others have a maximum speed to launch a munition.

DtReal DtBaseWeaponController::myMaxAzimuthAngleOffBoresight

protected

DtReal DtBaseWeaponController::myMaxElevationAngleOffBoresight

protected

const DtBaseWeaponControllerDescriptor* DtBaseWeaponController::myBaseWeaponCtlrDesc

protected

Get ammo select tables from here.

DtBaseMountingController* DtBaseWeaponController::myBaseMountingController

protected

DtVrfWeaponPSR* DtBaseWeaponController::myWeaponProcessState

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

DtPlatformLocalObjectFacade DtBaseWeaponController::myPlatformLocalObjectFacade

protected

Member to allow for access to platform specific data.

---

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

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