DtWeaponController Class Reference

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:

Public Member Functions
	DtWeaponController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtWeaponController ()
virtual const char *	type () const
virtual bool	createMountingController ()
virtual bool	init ()
virtual void	preFirstTickInit ()
virtual void	tick ()
virtual void	fire ()
virtual const DtSimObject *	chooseTarget ()
virtual DtSimObjectReference	chooseTarget (const DtEntityTargetList &targetList) const
virtual void	tickMunitionLoader (const DtSimObject *target)
virtual bool	acquireTarget (const DtSimObject *target)
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 ()
virtual void	disable ()
Public Member Functions inherited from DtBaseWeaponController
	DtBaseWeaponController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtBaseWeaponController ()
virtual bool	postAddComponentsInit ()
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	setCurrentMunitionName (const DtString &currentMunitionName)
virtual const DtString &	currentMunitionName () 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 DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject *owner, DtSimulationServices *simServices, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtControllerComponent ()
virtual DtSimRadio *	radio ()
virtual void	taskNotify (const DtSimTask &task)
virtual void	clearTask ()
virtual void	enableTaskTypes ()
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	postTick ()
virtual void	timedTick ()
virtual void	setMinTickPeriod (double minTickPeriod)
virtual double	minTickPeriod () const
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
virtual double	minTickPeriodVariance () const
virtual void	setNextTickTime (double nextTickTime)
virtual double	nextTickTime () const
virtual double	calculateNextTickTime () const
virtual double	calculateFirstTickTime () const
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 bool	taskVisualizationsActive () const
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)
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	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
Static Public Member Functions inherited from DtBaseWeaponController
static DtSimComponent *	creator (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
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 ()
virtual void	addRangeItems ()
	DtWeaponController ()
	DtWeaponController (const DtWeaponController &orig)
const DtWeaponController &	operator= (const DtWeaponController &orig)
Protected Member Functions inherited from DtBaseWeaponController
virtual bool	createPortGroups ()
virtual void	lookupAndCacheProcessSR ()
	DtBaseWeaponController ()
	DtBaseWeaponController (const DtBaseWeaponController &orig)
const DtBaseWeaponController &	operator= (const DtBaseWeaponController &orig)
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	setRadio (DtSimRadio *radio)
virtual void	sendCapableSetsAndTasks ()
Protected Member Functions inherited from DtSimComponent
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
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
std::map< DtString, DtSimMunition >	myUsableMunitions
double	myMaxMunitionEffectiveRange
Ports and Port Groups
DtEntityListInputPort *	myTargetListPort
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
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	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
bool	myFirstTick
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
bool	myTickEveryFrame
makVrf::DtTaskVisualizationMap	myTaskVisualizations
double	myNextTaskVisTickTime
DtSymbolString	myFullComponentName
DtSimulationServices *	mySimServices
DtPredicateCallbackManager	myPredicateCallbackManager
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 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 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

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

Parameters

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

virtual DtWeaponController::~DtWeaponController ( )

virtual

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

virtual

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

Returns

DtWeaponControllerType

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController, and DtVerticalLauncherController.

virtual bool DtWeaponController::createMountingController ( )

virtual

Overridden to create a DtMountingController.

Reimplemented from DtBaseWeaponController.

virtual bool DtWeaponController::init ( )

virtual

Overridden to initialize values obtained from the descriptor.

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual void DtWeaponController::preFirstTickInit ( )

virtual

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

Reimplemented from DtBaseWeaponController.

Reimplemented in DtLauncherController.

virtual void DtWeaponController::tick ( )

virtual

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

virtual

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 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 void DtWeaponController::maneuverRequiredToAcquireTarget ( DtReal  requiredHeading, DtReal  requiredPitch, DtReal  requiredMaxSpeed  )

virtual

Not implemented in this class. Subclasses should implement this method to tie into their entity maneuver controllers to maneuver their vehicle to line up for a shot.

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 = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

Parameters

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

Returns

New instance of this class.

virtual void DtWeaponController::enable ( )

virtual

Is this component enabled or not. If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

Reimplemented from DtSimComponent.

virtual void DtWeaponController::disable ( )

virtual

Is this component enabled or not. If enabled, component's tick function will be called, otherwise it will not. Default is true (enabled).

Reimplemented from DtSimComponent.

virtual bool DtWeaponController::createPorts ( )

protectedvirtual

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.

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

protected

assignment operator; not implemented

Member Data Documentation

DtUUID DtWeaponController::myCurrentTarget

protected

DtEntityListInputPort* DtWeaponController::myTargetListPort

protected

Input Port Name: target-list
Input Port Description: List of targets detected.
Input Port Range:
Input Port Default Value:
Input Group Parent:

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

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

protected

double DtWeaponController::myMaxMunitionEffectiveRange

protected

---

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

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