DtFixedWingActuatorDescriptor Class Reference

DtFixedWingActuatorDescriptor, a descriptor for the DtFixedWingActuatorComponent component.

DtFixedWingActuatorDescriptor is a kind of DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based fixed wing model (DtFixedWingActuatorComponent).

Inheritance diagram for DtFixedWingActuatorDescriptor:

Public Member Functions
	DtFixedWingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtFixedWingActuatorDescriptor (const DtFixedWingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtFixedWingActuatorDescriptor &	operator= (const DtFixedWingActuatorDescriptor &orig)
virtual	~DtFixedWingActuatorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtReal	maxThrustAcceleration () const
virtual void	setMaxThrustAcceleration (DtReal maxThrustAcceleration)
virtual bool	checkTerrain () const
virtual void	setCheckTerrain (bool checkTerrain)
virtual void	setDragCoefficient (double dc)
virtual double	dragCoefficient () const
virtual bool	forceUpdates () const
virtual void	setForceUpdates (bool force)
virtual void	setEngineEfficiency (const DtRwAircraftEngineEfficiencyDataPointList &datapoints)
virtual const DtRwAircraftEngineEfficiencyDataPointList &	engineEfficiency () const
virtual void	setAirspeedCalculatorType (const DtString &sType)
virtual const DtString &	airspeedCalculatorType () const
Public Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtActuatorComponentDescriptor (const DtActuatorComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtActuatorComponentDescriptor &	operator= (const DtActuatorComponentDescriptor &orig)
virtual	~DtActuatorComponentDescriptor ()
virtual void	postGetSelf ()
virtual void	setDefaultArtPartDescriptorList (const DtSimArtPartDescriptorList &artPartDescriptorList)
virtual const DtSimArtPartDescriptorList &	defaultArtPartDescriptorList () const
virtual DtSimArtPartDescriptorList &	defaultArtPartDescriptorList ()
virtual void	setArtPartTypes (const ArtPartTypeSet &partTypes)
virtual const ArtPartTypeSet &	artPartTypes () const
virtual DtArtPartType	firstArtPartType () const
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	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 DtActuatorComponentDescriptor
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
	DtFixedWingActuatorDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
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.
DtRwReal	myMaxThrustAcceleration
DtRwBoolean	myCheckTerrain
DtRwReal	myDragCoefficient
DtRwBoolean	myForceUpdates
DtRwAircraftEngineEfficiencyDataPointList	myAircraftEngineEfficiency
DtRwString	myAirspeedCalculatorType
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
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 DtActuatorComponentDescriptor
typedef std::set< DtArtPartType >	ArtPartTypeSet
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

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

real constructor

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

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

copy constructor

virtual DtFixedWingActuatorDescriptor::~DtFixedWingActuatorDescriptor ( )

virtual

DtFixedWingActuatorDescriptor::DtFixedWingActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtFixedWingActuatorDescriptor& DtFixedWingActuatorDescriptor::operator=

(

const DtFixedWingActuatorDescriptor &

orig

)

assignment

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

DtFixedWingActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

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

virtual

Reimplemented from DtActuatorComponentDescriptor.

virtual DtReal DtFixedWingActuatorDescriptor::maxThrustAcceleration ( ) const

virtual

Accessor/mutator for myMaxThrustAcceleration.

virtual void DtFixedWingActuatorDescriptor::setMaxThrustAcceleration ( DtReal  maxThrustAcceleration )

virtual

Accessor/mutator for myMaxThrustAcceleration.

virtual bool DtFixedWingActuatorDescriptor::checkTerrain ( ) const

virtual

Accessor/mutator for myCheckTerrain.

virtual void DtFixedWingActuatorDescriptor::setCheckTerrain ( bool  checkTerrain )

virtual

Accessor/mutator for myCheckTerrain.

virtual void DtFixedWingActuatorDescriptor::setDragCoefficient ( double  dc )

virtual

Accessor/mutator for myDragCoefficient. This controls the amount of drag this entity experiences.

virtual double DtFixedWingActuatorDescriptor::dragCoefficient ( ) const

virtual

Accessor/mutator for myDragCoefficient. This controls the amount of drag this entity experiences.

virtual bool DtFixedWingActuatorDescriptor::forceUpdates ( ) const

virtual

Accessor/mutator for myForceUpdates.

virtual void DtFixedWingActuatorDescriptor::setForceUpdates ( bool  force )

virtual

Accessor/mutator for myForceUpdates.

virtual void DtFixedWingActuatorDescriptor::setEngineEfficiency ( const DtRwAircraftEngineEfficiencyDataPointList &  datapoints )

virtual

Accessor/mutator for #myEngineEfficiency.

virtual const DtRwAircraftEngineEfficiencyDataPointList& DtFixedWingActuatorDescriptor::engineEfficiency ( ) const

virtual

Accessor/mutator for #myEngineEfficiency.

virtual void DtFixedWingActuatorDescriptor::setAirspeedCalculatorType ( const DtString &  sType )

virtual

Accessor/mutator for myAirspeedCalculatorType.

virtual const DtString& DtFixedWingActuatorDescriptor::airspeedCalculatorType ( ) const

virtual

Accessor/mutator for myAirspeedCalculatorType.

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

DtRwReal DtFixedWingActuatorDescriptor::myMaxThrustAcceleration

protected

Parameter Name: max-thrust-acceleration
Parameter Description: The maximum acceleration in the direction of thrust (assumed down the X axis, the nose).
Parameter Default Value: 20.
Parameter Units: meters/second/second.

DtRwBoolean DtFixedWingActuatorDescriptor::myCheckTerrain

protected

Parameter Name: terrain-check
Parameter Description: If terrain-check is False, entity ignores the terrain. It could appear to fly below ground. However, when terrain-check is set to False, VR-Forces does not have to check ground points, so performance may improve. When terrain-check is True, if a rotary-wing or fixed-wing entity approaches a ground point at three meters per second or less, it lands. If it approaches the ground at a greater speed, it crashes. Parameter Default Value: True.

DtRwReal DtFixedWingActuatorDescriptor::myDragCoefficient

protected

Parameter Name: drag-coefficient
Parameter Description: This is amount of drag associated with this entity. Parameter Default Value: 0.03.

DtRwBoolean DtFixedWingActuatorDescriptor::myForceUpdates

protected

Parameter Name: force-updates
Parameter Description: Forces network updates when acceleration changes and frame lengths are longer to allow remote simulators to maintain better accuracy, but also causes extra network packets to be sent. Parameter Default Value: True.

DtRwAircraftEngineEfficiencyDataPointList DtFixedWingActuatorDescriptor::myAircraftEngineEfficiency

protected

Parameter Name: aircraft-engine-efficiency
Parameter Description: Data points which define the engine fuel efficiency at various speeds and altitudes.
Parameter Default Value: Empty
.

DtRwString DtFixedWingActuatorDescriptor::myAirspeedCalculatorType

protected

Parameter Name: airspeed-calculator-type
Parameter Description: Type of the airspeed calculator to create and use. Parameter Default Value: "DtAirspeedCalculator"
.

---

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

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