DtBallisticGunController Class Reference

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:

Public Member Functions
	DtBallisticGunController (const DtString &name, DtLocalObject *owner, DtSimulationServices *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtBallisticGunController ()
virtual bool	postAddComponentsInit ()
virtual const char *	type () const
virtual bool	init ()
virtual void	preFirstTickInit ()
virtual void	tick ()
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)
virtual bool	checkCurrentAmmo (int &ammoAvailable)
virtual bool	ammoOKToUse (const DtEntityType &targetType)
virtual void	initProcessSR ()
virtual void	enable ()
virtual void	disable ()
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 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 bool	createPortGroups ()
virtual void	lookupAndCacheProcessSR ()
virtual DtIntegerResource *	lookupMunitionResource (const DtString &resource) const
void	getMunitionResources (std::list< DtString > &resourceList)
virtual void	updateResourceList ()
virtual bool	weaponsHoldState ()
bool	outOfAmmo () const
	DtBallisticGunController ()
	DtBallisticGunController (const DtBallisticGunController &orig)
const DtBallisticGunController &	operator= (const DtBallisticGunController &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	myPreviousTarget
DtSimMunition	myCurrentMunition
DtDetonatorFuze	myCurrentFuze
int	myRoundsAvailable
DtVrfBalGunPSR *	myProcessState
const DtBallisticGunControllerDescriptor *	myGunDescriptor
bool	myWaitingForFire
bool	myOutOfAmmoWarn
DtWeaponComponentInterface *	myWeaponComponentInterface
Ports and Port Groups
DtIntegerInputPort *	myLosInputPort
DtBooleanOutputPort *	myTriggerPort
DtIntegerOutputPort *	myQuantityOutputPort
DtBooleanOutputPort *	myLoadedPort
DtIntegerOutputPort *	myLosOutputPort
DtOutputPortGroup *	myGunControlPortGroup
DtBooleanInputPort *	myWeaponsHoldInputPort
DtEntityListOutputPort *	myTargetToAcquireOutputPort
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
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 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

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

virtual

destructor

DtBallisticGunController::DtBallisticGunController ( )

protected

Not implemented.

DtBallisticGunController::DtBallisticGunController ( const DtBallisticGunController &  orig )

protected

Not implemented.

Member Function Documentation

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

DtBallisticGunControllerType

Implements DtControllerComponent.

Reimplemented in DtBallisticGunJoyController.

virtual bool DtBallisticGunController::init ( )

virtual

Sets up weapon component interface.

Reimplemented from DtControllerComponent.

virtual void DtBallisticGunController::preFirstTickInit ( )

virtual

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

virtual

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  )

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

protectedvirtual

Called by init to create the output ports.

Reimplemented from DtSimComponent.

Reimplemented in DtBallisticGunJoyController.

virtual bool DtBallisticGunController::createPortGroups ( )

protectedvirtual

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

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

protected

Not implemented.

Member Data Documentation

DtIntegerInputPort* DtBallisticGunController::myLosInputPort

protected

Input Port Name: line-of-sight
Input Port Description: Indicates the result of a line of sight calculation to the current target.
Input Port Range: 0 = Unknown, 1 = Blocked, 2 = Clear
Input Port Default Value:
Input Group Parent:

DtBooleanOutputPort* DtBallisticGunController::myTriggerPort

protected

Output Port Name: trigger
Output Port Description: Sends a new True value when trigger is pulled.
Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control.

DtIntegerOutputPort* DtBallisticGunController::myQuantityOutputPort

protected

Output Port Name: quantity
Output Port Description: Sends the number of rounds to be fired with a single trigger pull.
Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control.

DtBooleanOutputPort* DtBallisticGunController::myLoadedPort

protected

Output Port Name: loaded
Output Port Description: True when the gun is loaded.
Output Port Range:
Output Port Default Value:
Output Group Parent: gun-control.

DtIntegerOutputPort* DtBallisticGunController::myLosOutputPort

protected

Output Port Name: line-of-sight
Output Port Description: Indicates the result of a line of sight calculation to the current target.
Output Port Range: 0 = Unkown, 1 = Blocked, 2 = Clear
Output Port Default Value:
Output Group Parent: gun-control.

DtOutputPortGroup* DtBallisticGunController::myGunControlPortGroup

protected

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

DtBooleanInputPort* DtBallisticGunController::myWeaponsHoldInputPort

protected

Input Port Name: weapons-hold
Input Port Description: When true, all firing 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
.

DtEntityListOutputPort* DtBallisticGunController::myTargetToAcquireOutputPort

protected

Output Port Name: target-to-acquire
Output Port Description: When there is a target in the weapon interface, it is put onto this output port.
.

DtUUID DtBallisticGunController::myPreviousTarget

protected

Maintain the target we had last tick (if any) to detect changes in target (which will kick off possible ammo reload.

DtSimMunition DtBallisticGunController::myCurrentMunition

protected

The correct munition and fuze for our current target.

DtDetonatorFuze DtBallisticGunController::myCurrentFuze

protected

int DtBallisticGunController::myRoundsAvailable

protected

The quantity of the current munition in the resources store.

DtVrfBalGunPSR* DtBallisticGunController::myProcessState

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

const DtBallisticGunControllerDescriptor* DtBallisticGunController::myGunDescriptor

protected

Get ammo select tables from here.

bool DtBallisticGunController::myWaitingForFire

protected

This flag is set to true when the controller pulls the trigger; it won't do anything in the tick function when this is true until PSR indicates hasFired and timeFiringCycleComplete(). The actuator sets up the latter two conditions when it fires the gun. When these conditions are true, then the controller resets myWaitingForFire.

bool DtBallisticGunController::myOutOfAmmoWarn

protected

Flag so an out-of-ammo warning is only sent once per target.

DtWeaponComponentInterface* DtBallisticGunController::myWeaponComponentInterface

protected

Interface between this weapon controller and the entity's DtTargetSelectionController.

---

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

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