DtBallisticGunControllerDescriptor Class Reference

DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component. More...

Inheritance diagram for DtBallisticGunControllerDescriptor:

Public Member Functions
	DtBallisticGunControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtBallisticGunControllerDescriptor (const DtBallisticGunControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunControllerDescriptor &	operator= (const DtBallisticGunControllerDescriptor &orig)
	assignment
virtual	~DtBallisticGunControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtTime	loadAmmoTime () const
	Accessor/mutator for myLoadAmmoTime.
virtual void	setLoadAmmoTime (DtTime loadTime)
	Accessor/mutator for myLoadAmmoTime.
virtual DtTime	unloadAmmoTime () const
	Accessor/mutator for myUnloadAmmoTime.
virtual void	setUnloadAmmoTime (DtTime unloadTime)
	Accessor/mutator for myUnloadAmmoTime.
virtual int	roundsPerTriggerPull () const
virtual void	setRoundsPerTriggerPull (int value)
virtual const DtAmmoSelectTable &	ammoSelectTable () const
	Accessor/mutator for myAmmoSelectTable.
virtual void	setAmmoSelectTable (const DtAmmoSelectTable &table)
	Accessor/mutator for myAmmoSelectTable.
virtual const DtString &	ammoSelectTableFilename ()
	Accessor/mutator for myAmmoSelectTableFile.
virtual void	setAmmoSelectTableFilename (const DtString &filename)
	Accessor/mutator for myAmmoSelectTableFile.
virtual DtTargetSelectionCriteria &	targetSelectionCriteria ()
	Accessor/mutator for myTargetSelectionCriteria.
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
	Accessor/mutator for myTargetSelectionCriteria.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
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 actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
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
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 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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
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.

Protected Member Functions
	DtBallisticGunControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
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.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwTime	myLoadAmmoTime
	Parameter Name: load-ammo-time Parameter Description: The time delay from the time an ammo is selected to the time (an unloaded) gun is ready to fire.
DtRwTime	myUnloadAmmoTime
	Parameter Name: unload-ammo-time Parameter Description: The time is takes to remove ammo (of the wrong type, presumably) from the gun.
DtReaderWriterFile	myAmmoSelectTableFile
	Parameter Name: ammo-select-table-file Parameter Description: Sets the filename used for the ammo select table.
DtAmmoSelectTable	myAmmoSelectTable
	Parameter Name: ammo-select-table Parameter Description: Table of target types versus lists of prioritized munition types to use against a given target type.
DtRwInt	myRoundsPerTriggerPull
	Parameter Name: rounds-per-trigger-pull Parameter Description: The number of rounds to fire for each single trigger pull.
DtTargetSelectionCriteria	myTargetSelectionCriteria
	Parameter Name: targeting-control Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
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
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component.

A DtComponentDescriptor that has additional information needed for providing parameters to a generic ballistic gun controller. In contains load time, unload time, and an ammo selection table.

Constructor & Destructor Documentation

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

constructor

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor	(	const DtBallisticGunControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtBallisticGunControllerDescriptor::~DtBallisticGunControllerDescriptor ( )

virtual

destructor

DtBallisticGunControllerDescriptor::DtBallisticGunControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtBallisticGunControllerDescriptor& DtBallisticGunControllerDescriptor::operator=

(

const DtBallisticGunControllerDescriptor &

orig

)

assignment

virtual DtString DtBallisticGunControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtBalGunControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunJoyControllerDescriptor, and DtElevatingBallisticGunControllerDescriptor.

virtual DtComponentDescriptor* DtBallisticGunControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtElevatingBallisticGunControllerDescriptor, and DtBallisticGunJoyControllerDescriptor.

virtual DtTime DtBallisticGunControllerDescriptor::loadAmmoTime ( ) const

virtual

Accessor/mutator for myLoadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setLoadAmmoTime ( DtTime  loadTime )

virtual

Accessor/mutator for myLoadAmmoTime.

virtual DtTime DtBallisticGunControllerDescriptor::unloadAmmoTime ( ) const

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual void DtBallisticGunControllerDescriptor::setUnloadAmmoTime ( DtTime  unloadTime )

virtual

Accessor/mutator for myUnloadAmmoTime.

virtual int DtBallisticGunControllerDescriptor::roundsPerTriggerPull ( ) const

virtual

See Also

myRoundsPerTriggerPull.

virtual void DtBallisticGunControllerDescriptor::setRoundsPerTriggerPull ( int  value )

virtual

See Also

myRoundsPerTriggerPull.

virtual const DtAmmoSelectTable& DtBallisticGunControllerDescriptor::ammoSelectTable ( ) const

virtual

Accessor/mutator for myAmmoSelectTable.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTable ( const DtAmmoSelectTable &  table )

virtual

Accessor/mutator for myAmmoSelectTable.

virtual const DtString& DtBallisticGunControllerDescriptor::ammoSelectTableFilename ( )

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual void DtBallisticGunControllerDescriptor::setAmmoSelectTableFilename ( const DtString &  filename )

virtual

Accessor/mutator for myAmmoSelectTableFile.

virtual DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria ( )

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtBallisticGunControllerDescriptor::targetSelectionCriteria ( ) const

virtual

Accessor/mutator for myTargetSelectionCriteria.

static DtComponentDescriptor* DtBallisticGunControllerDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

Reimplemented in DtBallisticGunJoyControllerDescriptor, and DtElevatingBallisticGunControllerDescriptor.

Member Data Documentation

DtRwTime DtBallisticGunControllerDescriptor::myLoadAmmoTime

protected

Parameter Name: load-ammo-time
Parameter Description: The time delay from the time an ammo is selected to the time (an unloaded) gun is ready to fire.

Parameter Default Value: 0.0
Parameter Units: seconds

DtRwTime DtBallisticGunControllerDescriptor::myUnloadAmmoTime

protected

Parameter Name: unload-ammo-time
Parameter Description: The time is takes to remove ammo (of the wrong type, presumably) from the gun.

The same time is used whether the gun was loaded or in the process of being loaded.
Parameter Default Value: 0.0
Parameter Units: seconds

DtReaderWriterFile DtBallisticGunControllerDescriptor::myAmmoSelectTableFile

protected

Parameter Name: ammo-select-table-file
Parameter Description: Sets the filename used for the ammo select table.

Parameter Default Value: ""

DtAmmoSelectTable DtBallisticGunControllerDescriptor::myAmmoSelectTable

protected

Parameter Name: ammo-select-table
Parameter Description: Table of target types versus lists of prioritized munition types to use against a given target type.

Parameter Default Value:

DtRwInt DtBallisticGunControllerDescriptor::myRoundsPerTriggerPull

protected

Parameter Name: rounds-per-trigger-pull
Parameter Description: The number of rounds to fire for each single trigger pull.

This affects how many rounds a depleted from the resource stores, and the value of the quantity field in the fire/detonate interaction.
Parameter Default Value: 1
Parameter Units: Number.

DtTargetSelectionCriteria DtBallisticGunControllerDescriptor::myTargetSelectionCriteria

protected

Parameter Name: targeting-control
Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.

See DtTargetSelectionCriteria for more information on this item.
Parameter Default Value:

---

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

• include/vrfobjparam/balGunCtlDesc.h