DtVrfTurretedBalGunPSR Class Reference

File: turBalGunPSR.h. More...

Inheritance diagram for DtVrfTurretedBalGunPSR:

Public Member Functions
	DtVrfTurretedBalGunPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfTurretedBalGunPSR (const DtVrfTurretedBalGunPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfTurretedBalGunPSR &	operator= (const DtVrfTurretedBalGunPSR &orig)
virtual	~DtVrfTurretedBalGunPSR ()
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual double	maxSlewRate () const
	Get the maximum rate at which this turret can slew.
virtual void	setMaxSlewRate (double maxSlewRate)
	Set the maximum rate at which this turret can slew.
virtual bool	clockwise () const
	Are we currently scanning clockwise (or counterclockwise?)
virtual void	setClockwise (bool clockwise)
virtual bool	cannotAcquireTarget () const
	Set to true when there is no LOS to a target.
virtual void	setCannotAcquireTarget (bool cannotAcquire)
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual DtArtPartType	turretArtPart () const
	Get the art part number for the turret we're associated with.
virtual void	setTurretArtPart (DtArtPartType turretArtPart)
	Get the art part number for the turret we're associated with.
Public Member Functions inherited from DtVrfBalGunPSR
	DtVrfBalGunPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfBalGunPSR (const DtVrfBalGunPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfBalGunPSR &	operator= (const DtVrfBalGunPSR &orig)
virtual	~DtVrfBalGunPSR ()
virtual const DtDetonationDescriptorList &	pendingDetonations () const
	Get list of pending detonations.
virtual void	addPendingDetonation (DtDetonationDescriptor *desc)
	Add a new pending detonation.
virtual void	removePendingDetonation (const DtEventId &eventId)
	Remove a particular pending detonation.
virtual void	setFiringCycleCompleteTime (DtTime completeTime)
	Update the time that the firing cycle will be complete.
virtual DtTime	timeFiringCycleComplete () const
	Access firing cycle complete time.
virtual void	setDisplayName (const DtString &displayName)
virtual const DtString	displayName () const
virtual void	setCommandedToFire ()
	Change and test functions for fire state.
virtual bool	isCommandedToFire ()
	Change and test functions for fire state.
virtual void	setHasFired ()
	Change and test functions for fire state.
virtual bool	hasFired ()
	Change and test functions for fire state.
virtual void	setNextFireEventTime (const double time)
	Functions relating to the distribution of a burst of automatic fire over multiple fire/detonation events.
virtual double	nextFireEventTime () const
	Functions relating to the distribution of a burst of automatic fire over multiple fire/detonation events.
virtual void	setBurstRoundsRemaining (const int rounds)
	Member functions for burst rounds remaining.
virtual int	burstRoundsRemaining () const
	Member functions for burst rounds remaining.
virtual void	setFiringTracers ()
	Member functions indicating whether the gun is firing tracers.
virtual void	setNotFiringTracers ()
	Member functions indicating whether the gun is firing tracers.
virtual bool	isFiringTracers () const
	Member functions indicating whether the gun is firing tracers.
virtual bool	isFiringTracersSpecified () const
	Member functions indicating whether the gun is firing tracers.
virtual DtArtPartType	gunArtPart () const
	Get the art part number for the gun we're associated with.
virtual void	setGunArtPart (DtArtPartType gunArtPart)
	Get the art part number for the gun we're associated with.
virtual DtBaseWeaponComponentInterface *	weaponInterface () const
	TODO Accessors for turret art part.
virtual void	setWeaponInterface (DtBaseWeaponComponentInterface *weapon)
	TODO Accessors for turret art part.
Public Member Functions inherited from DtVrfWeaponPSR
	DtVrfWeaponPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfWeaponPSR (const DtVrfWeaponPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfWeaponPSR &	operator= (const DtVrfWeaponPSR &orig)
virtual	~DtVrfWeaponPSR ()
virtual void	setCurrentTarget (const DtEntityIdentifier &target, bool targetOverride=false)
	These two are provided for backward compatibility.
virtual void	setUserTargetOverride (bool userTargetOverride)
	Sets the user target override for the next target detection period.
virtual bool	userTargetOverride () const
virtual void	setCurrentTarget (const DtUUID &, bool targetOverride=false)
	The target this weapon is currently attacking Was: setCurrentTargetName.
virtual const DtRwVrfObjectReference &	currentTarget () const
	Was: currentTargetName.
virtual DtRwVrfObjectReference &	currentTarget ()
virtual const DtVrfMunitionLoader &	munitionLoader () const
	The munitionLoader manages loading and unloading timers.
virtual DtVrfMunitionLoader &	munitionLoader ()
virtual void	setCurrentMunitionName (const DtString &currentMunitionName)
	Sets the name of the current munition.
virtual const DtString &	currentMunitionName () const
	Returns the name of the current munition.
virtual bool	targetAcquired () const
	Do I have the target in my sights, ready to be fired upon?
virtual void	setTargetAcquired (bool targetAcquired)
virtual bool	weaponAimed () const
	Is the weapon aimed at the correct location?
virtual void	setWeaponAimed (bool aimed)
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	init ()
	Used for virtual construction. This base method simply returns true.
virtual bool	loadedFromMTL () const
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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 DtVrfProcessStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Create an instance of a DtVrfWeaponPSR.

Protected Member Functions
	DtVrfTurretedBalGunPSR ()
Protected Member Functions inherited from DtVrfBalGunPSR
	DtVrfBalGunPSR ()
Protected Member Functions inherited from DtVrfWeaponPSR
	DtVrfWeaponPSR ()
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
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 Attributes
double	myMaxSlewRate
	Maximum rate at which this turret can slew.
int	myTurretArtPart
	The art part number for the turret we're associated with.
DtRwBoolean	myClockwiseFlag
	Are we currently scanning clockwise (or counterclockwise?)
DtRwBoolean	myCannotAcquireTarget
Protected Attributes inherited from DtVrfBalGunPSR
DtDetonationDescriptorList	myPendingDetonations
	List of DtDetonationDescriptors, used to save/restore information about pending scheduled detonations.
DtRwInt	myFireState
	State describing the gun; for communication between the controller and actuator.
DtRwReal	myFireCycleCompleteTime
	The time at which the gun firing cycle is complete.
DtRwString	myDisplayName
DtRwBoolean	myFiringTracers
	A flag that indicates if the gun is firing tracer rounds (mixed with ball)
int	myGunArtPart
	The art part number for the gun we're associated with.
DtBaseWeaponComponentInterface *	myWeaponInterface
	The weapon control interface for this gun, if it exists.
DtRwReal	myNextFireEventTime
	State variables for bursts with multiple detonations.
DtRwInt	myBurstRoundsRemaining
	The number of rounds left in the burst, yet to process in fire events.
Protected Attributes inherited from DtVrfWeaponPSR
DtRwBoolean	myTargetAcquired
DtRwVrfObjectReference	myCurrentTarget
DtRwBoolean	myUserTargetOverride
DtRwString	myCurrentMunitionName
DtVrfMunitionLoader	myMunitionLoader
DtRwBoolean	myWeaponAimed
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
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 DtVrfBalGunPSR
enum	FireState { CommandedToFire, HasFired }
	State describing the gun. More...
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

File: turBalGunPSR.h.

Class: DtVrfTurretedBalGunPSRHolds shared and/or checkpointable data needed for the processes of a combined turret/gun weapon system

Constructor & Destructor Documentation

DtVrfTurretedBalGunPSR::DtVrfTurretedBalGunPSR ( )

protected

DtVrfTurretedBalGunPSR::DtVrfTurretedBalGunPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtVrfTurretedBalGunPSR::DtVrfTurretedBalGunPSR	(	const DtVrfTurretedBalGunPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtVrfTurretedBalGunPSR::~DtVrfTurretedBalGunPSR ( )

virtual

Member Function Documentation

const DtVrfTurretedBalGunPSR& DtVrfTurretedBalGunPSR::operator=

(

const DtVrfTurretedBalGunPSR &

orig

)

virtual DtVrfProcessStateRepository* DtVrfTurretedBalGunPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

Reimplemented from DtVrfBalGunPSR.

virtual double DtVrfTurretedBalGunPSR::maxSlewRate ( ) const

virtual

Get the maximum rate at which this turret can slew.

virtual void DtVrfTurretedBalGunPSR::setMaxSlewRate ( double  maxSlewRate )

virtual

Set the maximum rate at which this turret can slew.

virtual DtArtPartType DtVrfTurretedBalGunPSR::turretArtPart ( ) const

virtual

Get the art part number for the turret we're associated with.

virtual void DtVrfTurretedBalGunPSR::setTurretArtPart ( DtArtPartType  turretArtPart )

virtual

Get the art part number for the turret we're associated with.

virtual bool DtVrfTurretedBalGunPSR::clockwise ( ) const

virtual

Are we currently scanning clockwise (or counterclockwise?)

virtual void DtVrfTurretedBalGunPSR::setClockwise ( bool  clockwise )

virtual

virtual bool DtVrfTurretedBalGunPSR::cannotAcquireTarget ( ) const

virtual

Set to true when there is no LOS to a target.

virtual void DtVrfTurretedBalGunPSR::setCannotAcquireTarget ( bool  cannotAcquire )

virtual

virtual DtString DtVrfTurretedBalGunPSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

Reimplemented from DtVrfBalGunPSR.

static DtVrfProcessStateRepository* DtVrfTurretedBalGunPSR::creator ( const DtString &  name, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Create an instance of a DtVrfWeaponPSR.

Reimplemented from DtVrfBalGunPSR.

Member Data Documentation

double DtVrfTurretedBalGunPSR::myMaxSlewRate

protected

Maximum rate at which this turret can slew.

Note

This value is not saved to the OOB file. It is reset at runtime by the .ope file when the scenario is loaded.

int DtVrfTurretedBalGunPSR::myTurretArtPart

protected

The art part number for the turret we're associated with.

Note

This value is not saved to the OOB file. It is reset at runtime by the actuator when the scenario is loaded.

DtRwBoolean DtVrfTurretedBalGunPSR::myClockwiseFlag

protected

Are we currently scanning clockwise (or counterclockwise?)

DtRwBoolean DtVrfTurretedBalGunPSR::myCannotAcquireTarget

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/vrfTurretedBalGunPSR.h