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=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtBaseWeaponController ()
virtual bool	init ()
virtual bool	postAddComponentsInit ()
virtual bool	createMountingController ()
virtual const char *	type () const
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	setCurrentMunitionName (const DtString &currentMunitionName)
virtual const DtString &	currentMunitionName () const
virtual DtVrfWeaponPSR *	weaponProcessState ()
virtual const DtVrfWeaponPSR *	weaponProcessState () const
virtual void	tick ()
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 void	enable ()
virtual void	disable ()
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 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 ()
virtual bool	createPorts ()
virtual void	lookupAndCacheProcessSR ()
virtual void	preFirstTickInit ()
	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
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
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

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

virtual

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

virtual

Overridden to initialize values obtained from the descriptor.

Reimplemented from DtControllerComponent.

Reimplemented in DtLauncherController, DtWeaponController, and DtIndirectFireWeaponController.

virtual bool DtBaseWeaponController::postAddComponentsInit ( )

virtual

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

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

DtBaseWeaponControllerType

Implements DtControllerComponent.

Reimplemented in DtLauncherController, DtWeaponController, DtIndirectFireWeaponController, 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::setCurrentMunitionName ( const DtString &  currentMunitionName )

virtual

sets the current munition name in the DtVrfWeaponPSR

virtual const DtString& DtBaseWeaponController::currentMunitionName ( ) 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 ( )

virtual

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 = 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 bool DtBaseWeaponController::createPortGroups ( )

protectedvirtual

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

protectedvirtual

Overridden to create input & output ports.

Reimplemented from DtSimComponent.

Reimplemented in DtWeaponController, DtLauncherController, and DtIndirectFireWeaponController.

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 procSRTypes.h. Another component is responsible for creating and destroying the process state repository.

Reimplemented in DtIndirectFireWeaponController.

virtual void DtBaseWeaponController::preFirstTickInit ( )

protectedvirtual

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.

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.

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-0-branch/include/vrfmodel/baseWeaponController.h