DtBaseWeaponController Class Reference

DtBaseWeaponController is a controller that creates the ports needed to choose ammo for, load, and trigger a weapon (a DtWeaponActuator). More...

Inheritance diagram for DtBaseWeaponController:

Public Member Functions
	DtBaseWeaponController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtBaseWeaponController ()
	destructor
virtual bool	init ()
	Overridden to initialize values obtained from the descriptor.
virtual bool	postAddComponentsInit ()
	Override to call lookupAndCacheProcessSR() (another component creates it - we just look it up and keep a pointer to it).
virtual bool	createMountingController ()
	Creates myBaseMountingController.
virtual const char *	type () const
	Returns a string identifies the class type of component.
virtual void	fire ()
	fires the weapon
virtual bool	waitingForFire ()
	Returns true if the trigger has been set but the actuator has not yet fired.
virtual void	setWaitingForFire (bool waiting)
	Sets myWaitingForFire.
virtual bool	createWeaponOutputPortGroup ()
	Initializes myWeaponOutputPortGroup.
virtual DtOutputPortGroup *	weaponOutputPortGroup ()
	Returns myWeaponOutputPortGroup.
virtual bool	createWeaponInputPortGroup ()
	Initializes myWeaponInputPortGroup.
virtual DtInputPortGroup *	weaponInputPortGroup ()
	Returns myWeaponInputPortGroup.
virtual bool	createTriggerPort ()
	These are called in init to create the ports used to communicate with the actuator.
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)
	If setPreloadWeapon to true, the loader will load the first munition from the ammoselect table if there is no target.
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)
	Some vehicles must stop to shoot, others have a maximum speed to launch a munition.
virtual DtReal	maxVehicleSpeedToFire () const
virtual bool	weaponCorrectlyOriented () const
virtual void	setMaxAngleOffBoresight (DtReal maxAngleOffBoresight)
	Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target.
virtual DtReal	maxAngleOffBoresight () const
virtual void	initProcessSR ()
	Sets the load & unload ammo time from the component descriptor.
virtual DtBaseMountingController *	mountingController ()
	returns the DtBaseMountingController
virtual void	setCurrentMunitionName (const DtString &currentMunitionName)
	sets the current munition name in the DtVrfWeaponPSR
virtual const DtString &	currentMunitionName () const
	gets the current munition name from the DtVrfWeaponPSR
virtual DtVrfWeaponPSR *	weaponProcessState ()
	Returns the DtVrfWeaponPSR.
virtual const DtVrfWeaponPSR *	weaponProcessState () const
	Returns the DtVrfWeaponPSR.
virtual void	tick ()
	Sets the current dT on the base mounting controller and ticks it.
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	preFirstTickInit ()
	This function can be overridden to initialize a component before it is ticked for the first time.
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 (FILE *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 void	enable ()
	Is this component enabled or not.
virtual void	disable ()
	Is this component enabled or not.
virtual bool	isEnabled ()
	Is this component enabled or not.
virtual void	setIsEnabled (bool yesNo)
	Is this component enabled or not.
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 (FILE *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 (FILE *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.
virtual 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)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
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)
	The variable name, if this object is a variable reference.
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 ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
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 ()
	Collection of child DtReaderWriter nodes owned by this object.
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	createPortGroups ()
	Overridden to add port groups from myBaseMountingController, allowing OPD connections to be specified using the name of this component.
virtual bool	createPorts ()
	Overridden to create input & output ports.
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 myWeaponProcessState.
	DtBaseWeaponController ()
	default constructor; not implemented
	DtBaseWeaponController (const DtBaseWeaponController &orig)
	copy constructor; not implemented
const DtBaseWeaponController &	operator= (const DtBaseWeaponController &orig)
	assignment operator; 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.
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
bool	myDoWeaponPreload
	If myDoWeaponPreload is true, the loader will load the first munition from the ammoselect table if there is no target.
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).
DtReal	myFireMaxVehicleSpeed
	Some vehicles must stop to shoot, others have a maximum speed to launch a munition.
DtReal	myMaxAngleOffBoresight
const DtBaseWeaponControllerDescriptor *	myBaseWeaponCtlrDesc
	Get ammo select tables from here.
DtBaseMountingController *	myBaseMountingController
DtVrfWeaponPSR *	myWeaponProcessState
	Pointer to a process state repository used to store state data associated with this component.
Ports and Port Groups
DtOutputPortGroup *	myWeaponOutputPortGroup
	Output Port Group Name: weapon-control Output Port Group Description:
DtAmmunitionOutputPort *	myLoadAmmunitionPort
	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 *	myTriggerPort
	Output Port Name: trigger Output Port Description: True to fire.
DtBooleanOutputPort *	myLoadedPort
	Output Port Name: loaded Output Port Description: True if loaded.
DtInputPortGroup *	myWeaponInputPortGroup
	Input Port Group Name: weapon-info Input Port Group Description:
DtIntegerInputPort *	myArtPartTypePort
	Input Port Name: art-part-type Input Port Description: Type of articulated part.
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.
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.

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

DtBaseWeaponController is a controller that creates the ports needed to choose ammo for, load, and trigger a weapon (a DtWeaponActuator).

Uses Descriptor Type: DtBaseWeaponControllerDescriptor

Constructor & Destructor Documentation

DtBaseWeaponController::DtBaseWeaponController	(	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 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 DtWeaponController, DtLauncherController, 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 DtSimComponent.

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::setMaxAngleOffBoresight ( DtReal  maxAngleOffBoresight )

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. This margin is used in both azimuth and elevation.

virtual DtReal DtBaseWeaponController::maxAngleOffBoresight ( ) const

virtual

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, 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 DtWeaponController, DtLauncherController, DtIndirectFireWeaponController, and DtVerticalLauncherController.

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.

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::myMaxAngleOffBoresight

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

---

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

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