VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtVreParachuteActuatorDescriptor Class Reference

Detailed Description

This class defines a descriptor for parachute actuator components in VREngage. It extends the base parachute actuator descriptor to add configuration for oxygen consumption during high-altitude parachute operations. The descriptor specifies both the rate of oxygen consumption and the altitude threshold at which oxygen begins to be consumed.

#include <vreParachuteActuatorDescriptor.h>

Inheritance diagram for makVre::DtVreParachuteActuatorDescriptor:
[legend]

Public Member Functions

 DtVreParachuteActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtVreParachuteActuatorDescriptor (const DtVreParachuteActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtVreParachuteActuatorDescriptoroperator= (const DtVreParachuteActuatorDescriptor &orig)
 
virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=0) const override
 
virtual ~DtVreParachuteActuatorDescriptor () override
 
virtual void setOxygenUsePerMinute (double val)
 
virtual double oxygenUsePerMinute () const
 
virtual void setOxygenUseAltitude (double val)
 
virtual double oxygenUseAltitude () const
 

Static Public Member Functions

static DtComponentDescriptor * creator ()
 

Protected Attributes

DtRwReal myOxygenUsePerMinute
 
DtRwReal myOxygenUseAltitude
 

Constructor & Destructor Documentation

◆ DtVreParachuteActuatorDescriptor() [1/2]

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

Constructor with component name.

Parameters
nameThe name of this component
parentRegistryParent registry for reader/writer functionality (optional)

Creates a new parachute actuator descriptor with the specified name.

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

◆ DtVreParachuteActuatorDescriptor() [2/2]

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

Copy constructor.

Parameters
origThe source descriptor to copy from
parentRegistryParent registry for reader/writer functionality (optional)

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

References DtVreParachuteActuatorDescriptor().

◆ ~DtVreParachuteActuatorDescriptor()

virtual makVre::DtVreParachuteActuatorDescriptor::~DtVreParachuteActuatorDescriptor ( )
overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

Member Function Documentation

◆ operator=()

DtVreParachuteActuatorDescriptor & makVre::DtVreParachuteActuatorDescriptor::operator= ( const DtVreParachuteActuatorDescriptor & orig)

Assignment operator.

Parameters
origThe source descriptor to copy from
Returns
Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreParachuteActuatorDescriptor().

◆ clone()

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

Creates a clone of this descriptor.

Parameters
parentRegistryParent registry for reader/writer functionality (optional)
Returns
Pointer to a new descriptor that is a clone of this one

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

◆ setOxygenUsePerMinute()

virtual void makVre::DtVreParachuteActuatorDescriptor::setOxygenUsePerMinute ( double val)
virtual

Sets the oxygen consumption rate.

Parameters
valThe oxygen consumption rate in units per minute

Sets the rate at which oxygen is consumed when operating above the oxygen use altitude threshold.

◆ oxygenUsePerMinute()

virtual double makVre::DtVreParachuteActuatorDescriptor::oxygenUsePerMinute ( ) const
virtual

Gets the oxygen consumption rate.

Returns
The oxygen consumption rate in units per minute

Returns the rate at which oxygen is consumed when operating above the oxygen use altitude threshold.

◆ setOxygenUseAltitude()

virtual void makVre::DtVreParachuteActuatorDescriptor::setOxygenUseAltitude ( double val)
virtual

Sets the oxygen use altitude threshold.

Parameters
valThe altitude threshold in meters

Sets the altitude threshold above which oxygen begins to be consumed.

◆ oxygenUseAltitude()

virtual double makVre::DtVreParachuteActuatorDescriptor::oxygenUseAltitude ( ) const
virtual

Gets the oxygen use altitude threshold.

Returns
The altitude threshold in meters

Returns the altitude threshold above which oxygen begins to be consumed.

◆ creator()

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

◆ myOxygenUsePerMinute

DtRwReal makVre::DtVreParachuteActuatorDescriptor::myOxygenUsePerMinute
protected

Oxygen consumption rate in units per minute.

The rate at which oxygen is consumed when operating above the oxygen use altitude threshold.

◆ myOxygenUseAltitude

DtRwReal makVre::DtVreParachuteActuatorDescriptor::myOxygenUseAltitude
protected

Oxygen use altitude threshold in meters.

The altitude threshold above which oxygen begins to be consumed.


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