DtVrfMunitionLoader Class Reference

File: munLoader.h. More...

Inheritance diagram for DtVrfMunitionLoader:

Public Member Functions
	DtVrfMunitionLoader (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfMunitionLoader (const DtVrfMunitionLoader &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfMunitionLoader &	operator= (const DtVrfMunitionLoader &orig)
virtual	~DtVrfMunitionLoader ()
virtual void	tick (const DtSimMunition &correctMunition, DtDetonatorFuze correctFuze, DtTime currentTime, int roundsAvailable=1)
	Tick the munition loader to update the load state.
virtual void	load (DtTime startLoadTime, const DtSimMunition &munition, DtDetonatorFuze fuze)
	Sets the loading state to Loading.
virtual void	loadComplete (int roundsAvailable)
	Sets the loading state to Loaded.
virtual void	unload (DtTime startUnloadTime)
	Sets the load state to Unloaded, and the number of rounds currently in the magazine to zero.
virtual void	unload ()
	Unload without a timer. Called when munition is fired.
virtual bool	isLoading () const
	myState == Loading
virtual bool	isUnLoading () const
	myState == Unloading
virtual bool	isLoaded () const
	myState == Loaded
virtual bool	isUnloaded () const
	myState == Unloaded This is included for completeness, but typically the user will want to use if (! isLoaded()) rather than (isUnloaded()) as the former is the one that tells you that the gun isn't ready to shoot yet
virtual int	state () const
	Returns the state in integer form. Mostly for debugging.
virtual const DtSimMunition &	currentMunition () const
virtual void	setCurrentMunition (const DtSimMunition &currentMunition)
virtual DtDetonatorFuze	currentFuze () const
virtual void	setCurrentFuze (DtDetonatorFuze currentFuze)
virtual double	completeLoadTime () const
	CompleteLoadTime is normally set by the load() method, and sets the exercise time that a load operation will complete.
virtual void	setCompleteLoadTime (double completeLoadTime)
virtual double	completeUnloadTime () const
	CompleteUnloadTime is normally set by the unload() method, and sets the exercise time that an unload operation will complete.
virtual void	setCompleteUnloadTime (double completeUnloadTime)
virtual double	loadAmmoTime () const
	Called by the controller based on the value in the descriptor.
virtual void	setLoadAmmoTime (double loadAmmoTime)
	Called by the controller based on the value in the descriptor.
virtual double	unloadAmmoTime () const
	Called by the controller based on the value in the descriptor.
virtual void	setUnloadAmmoTime (double unloadAmmoTime)
	Called by the controller based on the value in the descriptor.
virtual void	setRoundsPerMagazine (const int nRounds)
	Called by the actuator, which sets value based on descriptor.
virtual int	roundsPerMagazine () const
virtual int	roundsLeftInMagazine () const
	Returns number of rounds left in magazine (rounds to fire before becoming unloaded)
virtual void	useRounds (const int nRounds)
	Deplete the rounds left. Called by actuator when it fires.
virtual void	setConsoleWarn (DtOutputStream *const warnStream)
	Set object output consoles for the munition loader so that debug messages can be output.
virtual void	setConsoleDebug (DtOutputStream *const debugStream)
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &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)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Types
enum	LoadState { Loading, Unloading, Unloaded, Loaded }

Protected Attributes
DtRwInt	myState
DtOutputStream *	myConsoleWarn
DtOutputStream *	myConsoleDebug
DtSimMunition	myCurrentMunition
	The munition and fuze currently loaded / loading.
DtRwInt	myCurrentFuze
DtRwReal	myCompleteLoadTime
DtRwReal	myCompleteUnloadTime
DtReal	myLoadAmmoTime
	Fed from controller based on the value from the descriptor.
DtReal	myUnloadAmmoTime
	Fed from controller based on the value from the descriptor.
DtRwInt	myRoundsPerMagazine
	How many rounds the magazine holds; loader loads a magazine at a time.
DtRwInt	myRoundsLeftInMagazine
	How many rounds left to be fired before becoming unloaded.
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 )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent

Detailed Description

File: munLoader.h.

Class: DtVrfMunitionLoader Class DtVrfMunitionLoader:

Member Enumeration Documentation

enum DtVrfMunitionLoader::LoadState

protected

Enumerator:

Loading
Unloading
Unloaded
Loaded

Constructor & Destructor Documentation

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

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

virtual DtVrfMunitionLoader::~DtVrfMunitionLoader ( )

virtual

Member Function Documentation

const DtVrfMunitionLoader& DtVrfMunitionLoader::operator=

(

const DtVrfMunitionLoader &

orig

)

virtual void DtVrfMunitionLoader::tick ( const DtSimMunition &  correctMunition, DtDetonatorFuze  correctFuze, DtTime  currentTime, int  roundsAvailable = 1  )

virtual

Tick the munition loader to update the load state.

The munition and fuze arguments indicate the correct load for the current target; if the loader is not loaded with or loading this munition, it will begin doing so. If the gun loads magazines of ammo at a time, the rounds available argument will make sure that the loader doesn't load more rounds than are available.

virtual void DtVrfMunitionLoader::load ( DtTime  startLoadTime, const DtSimMunition &  munition, DtDetonatorFuze  fuze  )

virtual

Sets the loading state to Loading.

Also remembers what munition and fuze is being loaded so loader can compare to the values in the next tick call.

virtual void DtVrfMunitionLoader::loadComplete ( int  roundsAvailable )

virtual

Sets the loading state to Loaded.

Loads the gun with a number of rounds equal to RoundsPerMagazine, if there are that many available (or otherwise what is available). If there is no ammo in the resource database, the loader refuses to load.

virtual void DtVrfMunitionLoader::unload ( DtTime  startUnloadTime )

virtual

Sets the load state to Unloaded, and the number of rounds currently in the magazine to zero.

virtual void DtVrfMunitionLoader::unload ( )

virtual

Unload without a timer. Called when munition is fired.

virtual bool DtVrfMunitionLoader::isLoading ( ) const

virtual

myState == Loading

virtual bool DtVrfMunitionLoader::isUnLoading ( ) const

virtual

myState == Unloading

virtual bool DtVrfMunitionLoader::isLoaded ( ) const

virtual

myState == Loaded

virtual bool DtVrfMunitionLoader::isUnloaded ( ) const

virtual

myState == Unloaded This is included for completeness, but typically the user will want to use if (! isLoaded()) rather than (isUnloaded()) as the former is the one that tells you that the gun isn't ready to shoot yet

virtual int DtVrfMunitionLoader::state ( ) const

virtual

Returns the state in integer form. Mostly for debugging.

virtual const DtSimMunition& DtVrfMunitionLoader::currentMunition ( ) const

virtual

virtual void DtVrfMunitionLoader::setCurrentMunition ( const DtSimMunition &  currentMunition )

virtual

virtual DtDetonatorFuze DtVrfMunitionLoader::currentFuze ( ) const

virtual

virtual void DtVrfMunitionLoader::setCurrentFuze ( DtDetonatorFuze  currentFuze )

virtual

virtual double DtVrfMunitionLoader::completeLoadTime ( ) const

virtual

CompleteLoadTime is normally set by the load() method, and sets the exercise time that a load operation will complete.

virtual void DtVrfMunitionLoader::setCompleteLoadTime ( double  completeLoadTime )

virtual

virtual double DtVrfMunitionLoader::completeUnloadTime ( ) const

virtual

CompleteUnloadTime is normally set by the unload() method, and sets the exercise time that an unload operation will complete.

virtual void DtVrfMunitionLoader::setCompleteUnloadTime ( double  completeUnloadTime )

virtual

virtual double DtVrfMunitionLoader::loadAmmoTime ( ) const

virtual

Called by the controller based on the value in the descriptor.

virtual void DtVrfMunitionLoader::setLoadAmmoTime ( double  loadAmmoTime )

virtual

Called by the controller based on the value in the descriptor.

virtual double DtVrfMunitionLoader::unloadAmmoTime ( ) const

virtual

Called by the controller based on the value in the descriptor.

virtual void DtVrfMunitionLoader::setUnloadAmmoTime ( double  unloadAmmoTime )

virtual

Called by the controller based on the value in the descriptor.

virtual void DtVrfMunitionLoader::setRoundsPerMagazine ( const int  nRounds )

virtual

Called by the actuator, which sets value based on descriptor.

Needed by the loader so it knows how many rounds to load at once.

virtual int DtVrfMunitionLoader::roundsPerMagazine ( ) const

virtual

virtual int DtVrfMunitionLoader::roundsLeftInMagazine ( ) const

virtual

Returns number of rounds left in magazine (rounds to fire before becoming unloaded)

virtual void DtVrfMunitionLoader::useRounds ( const int  nRounds )

virtual

Deplete the rounds left. Called by actuator when it fires.

virtual void DtVrfMunitionLoader::setConsoleWarn ( DtOutputStream *const  warnStream )

virtual

Set object output consoles for the munition loader so that debug messages can be output.

virtual void DtVrfMunitionLoader::setConsoleDebug ( DtOutputStream *const  debugStream )

virtual

Member Data Documentation

DtRwInt DtVrfMunitionLoader::myState

protected

DtOutputStream* DtVrfMunitionLoader::myConsoleWarn

protected

DtOutputStream* DtVrfMunitionLoader::myConsoleDebug

protected

DtSimMunition DtVrfMunitionLoader::myCurrentMunition

protected

The munition and fuze currently loaded / loading.

If these do not match the values passed in to tick, a load (or unload/load) sequence is initiated

DtRwInt DtVrfMunitionLoader::myCurrentFuze

protected

DtRwReal DtVrfMunitionLoader::myCompleteLoadTime

protected

DtRwReal DtVrfMunitionLoader::myCompleteUnloadTime

protected

DtReal DtVrfMunitionLoader::myLoadAmmoTime

protected

Fed from controller based on the value from the descriptor.

DtReal DtVrfMunitionLoader::myUnloadAmmoTime

protected

Fed from controller based on the value from the descriptor.

DtRwInt DtVrfMunitionLoader::myRoundsPerMagazine

protected

How many rounds the magazine holds; loader loads a magazine at a time.

Set by gun (actuator) using parameter values in the descriptor.

DtRwInt DtVrfMunitionLoader::myRoundsLeftInMagazine

protected

How many rounds left to be fired before becoming unloaded.

---

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

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