DtVrfWeaponPSR Class Reference

File: weaponPSR.h. More...

Inheritance diagram for DtVrfWeaponPSR:

Public Member Functions
	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 DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual void	setCurrentTarget (const DtEntityIdentifier &target, bool targetOverride=false)
	These two are provided for backward compatibility.
virtual const DtEntityIdentifier &	currentTarget () const
virtual void	setUserTargetOverride (bool userTargetOverride)
	Sets the user target override for the next target detection period.
virtual bool	userTargetOverride () const
virtual void	setCurrentTargetName (const DtString &target, bool targetOverride=false)
	The name of the target this weapon is currently attacking.
virtual const DtString &	currentTargetName () const
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)
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 DtFilename &searchPath, 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)
	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 DtVrfProcessStateRepository *	creator (const DtString &name, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Create an instance of a DtVrfWeaponPSR.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Member Functions
	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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
DtRwBoolean	myTargetAcquired
DtRwString	myCurrentTargetName
DtRwBoolean	myUserTargetOverride
DtRwString	myCurrentMunitionName
DtVrfMunitionLoader	myMunitionLoader
DtEntityIdentifier	myCurrentTargetId
	to have something concrete to return in currentTarget; not written to OOB
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
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.

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 )()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

File: weaponPSR.h.

Class: DtVrfWeaponPSR Class DtVrfWeaponPSR:

Constructor & Destructor Documentation

DtVrfWeaponPSR::DtVrfWeaponPSR ( )

protected

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

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

virtual DtVrfWeaponPSR::~DtVrfWeaponPSR ( )

virtual

Member Function Documentation

const DtVrfWeaponPSR& DtVrfWeaponPSR::operator=

(

const DtVrfWeaponPSR &

orig

)

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

virtual

Implements DtVrfProcessStateRepository.

Reimplemented in DtVrfBalGunPSR, DtVrfIndirectFirePSR, and DtVrfTurretedBalGunPSR.

virtual DtString DtVrfWeaponPSR::type ( ) const

virtual

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

Implements DtVrfProcessStateRepository.

Reimplemented in DtVrfTurretedBalGunPSR, DtVrfBalGunPSR, and DtVrfIndirectFirePSR.

virtual void DtVrfWeaponPSR::setCurrentTarget ( const DtEntityIdentifier &  target, bool  targetOverride = false  )

virtual

These two are provided for backward compatibility.

target names are stored here, and converted to/from entityIdentifiers as necessary

virtual const DtEntityIdentifier& DtVrfWeaponPSR::currentTarget ( ) const

virtual

virtual void DtVrfWeaponPSR::setUserTargetOverride ( bool  userTargetOverride )

virtual

Sets the user target override for the next target detection period.

This flag will be reset to false by the target detection sensor at the end of the period regardless of target acquisition and/or target list addition.

virtual bool DtVrfWeaponPSR::userTargetOverride ( ) const

virtual

virtual void DtVrfWeaponPSR::setCurrentTargetName ( const DtString &  target, bool  targetOverride = false  )

virtual

The name of the target this weapon is currently attacking.

virtual const DtString& DtVrfWeaponPSR::currentTargetName ( ) const

virtual

virtual const DtVrfMunitionLoader& DtVrfWeaponPSR::munitionLoader ( ) const

virtual

The munitionLoader manages loading and unloading timers.

virtual DtVrfMunitionLoader& DtVrfWeaponPSR::munitionLoader ( )

virtual

virtual void DtVrfWeaponPSR::setCurrentMunitionName ( const DtString &  currentMunitionName )

virtual

Sets the name of the current munition.

virtual const DtString& DtVrfWeaponPSR::currentMunitionName ( ) const

virtual

Returns the name of the current munition.

virtual bool DtVrfWeaponPSR::targetAcquired ( ) const

virtual

Do I have the target in my sights, ready to be fired upon?

virtual void DtVrfWeaponPSR::setTargetAcquired ( bool  targetAcquired )

virtual

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

static

Create an instance of a DtVrfWeaponPSR.

Reimplemented in DtVrfBalGunPSR, DtVrfTurretedBalGunPSR, and DtVrfIndirectFirePSR.

Member Data Documentation

DtRwBoolean DtVrfWeaponPSR::myTargetAcquired

protected

DtRwString DtVrfWeaponPSR::myCurrentTargetName

protected

DtRwBoolean DtVrfWeaponPSR::myUserTargetOverride

protected

DtRwString DtVrfWeaponPSR::myCurrentMunitionName

protected

DtVrfMunitionLoader DtVrfWeaponPSR::myMunitionLoader

protected

DtEntityIdentifier DtVrfWeaponPSR::myCurrentTargetId

protected

to have something concrete to return in currentTarget; not written to OOB

---

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

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