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

Inheritance diagram for DtBallisticGunController:

[legend]

Public Member Functions
	DtBallisticGunController (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,
virtual	~DtBallisticGunController ()
	destructor
virtual bool	postAddComponentsInit ()
	Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it).
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual bool	init ()
	Sets up weapon component interface.
virtual void	preFirstTickInit ()
	Restores the checkpointed values of myCurrentMunition and myCurrentFuze from the the munition loader of the DtVrfBalGunPSR.
virtual void	tick ()
	Calculate new control values.
virtual bool	createTriggerPort ()
	These are called in init to create the ports used to communicate with the actuator.
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 ()
	Sets myTriggerPort to true and myLoaded to false.
virtual bool	chooseAmmo (const DtEntityType &targetType, const DtUUID &target, DtSimMunition &munition, DtDetonatorFuze &fuze, int &ammoAvailable)
	The chooseAmmo() function is passed a pointer to a target entity and returns the best ammunition to use for the target�s entity type.
virtual bool	ammoOKToUse (const DtEntityType &targetType)
	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	initProcessSR ()
	Sets the load & unload ammo time from the component descriptor.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (std::string &fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	enable ()
	Is this component enabled or not.
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 DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject owner, DtSimManager simManager, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)
	(const DtString&,DtVrfObject,DtSimManager,

Protected Member Functions
virtual bool	createPorts ()
	Called by init to create the output ports.
virtual bool	createPortGroups ()
	Called by init to create myGunControlPortGroup.
virtual void	lookupAndCacheProcessSR ()
	This function looks up a process state repository in the process state repository manager by name, and caches a pointer to it in myProcessState.
virtual DtIntegerResource *	lookupMunitionResource (const DtString &resource) const
	Attempts to locate the given resource in the entity's state repository, and if it is a DtMunitionResource, it will be returned.
void	getMunitionResources (std::list< DtString > &resourceList)
	Get the resources for.
virtual void	updateResourceList ()
	Go through the resource list and remove any with amounts = 0.
virtual bool	weaponsHoldState ()
	DtBallisticGunController ()
	Not implemented.
	DtBallisticGunController (const DtBallisticGunController &orig)
	Not implemented.
const DtBallisticGunController &	operator= (const DtBallisticGunController &orig)
	Not implemented.
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	setRadio (DtSimRadio *radio)
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtUUID	myPreviousTarget
	Maintain the target we had last tick (if any) to detect changes in target (which will kick off possible ammo reload.
DtSimMunition	myCurrentMunition
	The correct munition and fuze for our current target.
DtDetonatorFuze	myCurrentFuze
int	myRoundsAvailable
	The quantity of the current munition in the resources store.
DtVrfBalGunPSR *	myProcessState
	Pointer to a process state repository used to store state data associated with this component.
const DtBallisticGunControllerDescriptor *	myGunDescriptor
	Get ammo select tables from here.
bool	myWaitingForFire
	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).
bool	myOutOfAmmoWarn
	Flag so an out-of-ammo warning is only sent once per target.
DtWeaponComponentInterface *	myWeaponComponentInterface
	Interface between this weapon controller and the entity's DtTargetSelectionController.
Ports and Port Groups
DtIntegerInputPort *	myLosInputPort
	Input Port Name: line-of-sight Input Port Description: Indicates the result of a line of sight calculation to the current target.
DtBooleanOutputPort *	myTriggerPort
	Output Port Name: trigger Output Port Description: Sends a new True value when trigger is pulled.
DtIntegerOutputPort *	myQuantityOutputPort
	Output Port Name: quantity Output Port Description: Sends the number of rounds to be fired with a single trigger pull.
DtBooleanOutputPort *	myLoadedPort
	Output Port Name: loaded Output Port Description: True when the gun is loaded.
DtIntegerOutputPort *	myLosOutputPort
	Output Port Name: line-of-sight Output Port Description: Indicates the result of a line of sight calculation to the current target.
DtOutputPortGroup *	myGunControlPortGroup
	Output Port Group Name: gun-control Output Port Group Description:
DtBooleanInputPort *	myWeaponsHoldInputPort
	Input Port Name: weapons-hold Input Port Description: When true, all firing is disabled.
DtEntityListOutputPort *	myTargetToAcquireOutputPort
	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.
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false.
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component.
double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
virtual DtReaderWriter *	provideRoundsPerTriggerPull ()
static DtReaderWriter *	roundsPerTriggerPullCallback (void *ctrlr)
	Access provider callbacks.
virtual void	processSetResource (DtSimMessage *msg)
static void	setResourceCallback (DtSimMessage msg, void usrData)
	A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.
virtual void	processSetRestore (DtSimMessage *msg)
static void	setRestoreCallback (DtSimMessage msg, void usrData)
	A callback to updateResourceList() when resources are changed, just in case ammo is cleared or restored.

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

Detailed Description

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

Constructor & Destructor Documentation

DtBallisticGunController::DtBallisticGunController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

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

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::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,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns: New instance of this class.

Reimplemented in DtBallisticGunJoyController.

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

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

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

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, and set back to false when the controllers sees that the loaded munition has been unloaded (by the gun).

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/ballisticGunController.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation