Detailed Description

This class contains the configuration parameters for fixed-wing aircraft in VREngage. It extends the base fixed-wing entity parameters with VREngage-specific settings for control response, aircraft limits, and simulation fidelity options.

#include <vreFwlParameters.h>

Inheritance diagram for FwlCgfVrf::DtVreFwlParameters:

[legend]

Public Member Functions
	DtVreFwlParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP objectNode=NULL)

	DtVreFwlParameters (const DtVreFwlParameters &orig, const DtString &name, DtReaderWriterRegistry *parentRegistry)

virtual	~DtVreFwlParameters () override

const DtVreFwlParameters &	operator= (const DtVreFwlParameters &orig)

const DtVreFwlParameters &	operator= (const DtFixedWingEntityParameters &orig)

virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override

virtual DtString	type () const override

DtString	getSimpleAirplaneParameterFile () const

DtReal	getAltitudeOffset () const

DtReal	getLateralControlDeadzone () const

DtReal	getLongitudinalControlDeadzone () const

DtReal	getPedalDeadzone () const

DtReal	getDefaultMaxLoad () const

DtReal	getDefaultRollRate () const

DtReal	getDefaultVertSpeed () const

DtBoolean	getHighFidelityTerrainQueries () const

const DtRwReal &	getMaxAltitude () const

const DtRwReal &	getMaxSpeed () const

virtual bool	inheritValues (const DtVrfObjectParameters *benefactor) override

virtual void	inheritValuesFromThisType (const DtVreFwlParameters *pars)

Static Public Member Functions
static DtVrfObjectParameters *	creator (DtEnvironmentSP env, DtEnvValueSP *root)

Protected Attributes
DtRwReal	myAltitudeOffset

DtRwReal	myLateralControlDeadZone

DtRwReal	myLongitudinalControlDeadZone

DtRwReal	myPedalDeadZone

DtRwReal	myDefaultMaxLoad

DtRwReal	myDefaultRollRate

DtRwReal	myDefaultVertSpeed

DtRwBoolean	myHighFidelityTerrainQueries

Private Attributes
DtRwString	myDynamicsParameterFile

Friends
class	Controller

Constructor & Destructor Documentation

◆ DtVreFwlParameters() [1/2]

FwlCgfVrf::DtVreFwlParameters::DtVreFwlParameters	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = NULL,
		DtEnvironmentSP	env = DtEnvironmentSP(),
		DtEnvValueSP *	objectNode = NULL )

Constructor.

Parameters

name	The name of the parameters
parentRegistry	Parent registry for reader/writer functionality
env	Environment for parameter values
objectNode	Node containing parameter values

Initializes a new fixed-wing parameters object with values from the provided environment.

Referenced by Controller, DtVreFwlParameters(), inheritValuesFromThisType(), operator=(), and operator=().

◆ DtVreFwlParameters() [2/2]

FwlCgfVrf::DtVreFwlParameters::DtVreFwlParameters	(	const DtVreFwlParameters &	orig,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry )

Copy constructor.

Parameters

orig	The source parameters to copy from
name	The name for the new parameters
parentRegistry	Parent registry for reader/writer functionality

Creates a new parameters object as a copy of the provided original parameters.

References DtVreFwlParameters().

◆ ~DtVreFwlParameters()

virtual FwlCgfVrf::DtVreFwlParameters::~DtVreFwlParameters ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the parameters object.

References creator().

Member Function Documentation

◆ creator()

static DtVrfObjectParameters * FwlCgfVrf::DtVreFwlParameters::creator	(	DtEnvironmentSP	env,
		DtEnvValueSP *	root )

static

Creator function for this parameter type.

Parameters

env	Environment for parameter values
root	Root node containing parameter values

Returns: Pointer to a new parameters object of this type

Static factory function used for parameter creation with environment support.

Referenced by ~DtVreFwlParameters().

◆ operator=() [1/2]

const DtVreFwlParameters & FwlCgfVrf::DtVreFwlParameters::operator= ( const DtVreFwlParameters & orig )

Assignment operator.

Parameters

orig	The source parameters to copy from

Returns: Reference to this parameters object after assignment

Assigns the contents of the provided parameters to this parameters object.

References DtVreFwlParameters().

◆ operator=() [2/2]

const DtVreFwlParameters & FwlCgfVrf::DtVreFwlParameters::operator= ( const DtFixedWingEntityParameters & orig )

Assignment operator from base class.

Parameters

orig	The source base parameters to copy from

Returns: Reference to this parameters object after assignment

Assigns the contents of the provided base parameters to this parameters object.

References DtVreFwlParameters().

◆ clone()

virtual DtVrfObjectParameters * FwlCgfVrf::DtVreFwlParameters::clone	(	const DtString &	name = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0 ) const

overridevirtual

Creates a clone of these parameters.

Parameters

name	The name for the cloned parameters
parentRegistry	Parent registry for reader/writer functionality

Returns: Pointer to a new parameters object that is a clone of this one

Creates a new parameters object as a deep copy of this parameters object.

◆ type()

virtual DtString FwlCgfVrf::DtVreFwlParameters::type ( ) const

overridevirtual

Gets the parameters type.

Returns: The type string for these parameters

Returns TS_Parameter as the parameters type identifier.

◆ getSimpleAirplaneParameterFile()

DtString FwlCgfVrf::DtVreFwlParameters::getSimpleAirplaneParameterFile ( ) const

Gets the aircraft dynamics parameter file path.

Returns: The file path to the aircraft dynamics parameters

Returns the path to the file containing detailed aircraft dynamics parameters.

◆ getAltitudeOffset()

DtReal FwlCgfVrf::DtVreFwlParameters::getAltitudeOffset ( ) const

Gets the altitude offset.

Returns: The altitude offset value

Returns the altitude offset applied to the aircraft's position.

◆ getLateralControlDeadzone()

DtReal FwlCgfVrf::DtVreFwlParameters::getLateralControlDeadzone ( ) const

Gets the lateral control deadzone.

Returns: The lateral control deadzone value

Returns the deadzone value for lateral (roll) control inputs.

◆ getLongitudinalControlDeadzone()

DtReal FwlCgfVrf::DtVreFwlParameters::getLongitudinalControlDeadzone ( ) const

Gets the longitudinal control deadzone.

Returns: The longitudinal control deadzone value

Returns the deadzone value for longitudinal (pitch) control inputs.

◆ getPedalDeadzone()

DtReal FwlCgfVrf::DtVreFwlParameters::getPedalDeadzone ( ) const

Gets the pedal control deadzone.

Returns: The pedal control deadzone value

Returns the deadzone value for pedal (rudder) control inputs.

◆ getDefaultMaxLoad()

DtReal FwlCgfVrf::DtVreFwlParameters::getDefaultMaxLoad ( ) const

Gets the default maximum load factor.

Returns: The default maximum load factor

Returns the default maximum load factor (G-force) for the aircraft.

◆ getDefaultRollRate()

DtReal FwlCgfVrf::DtVreFwlParameters::getDefaultRollRate ( ) const

Gets the default roll rate.

Returns: The default roll rate

Returns the default roll rate for the aircraft.

◆ getDefaultVertSpeed()

DtReal FwlCgfVrf::DtVreFwlParameters::getDefaultVertSpeed ( ) const

Gets the default vertical speed.

Returns: The default vertical speed

Returns the default vertical speed for the aircraft.

◆ getHighFidelityTerrainQueries()

DtBoolean FwlCgfVrf::DtVreFwlParameters::getHighFidelityTerrainQueries ( ) const

Gets whether high-fidelity terrain queries are enabled.

Returns: True if high-fidelity terrain queries are enabled, false otherwise

Returns whether high-fidelity terrain queries are enabled for this aircraft.

◆ getMaxAltitude()

const DtRwReal & FwlCgfVrf::DtVreFwlParameters::getMaxAltitude ( ) const

inline

Gets the maximum altitude limit.

Returns: Reference to the maximum altitude value

Returns the maximum altitude limit for the aircraft.

◆ getMaxSpeed()

const DtRwReal & FwlCgfVrf::DtVreFwlParameters::getMaxSpeed ( ) const

inline

Gets the maximum speed limit.

Returns: Reference to the maximum speed value

Returns the maximum speed limit for the aircraft.

◆ inheritValues()

virtual bool FwlCgfVrf::DtVreFwlParameters::inheritValues ( const DtVrfObjectParameters * benefactor )

overridevirtual

Inherits values from another parameters object.

Parameters

benefactor The parameters object to inherit from

Returns: True if values were successfully inherited, false otherwise

Inherits values from another parameters object, if it is of a compatible type.

◆ inheritValuesFromThisType()

virtual void FwlCgfVrf::DtVreFwlParameters::inheritValuesFromThisType ( const DtVreFwlParameters * pars )

virtual

Inherits values from another parameters object of the same type.

Parameters

pars	The parameters object to inherit from

Inherits values from another parameters object of the same type.

References DtVreFwlParameters().

Friends And Related Symbol Documentation

◆ Controller

friend class Controller

friend

Friend class that needs direct access to parameter internals.

References Controller, and DtVreFwlParameters().

Referenced by Controller.

Member Data Documentation

◆ myAltitudeOffset

DtRwReal FwlCgfVrf::DtVreFwlParameters::myAltitudeOffset

protected

Altitude offset value.

Offset applied to the aircraft's altitude.

◆ myLateralControlDeadZone

DtRwReal FwlCgfVrf::DtVreFwlParameters::myLateralControlDeadZone

protected

Lateral control deadzone value.

Deadzone for lateral (roll) control inputs.

◆ myLongitudinalControlDeadZone

DtRwReal FwlCgfVrf::DtVreFwlParameters::myLongitudinalControlDeadZone

protected

Longitudinal control deadzone value.

Deadzone for longitudinal (pitch) control inputs.

◆ myPedalDeadZone

DtRwReal FwlCgfVrf::DtVreFwlParameters::myPedalDeadZone

protected

Pedal control deadzone value.

Deadzone for pedal (rudder) control inputs.

◆ myDefaultMaxLoad

DtRwReal FwlCgfVrf::DtVreFwlParameters::myDefaultMaxLoad

protected

Default maximum load factor.

Default maximum load factor (G-force) for the aircraft.

◆ myDefaultRollRate

DtRwReal FwlCgfVrf::DtVreFwlParameters::myDefaultRollRate

protected

Default roll rate.

Default roll rate for the aircraft.

◆ myDefaultVertSpeed

DtRwReal FwlCgfVrf::DtVreFwlParameters::myDefaultVertSpeed

protected

Default vertical speed.

Default vertical speed for the aircraft.

◆ myHighFidelityTerrainQueries

DtRwBoolean FwlCgfVrf::DtVreFwlParameters::myHighFidelityTerrainQueries

protected

Flag for high-fidelity terrain queries.

When true, high-fidelity terrain queries are used for this aircraft.

◆ myDynamicsParameterFile

DtRwString FwlCgfVrf::DtVreFwlParameters::myDynamicsParameterFile

private

File path to the aircraft dynamics parameters.

Path to the file containing detailed aircraft dynamics parameters.

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

include/vrfExtensions/vreVrfRtdobjparam/vreFwlParameters.h

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Friends

Constructor & Destructor Documentation

◆ DtVreFwlParameters() [1/2]

◆ DtVreFwlParameters() [2/2]

◆ ~DtVreFwlParameters()

Member Function Documentation

◆ creator()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ clone()

◆ type()

◆ getSimpleAirplaneParameterFile()

◆ getAltitudeOffset()

◆ getLateralControlDeadzone()

◆ getLongitudinalControlDeadzone()

◆ getPedalDeadzone()

◆ getDefaultMaxLoad()

◆ getDefaultRollRate()

◆ getDefaultVertSpeed()

◆ getHighFidelityTerrainQueries()

◆ getMaxAltitude()

◆ getMaxSpeed()

◆ inheritValues()

◆ inheritValuesFromThisType()

Friends And Related Symbol Documentation

◆ Controller

Member Data Documentation

◆ myAltitudeOffset

◆ myLateralControlDeadZone

◆ myLongitudinalControlDeadZone

◆ myPedalDeadZone

◆ myDefaultMaxLoad

◆ myDefaultRollRate

◆ myDefaultVertSpeed

◆ myHighFidelityTerrainQueries

◆ myDynamicsParameterFile