DtBallisticGunJoyControllerDescriptor; descriptor for the DtAutomotiveActuator component. More...

Inheritance diagram for DtBallisticGunJoyControllerDescriptor:

Public Member Functions
	DtBallisticGunJoyControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
	DtBallisticGunJoyControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	constructor
virtual	~DtBallisticGunJoyControllerDescriptor ()
	destructor
	DtBallisticGunJoyControllerDescriptor (const DtBallisticGunJoyControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtBallisticGunJoyControllerDescriptor &	operator= (const DtBallisticGunJoyControllerDescriptor &orig)
	assignment operator
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtString	type () const
	Returns the type of component this descriptor describes.

virtual int	fireButton () const
	Accessor/mutator for myFireButton.
virtual void	setFireButton (int button)
	Accessor/mutator for myFireButton.

virtual int	changeAmmoButton () const
	Accessor/mutator for myChangeAmmoButton.
virtual void	setChangeAmmoButton (int button)
	Accessor/mutator for myChangeAmmoButton.

virtual int	elevationAxis () const
	Accessor/mutator for myElevationAxis.
virtual void	setElevationAxis (int axis)
	Accessor/mutator for myElevationAxis.

virtual bool	invertElevationAxis () const
	Accessor/mutator for myInvertElevationAxis.
virtual void	setInvertElevationAxis (bool invert)
	Accessor/mutator for myInvertElevationAxis.
Public Member Functions inherited from DtBallisticGunControllerDescriptor
	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 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.
bool	operator== (const DtComponentDescriptor &) const
	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.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created 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
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 DtComponentDescriptor *	creator ()

Protected Member Functions
virtual void	setDefaults ()
	set default values;
virtual void	copyValues (const DtBallisticGunJoyControllerDescriptor &orig)
	Copy over the parameters.
	DtBallisticGunJoyControllerDescriptor ()
	default constructor; not implemented
Protected Member Functions inherited from DtBallisticGunControllerDescriptor
	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.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myFireButton
	Parameter Name: joy-fire-button Parameter Description: Button used to fire the gun.
DtRwInt	myChangeAmmoButton
	Parameter Name: joy-change-ammo-button Parameter Description: Button used to change the ammo.
DtRwInt	myElevationAxis
	Parameter Name: joy-elevation-axis Parameter Description: Axis used to elevate the gun.
DtRwBoolean	myInvertElevationAxis
	Parameter Name: joy-invert-elevation-axis Parameter Description: Inversion of the axis used to elevate the gun.
Protected Attributes inherited from DtBallisticGunControllerDescriptor
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
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
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.

Static Protected Attributes

static const char	theFireButtonName []
	Constants for reader-writer names.
static const char	theChangeAmmoButtonName []
	Constants for reader-writer names.
static const char	theElevationAxisName []
	Constants for reader-writer names.
static const char	theInvertElevationAxisName []
	Constants for reader-writer names.

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 )()

Detailed Description

DtBallisticGunJoyControllerDescriptor; descriptor for the DtAutomotiveActuator component.

Instances of DtBallisticGunJoyControllerDescriptor allow the remapping of the buttons used for firing the gun. It also provides for changing the ammo and the axis used to elevate the barrel.

Constructor & Destructor Documentation

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

constructor

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

constructor

virtual DtBallisticGunJoyControllerDescriptor::~DtBallisticGunJoyControllerDescriptor ( )

virtual

destructor

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

copy constructor

DtBallisticGunJoyControllerDescriptor::DtBallisticGunJoyControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

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

assignment operator

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

virtual

Reimplemented from DtBallisticGunControllerDescriptor.

virtual DtString DtBallisticGunJoyControllerDescriptor::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: DtBallisticGunJoyControllerDescriptorType

Reimplemented from DtBallisticGunControllerDescriptor.

virtual int DtBallisticGunJoyControllerDescriptor::fireButton ( ) const

virtual

Accessor/mutator for myFireButton.

virtual void DtBallisticGunJoyControllerDescriptor::setFireButton ( int button )

virtual

Accessor/mutator for myFireButton.

virtual int DtBallisticGunJoyControllerDescriptor::changeAmmoButton ( ) const

virtual

Accessor/mutator for myChangeAmmoButton.

virtual void DtBallisticGunJoyControllerDescriptor::setChangeAmmoButton ( int button )

virtual

Accessor/mutator for myChangeAmmoButton.

virtual int DtBallisticGunJoyControllerDescriptor::elevationAxis ( ) const

virtual

Accessor/mutator for myElevationAxis.

virtual void DtBallisticGunJoyControllerDescriptor::setElevationAxis ( int axis )

virtual

Accessor/mutator for myElevationAxis.

virtual bool DtBallisticGunJoyControllerDescriptor::invertElevationAxis ( ) const

virtual

Accessor/mutator for myInvertElevationAxis.

virtual void DtBallisticGunJoyControllerDescriptor::setInvertElevationAxis ( bool invert )

virtual

Accessor/mutator for myInvertElevationAxis.

static DtComponentDescriptor* DtBallisticGunJoyControllerDescriptor::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 DtBallisticGunControllerDescriptor.

virtual void DtBallisticGunJoyControllerDescriptor::setDefaults ( )

protectedvirtual

set default values;

virtual void DtBallisticGunJoyControllerDescriptor::copyValues ( const DtBallisticGunJoyControllerDescriptor & orig )

protectedvirtual

Copy over the parameters.

Member Data Documentation

DtRwInt DtBallisticGunJoyControllerDescriptor::myFireButton

protected

Parameter Name: joy-fire-button
Parameter Description: Button used to fire the gun.

Parameter Default Value: 1

DtRwInt DtBallisticGunJoyControllerDescriptor::myChangeAmmoButton

protected

Parameter Name: joy-change-ammo-button
Parameter Description: Button used to change the ammo.

Parameter Default Value: 2

DtRwInt DtBallisticGunJoyControllerDescriptor::myElevationAxis

protected

Parameter Name: joy-elevation-axis
Parameter Description: Axis used to elevate the gun.

Parameter Default Value: 1

DtRwBoolean DtBallisticGunJoyControllerDescriptor::myInvertElevationAxis

protected

Parameter Name: joy-invert-elevation-axis
Parameter Description: Inversion of the axis used to elevate the gun.

Parameter Default Value: False

const char DtBallisticGunJoyControllerDescriptor::theFireButtonName[]

staticprotected

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theChangeAmmoButtonName[]

staticprotected

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theElevationAxisName[]

staticprotected

Constants for reader-writer names.

const char DtBallisticGunJoyControllerDescriptor::theInvertElevationAxisName[]

staticprotected

Constants for reader-writer names.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/balGunJoyCtlDesc.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation