DtBallisticGunJoy Class Reference

DtBallisticGunJoy extends the DtBallisticGun actuator class with the ability to be controlled from a joystick. More...

Inheritance diagram for DtBallisticGunJoy:

Public Member Functions
	DtBallisticGunJoy (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc, DtReaderWriterRegistry *const parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtBallisticGunJoy ()
	destructor
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual bool	createPorts ()
	Creates myElevationPort.
virtual void	setComponentDescriptor (DtComponentDescriptor *descriptor)
	Override so we can extract the values we want and set our pointer.
virtual void	tick ()
	Fire and detonate.
virtual DtReal	setTarget (DtArticulatedPartStateRepository *rotBody)
virtual DtFireInteraction *	manualFireInteraction (DtArticulatedPartStateRepository *rotBody)
virtual DtDetonationInteraction *	manualDetonationInteraction (DtArticulatedPartStateRepository *rotBody, DtReal &detTime, DtReal dist)
virtual DtVrfObject *	targetSelection (DtArticulatedPartStateRepository *rotBody, DtReal &dist)
virtual DtReal	distanceToTarget ()
Public Member Functions inherited from DtBallisticGun
	DtBallisticGun (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtBallisticGun ()
	destructor
virtual bool	init ()
	Overridden to cache a pointer to the entity's radio in this class.
virtual void	initPendingDetonations ()
	Called in the first tick.
virtual void	preFirstTickInit ()
	Calls initPendingDetonations.
virtual bool	checkHitProbability (const DtEntityType &type, DtReal range)
	Returns true if we hit the target, false otherwise.
virtual double	hitProbabilityModifier (const DtEntityType &type, DtReal range)
	Override this function to dynamically change the probability of a hit based on factors such as current speed, weather conditions, etc.
virtual DtFireInteraction *	createFireInteraction ()
	Allocates a DtFireInteraction and then uses the munition information specified on the munition and fuze ports, as well as the current target reported by the entity, to fill in the necessary fields.
virtual DtDetonationInteraction *	createDetonationInteraction (DtTime &detTime, bool assureMiss=false)
	Allocates a DtDetonationInteraction.
virtual void	scheduleDetonation (DtDetonationInteraction *detInter, DtTime detTime)
	Schedules the sending of the DtDetonationInteraction passed as the first argument at a point in the future specified by the second argument, using the DtScheduler facility (which is accessed through the DtSimManager).
virtual DtString	probabilityString () const
virtual DtVector	calculateMuzzlePosition () const
	Finds the correct muzzle placement for the gun.
virtual DtDetonationInteraction *	createDetonationInteraction (const DtDetonationDescriptor &desc, DtTime &detTime)
	Creates a new DtDetonationInteraction, given a DtDetonationDescriptor.
virtual DtDetonationDescriptor *	createDetonationDescriptor (DtDetonationInteraction *detInter, DtTime simTime)
	Creates and fills out a new DtDetonationDescriptor, given a DtDetonationInteraction and a time (simulation time to fire, in seconds).
Public Member Functions inherited from DtActuatorComponent
virtual	~DtActuatorComponent ()
	destructor
virtual DtSimBaseRadio *	radio ()
virtual bool	tickWhileDestroyed () const
	By default, all actuators tick when the entity is destroyed.
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 bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
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 (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 DtFilename &searchPath, 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 const DtComponentDescriptor *	componentDescriptor () const
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
virtual DtOutputStream &	objectConsoleVerbose () const
virtual DtOutputStream &	objectConsoleInfo () const
virtual DtOutputStream &	objectConsoleWarn () const
virtual DtOutputStream &	objectConsoleError () 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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static void	detonationCallback (DtTimer *timer)
	Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object.
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Static Public Member Functions inherited from DtBallisticGun
static void	objectAddedCb (DtVrfObject *vrfObject, void *usr)
	Calls processObjectAdded().

Protected Attributes
Ports and Port Groups
DtConstrainedAnalogInputPort *	myElevationPort
	Input Port Name: elevation Input Port Description: Input Port Range: -1.
DtBooleanInputPort *	myActiveJoystickPort
	Input Port Name: joystick-active Input Port Description: Input Port Range: Input Port Default Value: Input Group Parent: gun-control.
Protected Attributes inherited from DtBallisticGun
DtBallisticGunDescriptor *	myBalGunDescriptor
DtEntityIdentifier	myObjectId
DtReal	myMuzzleSpeed
DtVector	myMuzzleOffset
DtVrfObject *	myCurrentTarget
	These are set by createFireInteraction and used by createDetonationInteraction.
DtEventId	myCurrentEventId
DtReal	myCurrentRange
DtList	myTimerList
DtArtPartType	myGunArtPart
DtVrfBalGunPSR *	myProcessState
	Container for state data associated with this component.
DtInputPortGroup *	myBalGunControlPortGroup
	Input Port Group Name: gun-control Input Port Group Description:
DtBooleanInputPort *	myTriggerPort
	Input Port Name: trigger Input Port Description: Edge-triggered input which fires a round whenever a new True arrives on the port.
DtIntegerInputPort *	myQuantityInputPort
	Input Port Name: quantity Input Port Description: Indicates the number of rounds to be fired with a single trigger pull.
DtBooleanInputPort *	myLoadedPort
	Input Port Name: loaded Input Port Description: Must be True for gun to fire.
DtIntegerInputPort *	myLosPort
	Input Port Name: line-of-sight Input Port Description: Indicates the result of a line of sight calculation to the current target.
Protected Attributes inherited from DtActuatorComponent
DtSimBaseRadio *	myRadio
	Actuators 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.
const DtComponentDescriptor *	myComponentDescriptor
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

Private Member Functions
	DtBallisticGunJoy ()
	Default constructor; should not be called.
	DtBallisticGunJoy (const DtBallisticGunJoy &orig)
	copy constructor; shallow copy - timers not copied
const DtBallisticGunJoy &	operator= (const DtBallisticGunJoy &orig)
	assignment operator; see comments on copy constructor!

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::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
Protected Member Functions inherited from DtBallisticGun
virtual bool	createPortGroups ()
	Overridden to create local port groups.
virtual bool	createPSR ()
	Creates myProcessState data member, and adds it to our process state repository manager.
virtual void	processObjectAdded (DtVrfObject *vrfObject)
	Checks pending detonation list (in the process state repository) for target with same name as new object.
virtual void	addRangeItems ()
	Adds all items that have a range to the object state repository.
	DtBallisticGun ()
	default constructor; not implemented
	DtBallisticGun (const DtBallisticGun &orig)
	copy constructor; not implemented
const DtBallisticGun &	operator= (const DtBallisticGun &orig)
	assignment operator; not implemented
Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	myFactory

Detailed Description

DtBallisticGunJoy extends the DtBallisticGun actuator class with the ability to be controlled from a joystick.

Uses Descriptor Type: DtBallisticGunDescriptor

Constructor & Destructor Documentation

DtBallisticGunJoy::DtBallisticGunJoy	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *const	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 DtBallisticGunJoy::~DtBallisticGunJoy ( )

virtual

destructor

DtBallisticGunJoy::DtBallisticGunJoy ( )

private

Default constructor; should not be called.

Here because the compiler will generate an unprotected one otherwise.

DtBallisticGunJoy::DtBallisticGunJoy ( const DtBallisticGunJoy &  orig )

private

copy constructor; shallow copy - timers not copied

Member Function Documentation

virtual DtString DtBallisticGunJoy::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.

Returns

DtBallisticGunJoyActuatorType

Reimplemented from DtBallisticGun.

virtual bool DtBallisticGunJoy::createPorts ( )

virtual

Creates myElevationPort.

Reimplemented from DtBallisticGun.

virtual void DtBallisticGunJoy::setComponentDescriptor ( DtComponentDescriptor *  descriptor )

virtual

Override so we can extract the values we want and set our pointer.

Calls down to the base class's set.

Reimplemented from DtSimComponent.

virtual void DtBallisticGunJoy::tick ( )

virtual

Fire and detonate.

It detects if we need to use local or parent function depending on joystick enable/disable state

Reimplemented from DtBallisticGun.

virtual DtReal DtBallisticGunJoy::setTarget ( DtArticulatedPartStateRepository *  rotBody )

virtual

virtual DtFireInteraction* DtBallisticGunJoy::manualFireInteraction ( DtArticulatedPartStateRepository *  rotBody )

virtual

virtual DtDetonationInteraction* DtBallisticGunJoy::manualDetonationInteraction ( DtArticulatedPartStateRepository *  rotBody, DtReal &  detTime, DtReal  dist  )

virtual

virtual DtVrfObject* DtBallisticGunJoy::targetSelection ( DtArticulatedPartStateRepository *  rotBody, DtReal &  dist  )

virtual

virtual DtReal DtBallisticGunJoy::distanceToTarget ( )

virtual

static void DtBallisticGunJoy::detonationCallback ( DtTimer *  timer )

static

Casts the user data portion of the DtTimer passed to it to a DtDetonationTimerData object.

It then uses the pointer to the Simulation Manager provided in the DtDetonationTimerData to get a pointer to the DtExerciseConn, and sends the DtDetonationInteraction which is also in the DtDetonationTimerData object via the exercise connection. The timer is removed from the scheduler, and the DtDetonationTimerData and DtDetonationInteraction objects are deleted.

Reimplemented from DtBallisticGun.

static DtSimComponent* DtBallisticGunJoy::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 from DtBallisticGun.

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

private

assignment operator; see comments on copy constructor!

Member Data Documentation

DtConstrainedAnalogInputPort* DtBallisticGunJoy::myElevationPort

protected

Input Port Name: elevation
Input Port Description:
Input Port Range: -1.

to 1.
Input Port Default Value:
Input Group Parent: gun-control

DtBooleanInputPort* DtBallisticGunJoy::myActiveJoystickPort

protected

Input Port Name: joystick-active
Input Port Description:
Input Port Range:
Input Port Default Value:
Input Group Parent: gun-control.

---

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

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