RlCgfVrf::DtVreRlParameters Class Reference

Detailed Description

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

#include <vreRlParameters.h>

Inheritance diagram for RlCgfVrf::DtVreRlParameters:

Public Member Functions
	DtVreRlParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL)
	DtVreRlParameters (const DtVreRlParameters &orig, const DtString &name, DtReaderWriterRegistry *parentRegistry)
virtual	~DtVreRlParameters () override
const DtVreRlParameters &	operator= (const DtVreRlParameters &orig)
const DtVreRlParameters &	operator= (const DtRotaryWingEntityParameters &orig)
virtual DtVrfObjectParameters *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
DtString	getVhSimpleRotorcraftParameterFile () const
DtReal	getAltitudeOffset () const
DtReal	getOnGroundTolerance () const
DtBoolean	getHighFidelityTerrainQueries () const
const DtRwReal &	getMaxAltitude () const
const DtRwReal &	getMaxSpeed () const
virtual bool	inheritValues (const DtVrfObjectParameters *benefactor) override
virtual void	inheritValuesFromThisType (const DtVreRlParameters *pars)

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

Protected Attributes
DtRwReal	myInitialDesiredSpeed
DtRwReal	myInitialDesiredAltitude
DtRwReal	myAltitudeOffset
DtRwReal	myOnGroundTolerance
DtRwBoolean	myHighFidelityTerrainQueries

Private Attributes
DtRwString	myRotorcraftParameterFile

Constructor & Destructor Documentation

DtVreRlParameters() [1/2]

RlCgfVrf::DtVreRlParameters::DtVreRlParameters	(	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 rotary-wing parameters object with values from the provided environment.

Referenced by DtVreRlParameters(), inheritValuesFromThisType(), operator=(), and operator=().

DtVreRlParameters() [2/2]

RlCgfVrf::DtVreRlParameters::DtVreRlParameters	(	const DtVreRlParameters &	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 DtVreRlParameters().

~DtVreRlParameters()

virtual RlCgfVrf::DtVreRlParameters::~DtVreRlParameters ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the parameters object.

Member Function Documentation

operator=() [1/2]

const DtVreRlParameters & RlCgfVrf::DtVreRlParameters::operator=

(

const DtVreRlParameters &

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 DtVreRlParameters().

operator=() [2/2]

const DtVreRlParameters & RlCgfVrf::DtVreRlParameters::operator=

(

const DtRotaryWingEntityParameters &

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 DtVreRlParameters().

clone()

virtual DtVrfObjectParameters * RlCgfVrf::DtVreRlParameters::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 RlCgfVrf::DtVreRlParameters::type ( ) const

overridevirtual

Gets the parameters type.

Returns

The type string for these parameters

Returns TS_Parameter as the parameters type identifier.

creator()

static DtVrfObjectParameters * RlCgfVrf::DtVreRlParameters::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.

getVhSimpleRotorcraftParameterFile()

DtString RlCgfVrf::DtVreRlParameters::getVhSimpleRotorcraftParameterFile

(

)

const

Gets the rotorcraft dynamics parameter file path.

Returns

The file path to the rotorcraft dynamics parameters

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

getAltitudeOffset()

DtReal RlCgfVrf::DtVreRlParameters::getAltitudeOffset

(

)

const

Gets the altitude offset.

Returns

The altitude offset value

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

getOnGroundTolerance()

DtReal RlCgfVrf::DtVreRlParameters::getOnGroundTolerance

(

)

const

Gets the on-ground tolerance value.

Returns

The on-ground tolerance value

Returns the tolerance value used to determine if the helicopter is on the ground. This affects landing behavior and ground effect simulation.

getHighFidelityTerrainQueries()

DtBoolean RlCgfVrf::DtVreRlParameters::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 helicopter.

getMaxAltitude()

const DtRwReal & RlCgfVrf::DtVreRlParameters::getMaxAltitude ( ) const

inline

Gets the maximum altitude limit.

Returns

Reference to the maximum altitude value

Returns the maximum altitude limit for the helicopter.

getMaxSpeed()

const DtRwReal & RlCgfVrf::DtVreRlParameters::getMaxSpeed ( ) const

inline

Gets the maximum speed limit.

Returns

Reference to the maximum speed value

Returns the maximum speed limit for the helicopter.

inheritValues()

virtual bool RlCgfVrf::DtVreRlParameters::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 RlCgfVrf::DtVreRlParameters::inheritValuesFromThisType ( const DtVreRlParameters * 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 DtVreRlParameters().

Member Data Documentation

myInitialDesiredSpeed

DtRwReal RlCgfVrf::DtVreRlParameters::myInitialDesiredSpeed

protected

Initial desired speed value.

The initial desired speed for the helicopter upon activation.

myInitialDesiredAltitude

DtRwReal RlCgfVrf::DtVreRlParameters::myInitialDesiredAltitude

protected

Initial desired altitude value.

The initial desired altitude for the helicopter upon activation.

myAltitudeOffset

DtRwReal RlCgfVrf::DtVreRlParameters::myAltitudeOffset

protected

Altitude offset value.

Offset applied to the helicopter's altitude.

myOnGroundTolerance

DtRwReal RlCgfVrf::DtVreRlParameters::myOnGroundTolerance

protected

On-ground tolerance value.

Tolerance value used to determine if the helicopter is on the ground. This affects landing behavior and ground effect simulation.

myHighFidelityTerrainQueries

DtRwBoolean RlCgfVrf::DtVreRlParameters::myHighFidelityTerrainQueries

protected

Flag for high-fidelity terrain queries.

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

myRotorcraftParameterFile

DtRwString RlCgfVrf::DtVreRlParameters::myRotorcraftParameterFile

private

File path to the rotorcraft dynamics parameters.

Path to the file containing detailed rotorcraft dynamics parameters.

---

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

• include/vrfExtensions/vreVrfRtdobjparam/vreRlParameters.h