DtFixedWingGunneryControllerDescriptor Class Reference

DtFixedWingGunneryControllerDescriptor, descriptor for the DtFixedWingGunneryController component.

A DtComponentDescriptor that has parameter information needed the fixed wing gunnery controller, which controls strafing and aerial gun combat.

Inheritance diagram for DtFixedWingGunneryControllerDescriptor:

Public Member Functions
	DtFixedWingGunneryControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingGunneryControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingGunneryControllerDescriptor (const DtFixedWingGunneryControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtFixedWingGunneryControllerDescriptor &	operator= (const DtFixedWingGunneryControllerDescriptor &orig)
virtual	~DtFixedWingGunneryControllerDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	checkLOS () const
virtual void	setCheckLOS (bool checkLOSFlag)
virtual double	maxAlignmentAngle () const
virtual void	setMaxAlightmentAngle (double angle)
virtual double	entryAltitude () const
virtual void	setEntryAltitude (const double agl)
virtual double	entryAirspeed () const
virtual void	setEntryAirspeed (const double speed)
virtual double	diveAngle () const
virtual void	setDiveAngle (const double angle)
virtual double	strafeRange () const
virtual void	setStrafeRange (const double range)
virtual double	aaEngageRange () const
virtual void	setAaEngageRange (const double range)
virtual double	aaBreakoffRange () const
virtual void	setAaBreakoffRange (const double range)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
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)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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 ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
	DtFixedWingGunneryControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckLOS
DtRwReal	myMaxAlignmentAngle
DtRwReal	myEntryAltitude
DtRwReal	myEntryAirspeed
DtRwReal	myDiveAngle
DtRwReal	myStrafeRange
DtRwReal	myAaEngageRange
DtRwReal	myAaBreakoffRange
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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
bool	myInvalid
bool	myChangedFlag

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 Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory
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
static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

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

constructor

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

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

copy constructor

virtual DtFixedWingGunneryControllerDescriptor::~DtFixedWingGunneryControllerDescriptor ( )

virtual

destructor

DtFixedWingGunneryControllerDescriptor::DtFixedWingGunneryControllerDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtFixedWingGunneryControllerDescriptor& DtFixedWingGunneryControllerDescriptor::operator=

(

const DtFixedWingGunneryControllerDescriptor &

orig

)

assignment

virtual DtString DtFixedWingGunneryControllerDescriptor::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

::DtFixedWingControllerDescriptorType

Reimplemented from DtComponentDescriptor.

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

virtual

Reimplemented from DtComponentDescriptor.

virtual bool DtFixedWingGunneryControllerDescriptor::checkLOS ( ) const

virtual

Accessor/mutator for myCheckLOS.

virtual void DtFixedWingGunneryControllerDescriptor::setCheckLOS ( bool  checkLOSFlag )

virtual

Accessor/mutator for myCheckLOS.

virtual double DtFixedWingGunneryControllerDescriptor::maxAlignmentAngle ( ) const

virtual

Accessor/mutator for myMaxAlignmentAngle.

virtual void DtFixedWingGunneryControllerDescriptor::setMaxAlightmentAngle ( double  angle )

virtual

Accessor/mutator for myMaxAlignmentAngle.

virtual double DtFixedWingGunneryControllerDescriptor::entryAltitude ( ) const

virtual

Accessor/mutator for myEntryAltitude.

virtual void DtFixedWingGunneryControllerDescriptor::setEntryAltitude ( const double  agl )

virtual

Accessor/mutator for myEntryAltitude.

virtual double DtFixedWingGunneryControllerDescriptor::entryAirspeed ( ) const

virtual

Accessor/mutator for myEntryAirspeed.

virtual void DtFixedWingGunneryControllerDescriptor::setEntryAirspeed ( const double  speed )

virtual

Accessor/mutator for myEntryAirspeed.

virtual double DtFixedWingGunneryControllerDescriptor::diveAngle ( ) const

virtual

Accessor/mutator for myDiveAngle. Dive angle is in radians, and a positive angle is a pitch down.

virtual void DtFixedWingGunneryControllerDescriptor::setDiveAngle ( const double  angle )

virtual

Accessor/mutator for myDiveAngle. Dive angle is in radians, and a positive angle is a pitch down.

virtual double DtFixedWingGunneryControllerDescriptor::strafeRange ( ) const

virtual

Accessor/mutator for myStrafeRange.

virtual void DtFixedWingGunneryControllerDescriptor::setStrafeRange ( const double  range )

virtual

Accessor/mutator for myStrafeRange.

virtual double DtFixedWingGunneryControllerDescriptor::aaEngageRange ( ) const

virtual

Accessor/mutator for myAaEngageRange.

virtual void DtFixedWingGunneryControllerDescriptor::setAaEngageRange ( const double  range )

virtual

Accessor/mutator for myAaEngageRange.

virtual double DtFixedWingGunneryControllerDescriptor::aaBreakoffRange ( ) const

virtual

Accessor/mutator for myAaBreakoffRange.

virtual void DtFixedWingGunneryControllerDescriptor::setAaBreakoffRange ( const double  range )

virtual

Accessor/mutator for myAaBreakoffRange.

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

Member Data Documentation

DtRwBoolean DtFixedWingGunneryControllerDescriptor::myCheckLOS

protected

Parameter Name: check-LOS
Parameter Description: Determines whether any checks are done to see if the target is visible each tick. If false, any target that is provided on the input port is assumed to be trackable and visible.
Parameter Default Value: True.

DtRwReal DtFixedWingGunneryControllerDescriptor::myMaxAlignmentAngle

protected

Parameter Name: max-alignment-angle
Parameter Description: The maximum angle that between the gun bore sight and the direction to the target which will be considered aligned with the the target. The gun system will only fire when the gun is aligned with the target.
Parameter Default Value: 0.15
Parameter Units: Radians.

DtRwReal DtFixedWingGunneryControllerDescriptor::myEntryAltitude

protected

Parameter Name: entry-altitude
Parameter Description: The altitude (AGL) at which to begin a strafing attack.
Parameter Default Value: 500.0
Parameter Units: meters.

DtRwReal DtFixedWingGunneryControllerDescriptor::myEntryAirspeed

protected

Parameter Name: entry-airspeed
Parameter Description: The airspeed at which to begin the strafing attack.
Parameter Default Value: 120.0
Parameter Units: meters-per-second.

DtRwReal DtFixedWingGunneryControllerDescriptor::myDiveAngle

protected

Parameter Name: dive-angle
Parameter Description: The angle at which to perform a strafing attack. A positive value; always indicates a pitch down.
Parameter Default Value: 0.44
Parameter Units: radians.

DtRwReal DtFixedWingGunneryControllerDescriptor::myStrafeRange

protected

Parameter Name: strafe-range
Parameter Description: The range from the target at which to begin the strafing attack.
Parameter Default Value: 1000.0
Parameter Units: meters.

DtRwReal DtFixedWingGunneryControllerDescriptor::myAaEngageRange

protected

Parameter Name: aa-engage-range
Parameter Description: The (maximum) range at which to engage another aircraft with guns.
Parameter Default Value: 1000.0
Parameter Units: meters.

DtRwReal DtFixedWingGunneryControllerDescriptor::myAaBreakoffRange

protected

Parameter Name: aa-breakoff-range
Parameter Description: The (minimum) range below which a aerial gun attack is broken off.
Parameter Default Value: 100.0
Parameter Units: meters.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/fixedWingGunneryControllerDescriptor.h