makVre::DtVreRotaryWingActuatorDescriptor Class Reference

Detailed Description

This class extends the base rotary wing actuator descriptor to add configuration for stability control, PID parameters, crash behavior, and collective control settings. It provides detailed controls for helicopter flight dynamics and handling characteristics in VREngage simulations.

#include <vreRotaryWingActuatorDescriptor.h>

Inheritance diagram for makVre::DtVreRotaryWingActuatorDescriptor:

Public Member Functions
	DtVreRotaryWingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVreRotaryWingActuatorDescriptor (const DtVreRotaryWingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVreRotaryWingActuatorDescriptor &	operator= (const DtVreRotaryWingActuatorDescriptor &orig)
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual	~DtVreRotaryWingActuatorDescriptor () override
virtual DtString	type () const override
virtual int	stabilityAugmentationMode () const
virtual void	setStabilityAugmentationMode (int value)
virtual bool	stabilityAugmentationVerticalHold () const
virtual void	setStabilityAugmentationVerticalHold (bool value)
virtual double	detonateOnCrash () const
virtual void	setDetonateOnCrash (double val)
virtual double	pGain () const
virtual void	setPGain (double val)
virtual double	iGain () const
virtual void	setIGain (double val)
virtual double	dGain () const
virtual void	setDGain (double val)
virtual double	fGain () const
virtual void	setFGain (double val)
virtual double	pidOutputFilter () const
virtual void	setPidOutputFilter (double val)
virtual double	pidOutputRampRate () const
virtual void	setPidOutputRampRate (double val)
virtual double	pidMaxIOutput () const
virtual void	setPidMaxIOutput (double val)
virtual bool	reverseCollective () const
virtual void	setReverseCollective (bool val)

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Attributes
DtRwInt	myStabilityAugmentationMode
DtRwBoolean	myStabilityAugmentationVerticalHold
DtRwBoolean	myDetonateOnCrash
DtRwReal	myPGain
DtRwReal	myIGain
DtRwReal	myDGain
DtRwReal	myFGain
DtRwReal	myPidOutputFilter
DtRwReal	myPidOutputRampRate
DtRwReal	myPidMaxIOutput
DtRwBoolean	myReverseCollective

Constructor & Destructor Documentation

DtVreRotaryWingActuatorDescriptor() [1/2]

makVre::DtVreRotaryWingActuatorDescriptor::DtVreRotaryWingActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name.

Parameters

name	The name of this component
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new rotary wing actuator descriptor with the specified name.

Referenced by DtVreRotaryWingActuatorDescriptor(), and operator=().

DtVreRotaryWingActuatorDescriptor() [2/2]

makVre::DtVreRotaryWingActuatorDescriptor::DtVreRotaryWingActuatorDescriptor	(	const DtVreRotaryWingActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	The source descriptor to copy from
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new rotary wing actuator descriptor as a copy of the provided original.

References DtVreRotaryWingActuatorDescriptor().

~DtVreRotaryWingActuatorDescriptor()

virtual makVre::DtVreRotaryWingActuatorDescriptor::~DtVreRotaryWingActuatorDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

Member Function Documentation

operator=()

DtVreRotaryWingActuatorDescriptor & makVre::DtVreRotaryWingActuatorDescriptor::operator=

(

const DtVreRotaryWingActuatorDescriptor &

orig

)

Assignment operator.

Parameters

orig	The source descriptor to copy from

Returns

Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreRotaryWingActuatorDescriptor().

clone()

virtual DtComponentDescriptor * makVre::DtVreRotaryWingActuatorDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this descriptor.

Parameters

parentRegistry

Parent registry for reader/writer functionality (optional)

Returns

Pointer to a new descriptor that is a clone of this one

Creates a new rotary wing actuator descriptor as a deep copy of this one.

type()

virtual DtString makVre::DtVreRotaryWingActuatorDescriptor::type ( ) const

overridevirtual

Gets the type identifier for this descriptor.

Returns

String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return DtVreRotaryWingActuatorDescriptorType.

stabilityAugmentationMode()

virtual int makVre::DtVreRotaryWingActuatorDescriptor::stabilityAugmentationMode ( ) const

virtual

Gets the stability augmentation mode.

Returns

The stability augmentation mode value

Returns the current stability augmentation mode for the rotary wing aircraft. Different modes provide different levels of automated stability assistance.

setStabilityAugmentationMode()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setStabilityAugmentationMode ( int value )

virtual

Sets the stability augmentation mode.

Parameters

value

The stability augmentation mode value

Sets the stability augmentation mode for the rotary wing aircraft. Different modes provide different levels of automated stability assistance.

stabilityAugmentationVerticalHold()

virtual bool makVre::DtVreRotaryWingActuatorDescriptor::stabilityAugmentationVerticalHold ( ) const

virtual

Checks if vertical hold is enabled in stability augmentation.

Returns

True if vertical hold is enabled, false otherwise

Returns whether the vertical hold feature is enabled in stability augmentation. When enabled, the aircraft will attempt to maintain a constant altitude.

setStabilityAugmentationVerticalHold()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setStabilityAugmentationVerticalHold ( bool value )

virtual

Sets if vertical hold is enabled in stability augmentation.

Parameters

value

True to enable vertical hold, false to disable

Sets whether the vertical hold feature is enabled in stability augmentation. When enabled, the aircraft will attempt to maintain a constant altitude.

detonateOnCrash()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::detonateOnCrash ( ) const

inlinevirtual

Checks if detonation on crash is enabled.

Returns

True if detonation on crash is enabled, false otherwise

Returns whether the aircraft will detonate when it crashes.

References myDetonateOnCrash.

setDetonateOnCrash()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setDetonateOnCrash ( double val )

inlinevirtual

Sets if detonation on crash is enabled.

Parameters

val	True to enable detonation on crash, false to disable

Sets whether the aircraft will detonate when it crashes.

References myDetonateOnCrash.

pGain()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::pGain ( ) const

inlinevirtual

Gets the proportional gain for the PID controller.

Returns

The proportional gain value

Returns the proportional gain value used in the PID controller for flight stability.

References myPGain.

setPGain()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setPGain ( double val )

inlinevirtual

Sets the proportional gain for the PID controller.

Parameters

val	The proportional gain value

Sets the proportional gain value used in the PID controller for flight stability.

References myPGain.

iGain()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::iGain ( ) const

inlinevirtual

Gets the integral gain for the PID controller.

Returns

The integral gain value

Returns the integral gain value used in the PID controller for flight stability.

References myIGain.

setIGain()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setIGain ( double val )

inlinevirtual

Sets the integral gain for the PID controller.

Parameters

val	The integral gain value

Sets the integral gain value used in the PID controller for flight stability.

References myIGain.

dGain()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::dGain ( ) const

inlinevirtual

Gets the derivative gain for the PID controller.

Returns

The derivative gain value

Returns the derivative gain value used in the PID controller for flight stability.

References myDGain.

setDGain()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setDGain ( double val )

inlinevirtual

Sets the derivative gain for the PID controller.

Parameters

val	The derivative gain value

Sets the derivative gain value used in the PID controller for flight stability.

References myDGain.

fGain()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::fGain ( ) const

inlinevirtual

Gets the feed-forward gain for the PID controller.

Returns

The feed-forward gain value

Returns the feed-forward gain value used in the PID controller for flight stability.

References myFGain.

setFGain()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setFGain ( double val )

inlinevirtual

Sets the feed-forward gain for the PID controller.

Parameters

val	The feed-forward gain value

Sets the feed-forward gain value used in the PID controller for flight stability.

References myFGain.

pidOutputFilter()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::pidOutputFilter ( ) const

inlinevirtual

Gets the PID output filter value.

Returns

The PID output filter value

Returns the filter value applied to the PID controller output to smooth the control response.

References myPidOutputFilter.

setPidOutputFilter()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setPidOutputFilter ( double val )

inlinevirtual

Sets the PID output filter value.

Parameters

val	The PID output filter value

Sets the filter value applied to the PID controller output to smooth the control response.

References myPidOutputFilter.

pidOutputRampRate()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::pidOutputRampRate ( ) const

inlinevirtual

Gets the PID output ramp rate.

Returns

The PID output ramp rate value

Returns the ramp rate applied to the PID controller output to limit how quickly control outputs can change.

References myPidOutputRampRate.

setPidOutputRampRate()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setPidOutputRampRate ( double val )

inlinevirtual

Sets the PID output ramp rate.

Parameters

val	The PID output ramp rate value

Sets the ramp rate applied to the PID controller output to limit how quickly control outputs can change.

References myPidOutputRampRate.

pidMaxIOutput()

virtual double makVre::DtVreRotaryWingActuatorDescriptor::pidMaxIOutput ( ) const

inlinevirtual

Gets the maximum integral output for the PID controller.

Returns

The maximum integral output value

Returns the maximum value for the integral term output in the PID controller. This prevents integral windup by clamping the integral term contribution.

References myPidMaxIOutput.

setPidMaxIOutput()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setPidMaxIOutput ( double val )

inlinevirtual

Sets the maximum integral output for the PID controller.

Parameters

val	The maximum integral output value

Sets the maximum value for the integral term output in the PID controller. This prevents integral windup by clamping the integral term contribution.

References myPidMaxIOutput.

reverseCollective()

virtual bool makVre::DtVreRotaryWingActuatorDescriptor::reverseCollective ( ) const

inlinevirtual

Checks if collective control is reversed.

Returns

True if collective control is reversed, false otherwise

Returns whether the collective control inputs are reversed. This affects how the helicopter responds to collective stick movements.

References myReverseCollective.

setReverseCollective()

virtual void makVre::DtVreRotaryWingActuatorDescriptor::setReverseCollective ( bool val )

inlinevirtual

Sets if collective control is reversed.

Parameters

val	True to reverse collective control, false for normal operation

Sets whether the collective control inputs are reversed. This affects how the helicopter responds to collective stick movements.

References myReverseCollective.

creator()

static DtComponentDescriptor * makVre::DtVreRotaryWingActuatorDescriptor::creator ( )

static

Factory function to create a new instance of this descriptor.

Returns

Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

Member Data Documentation

myStabilityAugmentationMode

DtRwInt makVre::DtVreRotaryWingActuatorDescriptor::myStabilityAugmentationMode

protected

Stability augmentation mode.

Defines the level of automated stability assistance provided to the aircraft. Different modes provide different levels of control assistance.

myStabilityAugmentationVerticalHold

DtRwBoolean makVre::DtVreRotaryWingActuatorDescriptor::myStabilityAugmentationVerticalHold

protected

Vertical hold flag for stability augmentation.

When true, the stability augmentation system will attempt to maintain a constant altitude during flight.

myDetonateOnCrash

DtRwBoolean makVre::DtVreRotaryWingActuatorDescriptor::myDetonateOnCrash

protected

Flag for detonation on crash.

When true, the aircraft will detonate when it crashes.

Referenced by detonateOnCrash(), and setDetonateOnCrash().

myPGain

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myPGain

protected

Proportional gain for the PID controller.

The proportional gain value used in the PID controller for flight stability.

Referenced by pGain(), and setPGain().

myIGain

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myIGain

protected

Integral gain for the PID controller.

The integral gain value used in the PID controller for flight stability.

Referenced by iGain(), and setIGain().

myDGain

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myDGain

protected

Derivative gain for the PID controller.

The derivative gain value used in the PID controller for flight stability.

Referenced by dGain(), and setDGain().

myFGain

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myFGain

protected

Feed-forward gain for the PID controller.

The feed-forward gain value used in the PID controller for flight stability.

Referenced by fGain(), and setFGain().

myPidOutputFilter

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myPidOutputFilter

protected

Filter value for PID controller output.

Filter value applied to the PID controller output to smooth the control response.

Referenced by pidOutputFilter(), and setPidOutputFilter().

myPidOutputRampRate

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myPidOutputRampRate

protected

Ramp rate for PID controller output.

Ramp rate applied to the PID controller output to limit how quickly control outputs can change.

Referenced by pidOutputRampRate(), and setPidOutputRampRate().

myPidMaxIOutput

DtRwReal makVre::DtVreRotaryWingActuatorDescriptor::myPidMaxIOutput

protected

Maximum integral output value for the PID controller.

Maximum value for the integral term output in the PID controller. This prevents integral windup by clamping the integral term contribution.

Referenced by pidMaxIOutput(), and setPidMaxIOutput().

myReverseCollective

DtRwBoolean makVre::DtVreRotaryWingActuatorDescriptor::myReverseCollective

protected

Flag for reversing collective control.

When true, the collective control inputs are reversed, affecting how the helicopter responds to collective stick movements.

Referenced by reverseCollective(), and setReverseCollective().

---

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

• include/vrfExtensions/vreVrfobjparam/vreRotaryWingActuatorDescriptor.h