DtRotaryWingActuatorDescriptor Class Reference

DtRotaryWingActuatorDescriptor; descriptor for the DtRotaryWingActuatorComponent component.

A DtActuatorComponentDescriptor that has additional information needed for providing parameters to the kinematics-based rotary wing model – maximum lift, yaw, pitch, and roll scalar accelerations.

Inheritance diagram for DtRotaryWingActuatorDescriptor:

Public Member Functions
	DtRotaryWingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRotaryWingActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtRotaryWingActuatorDescriptor (const DtRotaryWingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtRotaryWingActuatorDescriptor &	operator= (const DtRotaryWingActuatorDescriptor &orig)
virtual	~DtRotaryWingActuatorDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setDefaults ()
virtual void	copyValues (const DtRotaryWingActuatorDescriptor &orig)
virtual DtReal	crashVelocity () const
virtual void	setCrashVelocity (DtReal value)
virtual DtReal	landingPositionThreshold () const
virtual void	setLandingPositionThreshold (DtReal value)
virtual DtReal	landingVelocityThreshold () const
virtual void	setLandingVelocityThreshold (DtReal value)
virtual DtReal	clampedFrameRate () const
virtual void	setClampedFrameRate (DtReal clampedFrameRate)
virtual bool	useFuel () const
virtual void	setUseFuel (bool newValue)
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 ()
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	setTickPeriodUsesRealTime (bool value)
virtual bool	tickPeriodUsesRealTime () 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	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 ()
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	wasUpdatedSince (DtTime t) 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
	DtRotaryWingActuatorDescriptor ()
Protected Member Functions inherited from DtActuatorComponentDescriptor
	DtActuatorComponentDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
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	myCrashVelocity
DtRwReal	myLandingPositionThreshold
DtRwReal	myLandingVelocityThreshold
DtRwReal	myLandingHeightThreshold
DtRwReal	myClampedFrameRate
DtRwBoolean	myUseFuel
DtRwString	myAirspeedCalculatorType
Protected Attributes inherited from DtActuatorComponentDescriptor
ArtPartTypeSet	myArtPartTypes
DtSimArtPartDescriptorList	myDefaultArtPartDescriptorList
Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myTickPeriodUsesRealTime
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
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

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

real constructor

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

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

copy constructor

virtual DtRotaryWingActuatorDescriptor::~DtRotaryWingActuatorDescriptor ( )

virtual

DtRotaryWingActuatorDescriptor::DtRotaryWingActuatorDescriptor ( )

protected

default constructor; not implemented

Member Function Documentation

DtRotaryWingActuatorDescriptor& DtRotaryWingActuatorDescriptor::operator=

(

const DtRotaryWingActuatorDescriptor &

orig

)

assignment

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

DtRotaryWingActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

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

virtual

Reimplemented from DtActuatorComponentDescriptor.

virtual void DtRotaryWingActuatorDescriptor::setDefaults ( )

virtual

Set default values.

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

virtual

virtual DtReal DtRotaryWingActuatorDescriptor::crashVelocity ( ) const

virtual

Accessor/mutator for myCrashVelocity.

virtual void DtRotaryWingActuatorDescriptor::setCrashVelocity ( DtReal  value )

virtual

Accessor/mutator for myCrashVelocity.

virtual DtReal DtRotaryWingActuatorDescriptor::landingPositionThreshold ( ) const

virtual

Accessor/mutator for myLandingPositionThreshold.

virtual void DtRotaryWingActuatorDescriptor::setLandingPositionThreshold ( DtReal  value )

virtual

Accessor/mutator for myLandingPositionThreshold.

virtual DtReal DtRotaryWingActuatorDescriptor::landingVelocityThreshold ( ) const

virtual

Accessor/mutator for myLandingVelocityThreshold.

virtual void DtRotaryWingActuatorDescriptor::setLandingVelocityThreshold ( DtReal  value )

virtual

Accessor/mutator for myLandingVelocityThreshold.

virtual DtReal DtRotaryWingActuatorDescriptor::clampedFrameRate ( ) const

virtual

Accessor/mutator for myClampedFrameRate.

virtual void DtRotaryWingActuatorDescriptor::setClampedFrameRate ( DtReal  clampedFrameRate )

virtual

Accessor/mutator for myClampedFrameRate.

virtual bool DtRotaryWingActuatorDescriptor::useFuel ( ) const

virtual

Accessor/mutator for myUseFuel.

virtual void DtRotaryWingActuatorDescriptor::setUseFuel ( bool  newValue )

virtual

Accessor/mutator for myUseFuel.

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

virtual

Accessor/mutator for myAirspeedCalculatorType.

virtual const DtString& DtRotaryWingActuatorDescriptor::airspeedCalculatorType ( ) const

virtual

Accessor/mutator for myAirspeedCalculatorType.

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

protected

Parameter Name: crash-velocity
Parameter Description: The crash velocity. If the helicopter hits the ground harder than this, it is destroyed.
Parameter Default Value: 4.0
Parameter Units: meters/second.

DtRwReal DtRotaryWingActuatorDescriptor::myLandingPositionThreshold

protected

Parameter Name: landing-position-threshold
Parameter Description: Landing position threshold. If the x-y delta between actual and desired position is less than this value, landing can occur.
Parameter Default Value: 10.0
.

DtRwReal DtRotaryWingActuatorDescriptor::myLandingVelocityThreshold

protected

Parameter Name: landing-velocity-threshold
Parameter Description: Landing velocity threshold. If the x-y value of desired velocity is less than this value, landing can occur.
Parameter Default Value: 5.0
Parameter Units: meters.

DtRwReal DtRotaryWingActuatorDescriptor::myLandingHeightThreshold

protected

Parameter Name: landing-height-threshold
Parameter Description: The landing height threshold. If the helicopter is closer to the terrain than this (z-value), landing can occur.
Parameter Default Value: 2.0
Parameter Units: meters.

DtRwReal DtRotaryWingActuatorDescriptor::myClampedFrameRate

protected

Parameter Name: clamped-frame-rate
Parameter Description: The clamped frame rate. If the frame rate (1 / dT) drops below this value, dT will be set to force this frame rate. Special Case: A frame rate of 0.0 means "Do not clamp." Parameter Default Value: 5.0
Parameter Units: Hertz.

DtRwBoolean DtRotaryWingActuatorDescriptor::myUseFuel

protected

Parameter Name: use-fuel
Parameter Description: If true entity will consume fuel. Parameter Units: Parameter Default Value: true.

DtRwString DtRotaryWingActuatorDescriptor::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-0-branch/include/vrfobjparam/rotaryWingActuatorDescriptor.h