DtBallisticGunController provides ammunition loading, unloading, and trigger inputs for use by a ballistic gun actuator.

End User Description: It chooses ammunition to load based on entity type according to criteria specified in the DtBallisticGunControllerDescriptor used to specify the component. Load and unload times are also provided in this manner. If the entity has permission to fire, has acquired a target, and has the appropriate ammunition loaded, the DtBallisticGunController sets the trigger port to true, firing the ballistic gun.

Uses Descriptor Type: DtBallisticGunControllerDescriptor

Examples

Stop To Shoot Example

Inheritance diagram for DtBallisticGunController:

[legend]

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

virtual	~DtBallisticGunController ()

virtual bool	postAddComponentsInit () override

virtual const char *	type () const override

virtual bool	init () override

virtual void	registerTaskMsgCallbacks () override

virtual AcceptLevel	acceptTask (const DtTaskMessage &task) override

virtual void	preFirstTickInit () override

virtual void	tick () override

virtual bool	createTriggerPort ()

virtual DtBooleanOutputPort *	triggerPort () const

virtual bool	createQuantityOutputPort ()

virtual DtIntegerOutputPort *	quantityOutputPort () const

virtual bool	createLoadedPort ()

virtual DtBooleanOutputPort *	loadedPort () const

virtual bool	createLosOutputPort ()

virtual DtIntegerOutputPort *	losOutputPort () const

virtual bool	createLosInputPort ()

virtual DtIntegerInputPort *	losInputPort () const

virtual bool	createWeaponsHoldInputPort ()

virtual bool	createTargetToAcquireOutputPort ()

virtual void	setLoadAmmoTime (DtTime loadAmmoTime)

virtual DtTime	loadAmmoTime () const

virtual void	setUnloadAmmoTime (DtTime unloadAmmoTime)

virtual DtTime	unloadAmmoTime () const

virtual void	fire ()

virtual bool	chooseAmmo (const DtEntityType &targetType, const DtUUID &target, DtSimMunition &munition, DtDetonatorFuze &fuze, int &ammoAvailable, bool recurse=true)

virtual bool	checkCurrentAmmo (int &ammoAvailable)

virtual bool	ammoOKToUse (const DtEntityType &targetType)

virtual void	initProcessSR ()

virtual void	enable () override

virtual void	disable () override

virtual void	clearTask () override

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

virtual	~DtSingleTaskControllerComponent ()

virtual void	postTick () override

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState) override

virtual void	taskNotify (const DtSimTask &task) override

virtual void	taskComplete (bool success=true)

virtual void	suspendTask ()

virtual int	sendSubtask (DtSimTask &task)

virtual void	clearSubtask (int subtaskId)

virtual void	addPendingSubtaskId (int subtaskId)

virtual bool	findPendingSubtaskId (int subtaskId)

virtual bool	isSubtasked () const

virtual void	removePendingSubtaskId (int subtaskId)

virtual void	removeAllPendingSubtaskIds ()

virtual std::vector< int >	currentPendingSubstaskIds () const

virtual DtSubtaskStatusEntry *	subtaskStatus (int subtaskId)

virtual void	clearCurrentTaskMessage ()

virtual DtTaskMessage *	currentTaskMessage () const

virtual DtSimTaskStatePtr	currentTaskState () const

virtual bool	decideToGiveUpTask () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const override

virtual bool	clearTopLevelTasks () override

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType) override

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType) override

virtual void	clearTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId) override

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId) override

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const override

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=nullptr, DtReaderWriterRegistry parentRegistry=nullptr)

virtual	~DtTaskControllerComponent ()

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio) override

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)

virtual bool	taskVisualizationsActive () const override

virtual void	setTasked (bool tasked)

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()

virtual 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 ()

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)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

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

virtual bool	createPortGroups () override

virtual void	lookupAndCacheProcessSR ()

bool	updateFireBallisticGunTask ()

virtual DtSimTask *	createFireTask (const DtRwLocationReference &locRef) const

virtual DtIntegerResource *	lookupMunitionResource (const DtString &resource) const

void	getMunitionResources (std::list< DtString > &resourceList)

virtual void	updateResourceList ()

virtual bool	weaponsHoldState ()

bool	outOfAmmo () const

virtual bool	isSurrenderedLifeform (const DtSimObject *entity) const

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

virtual bool	positionWithinTargetRegion (const DtVector &localPosition)

virtual void	setupRegionEvaluator ()

virtual void	updateRegionEvaluator ()

virtual DtString	weaponId () const

virtual bool	createWorkingTargetPoint (const DtVector worldLoc)

virtual void	deleteWorkingTargetPoint ()

	DtBallisticGunController ()

	DtBallisticGunController (const DtBallisticGunController &orig)

const DtBallisticGunController &	operator= (const DtBallisticGunController &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 ()

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	myPreviousTarget

DtSimMunition	myCurrentMunition

DtDetonatorFuze	myCurrentFuze

int	myRoundsAvailable

DtVrfBalGunPSR *	myProcessState

const DtBallisticGunControllerDescriptor *	myGunDescriptor

bool	myWaitingForFire

bool	myOutOfAmmoWarn

DtWeaponComponentInterface *	myWeaponComponentInterface

DtGenericWeaponInfo *	myWeaponInfo

DtBoost::shared_ptr < DtSpatialFilterEvaluator >	myRegionEvaluator

DtTime	myLastRegionEvaluatorUpdateTime

Ports and Port Groups
DtIntegerInputPort *	myLosInputPort

DtBooleanOutputPort *	myTriggerPort

DtIntegerOutputPort *	myQuantityOutputPort

DtBooleanOutputPort *	myLoadedPort

DtIntegerOutputPort *	myLosOutputPort

DtOutputPortGroup *	myGunControlPortGroup

DtBooleanInputPort *	myWeaponsHoldInputPort

DtEntityListOutputPort *	myTargetToAcquireOutputPort

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList

bool	myTaskIsRunning

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myLastTickSimTime

std::unique_ptr< DtTimedTickLogic >	myTimedTickLogic

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager *	myPredicateCallbackManager

boost::signals2::scoped_connection	myIsClutterChangedConnection

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Private Member Functions

bool	isFireBallisticGunTasked () const

const DtFireBallisticGunTask *	getFireBallisticGunTask () const

const DtEntityTargetInformation	createTargetInfo () const

bool	hasTarget () const

const DtEntityTargetInformation	target () const

void	setRoundsFiredUponTarget (const int &roundsFired)

const int	roundsFiredUponTarget () const

const int	totalRoundsToFireUponTarget () const

void	setIsExplicitlyTasked (const bool &explicitlyTasked)

const bool	isExplicitlyTasked () const

void	setIsInFiringCycle (const bool isIn)

const bool	isInFiringCycle () const

void	setWeaponStatus (const int weaponStatus)

const int	weaponStatus () const

void	addWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)

void	removeWeaponStatus (const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus)

virtual void	processFireBallisticGunTask (DtSimMessage *msg)

static void	fireBallisticGunTaskCallback (DtSimMessage msg, void usr)

virtual DtReaderWriter *	provideRoundsPerTriggerPull ()

static DtReaderWriter *	roundsPerTriggerPullCallback (void *ctrlr)

virtual void	processSetResource (DtSimMessage *msg)

static void	setResourceCallback (DtSimMessage msg, void usrData)

virtual void	processSetRestore (DtSimMessage *msg)

static void	setRestoreCallback (DtSimMessage msg, void usrData)

Additional Inherited Members
Public Types inherited from DtTaskControllerComponent
enum	AcceptLevel { AcceptLevel_Accept = 0, AcceptLevel_Partial = 1, AcceptLevel_Error = 2, AcceptLevel_NoAccept = 99 }

Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

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

virtual

destructor

DtBallisticGunController::DtBallisticGunController ( )

protected

Not implemented.

DtBallisticGunController::DtBallisticGunController ( const DtBallisticGunController & orig )

protected

Not implemented.

Member Function Documentation

virtual bool DtBallisticGunController::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 const char* DtBallisticGunController::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: DtBallisticGunControllerType

Implements DtTaskControllerComponent.

Reimplemented in DtBallisticGunJoyController.

virtual bool DtBallisticGunController::init ( )

overridevirtual

Sets up weapon component interface.

Reimplemented from DtControllerComponent.

virtual void DtBallisticGunController::registerTaskMsgCallbacks ( )

overridevirtual

Registers callbacks for task messages.

Reimplemented from DtTaskControllerComponent.

virtual AcceptLevel DtBallisticGunController::acceptTask ( const DtTaskMessage & task )

overridevirtual

Only accept tasks for which this controller has the named resource and the quantity of that resource is greater than 0.

Reimplemented from DtTaskControllerComponent.

virtual void DtBallisticGunController::preFirstTickInit ( )

overridevirtual

Restores the checkpointed values of myCurrentMunition and myCurrentFuze from the the munition loader of the DtVrfBalGunPSR. Calls setDisplayName on myWeaponComponentInterface with the value from the PSR.

Reimplemented from DtSimComponent.

virtual void DtBallisticGunController::tick ( )

overridevirtual

Calculate new control values.

Reimplemented from DtSimComponent.

Reimplemented in DtBallisticGunJoyController.

virtual bool DtBallisticGunController::createTriggerPort ( )

virtual

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

virtual DtBooleanOutputPort* DtBallisticGunController::triggerPort ( ) const

virtual

virtual bool DtBallisticGunController::createQuantityOutputPort ( )

virtual

virtual DtIntegerOutputPort* DtBallisticGunController::quantityOutputPort ( ) const

virtual

virtual bool DtBallisticGunController::createLoadedPort ( )

virtual

virtual DtBooleanOutputPort* DtBallisticGunController::loadedPort ( ) const

virtual

virtual bool DtBallisticGunController::createLosOutputPort ( )

virtual

virtual DtIntegerOutputPort* DtBallisticGunController::losOutputPort ( ) const

virtual

virtual bool DtBallisticGunController::createLosInputPort ( )

virtual

virtual DtIntegerInputPort* DtBallisticGunController::losInputPort ( ) const

virtual

virtual bool DtBallisticGunController::createWeaponsHoldInputPort ( )

virtual

virtual bool DtBallisticGunController::createTargetToAcquireOutputPort ( )

virtual

virtual void DtBallisticGunController::setLoadAmmoTime ( DtTime loadAmmoTime )

virtual

virtual DtTime DtBallisticGunController::loadAmmoTime ( ) const

virtual

virtual void DtBallisticGunController::setUnloadAmmoTime ( DtTime unloadAmmoTime )

virtual

virtual DtTime DtBallisticGunController::unloadAmmoTime ( ) const

virtual

virtual void DtBallisticGunController::fire ( )

virtual

Sets myTriggerPort to true and myLoaded to false. It also looks up the resource named by myCurrentMunitionName and if found, calls DtIntegerResource::deplete().

virtual bool DtBallisticGunController::chooseAmmo	(	const DtEntityType &	targetType,
		const DtUUID &	target,
		DtSimMunition &	munition,
		DtDetonatorFuze &	fuze,
		int &	ammoAvailable,
		bool	recurse = `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 DtBallisticGunControllerDescriptor. chooseAmmo() starts at the beginning of the list of appropriate ammunition types, and returns the first one for which the resource is available. DtFuzeOther is returned for the fuze. Sets psr->currentMunitionName as a side effect. May also set weaponInterface->status to NO_AMMO_FOR_TARGET.

virtual bool DtBallisticGunController::checkCurrentAmmo ( int & ammoAvailable )

virtual

Checks and updates the currently selected ammo amount.

virtual bool DtBallisticGunController::ammoOKToUse ( const DtEntityType & targetType )

virtual

Checks the ammo select table to see if the psr->currentMunitionName is on the list of ammunitions to use on this target type.

virtual void DtBallisticGunController::initProcessSR ( )

virtual

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

static DtSimComponent* DtBallisticGunController::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 DtBallisticGunController::enable ( )

overridevirtual

Overridden to call registerTaskMsgCallbacks().

Reimplemented from DtTaskControllerComponent.

virtual void DtBallisticGunController::disable ( )

overridevirtual

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

Reimplemented from DtSingleTaskControllerComponent.

virtual void DtBallisticGunController::clearTask ( )

overridevirtual

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.

virtual bool DtBallisticGunController::createPorts ( )

overrideprotectedvirtual

Called by init to create the output ports.

Reimplemented from DtSimComponent.

Reimplemented in DtBallisticGunJoyController.

virtual bool DtBallisticGunController::createPortGroups ( )

overrideprotectedvirtual

Called by init to create myGunControlPortGroup.

Reimplemented from DtSimComponent.

virtual void DtBallisticGunController::lookupAndCacheProcessSR ( )

protectedvirtual

This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState. The name (if it exists) is given in the component descriptor (DtComponentDescriptor::processStateRepositoryName). If the name does not exist, it uses the appropriate default name defined in procSRTypes.h. Another component is responsible for creating and destroying the process state repository.

static void DtBallisticGunController::fireBallisticGunTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

staticprotected

Called when a fire-at-target-ballistic-gun message is received.

Processes DtFireBallisticGunTask task. Assigns the target to the weapon and process the firing.

virtual void DtBallisticGunController::processFireBallisticGunTask ( DtSimMessage * msg )

protectedvirtual

Retrieves the entity to fire at from the task message.

Called by fireBallisticGunTaskCallback.

bool DtBallisticGunController::updateFireBallisticGunTask ( )

protected

Completes the FireBallisticGunTask if the conditions are met.

i.e. target destroyed, requested rounds fired, etc.
Returns
True if the task is ready, false another tick is needed to prepare the task.

virtual DtSimTask* DtBallisticGunController::createFireTask ( const DtRwLocationReference & locRef ) const

protectedvirtual

static DtReaderWriter* DtBallisticGunController::roundsPerTriggerPullCallback ( void * ctrlr )

staticprotected

Access provider callbacks. The Callback function calls the provider member function for the indicated controller.

virtual DtReaderWriter* DtBallisticGunController::provideRoundsPerTriggerPull ( )

protectedvirtual

Access provider callbacks. The Callback function calls the provider member function for the indicated controller.

virtual DtIntegerResource* DtBallisticGunController::lookupMunitionResource ( const DtString & resource ) const

protectedvirtual

Attempts to locate the given resource in the entity's state repository, and if it is a DtMunitionResource, it will be returned.

void DtBallisticGunController::getMunitionResources ( std::list< DtString > & resourceList )

protected

Get the resources for.

virtual void DtBallisticGunController::updateResourceList ( )

protectedvirtual

Go through the resource list and remove any with amounts = 0.

virtual bool DtBallisticGunController::weaponsHoldState ( )

protectedvirtual

Returns: The value on the weapons-hold input port. If there is no connection to the port, value defaults to false.

static void DtBallisticGunController::setResourceCallback	(	DtSimMessage *	msg,
		void *	usrData
	)

staticprotected

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

virtual void DtBallisticGunController::processSetResource ( DtSimMessage * msg )

protectedvirtual

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

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

staticprotected

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

virtual void DtBallisticGunController::processSetRestore ( DtSimMessage * msg )

protectedvirtual

A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

bool DtBallisticGunController::outOfAmmo ( ) const

protected

Returns true if this weapon is entirely out of ammunition.

virtual bool DtBallisticGunController::isSurrenderedLifeform ( const DtSimObject * entity ) const

protectedvirtual

Check for surrendered lifeform state.

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

protectedvirtual

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

protectedvirtual

virtual void DtBallisticGunController::setupRegionEvaluator ( )

protectedvirtual

virtual void DtBallisticGunController::updateRegionEvaluator ( )

protectedvirtual

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

virtual DtString DtBallisticGunController::weaponId ( ) const

protectedvirtual

Return The weaponID used for this weapon controller.

virtual bool DtBallisticGunController::createWorkingTargetPoint ( const DtVector worldLoc )

protectedvirtual

virtual void DtBallisticGunController::deleteWorkingTargetPoint ( )

protectedvirtual

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

protected

Not implemented.

bool DtBallisticGunController::isFireBallisticGunTasked ( ) const

private

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 DtFireBallisticGunTask is executed. The functions should be removed / replaced / modified as the refactoring goes along.