vreParachuteActuatorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreParachuteActuatorDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Parachute actuator descriptor for VREngage
//!
//! This file defines the DtVreParachuteActuatorDescriptor class, which configures
//! parachute actuator components in VREngage. It extends the base parachute actuator
//! descriptor to add oxygen consumption parameters based on altitude.
 
#pragma once
#include "vreVrfobjparam/export.h"
#include <vrfobjparam/parachuteActuatorDescriptor.h>
 
class DtReaderWriterRegistry;
 
namespace makVre
{
//! \brief Type identifier string for the parachute actuator descriptor
const char DtVreParachuteActuatorDescriptorType[] = "vre-parachute-actuator-descriptor";
 
//! \brief Parachute actuator descriptor for VREngage
//!
//! 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.
class VREVRFOBJPARAM_DLL DtVreParachuteActuatorDescriptor : public DtParachuteActuatorDescriptor
{
public:
   //! \brief Constructor with component name
   //! \param name The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new parachute actuator descriptor with the specified name.
   DtVreParachuteActuatorDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new parachute actuator descriptor as a copy of the provided original.
   DtVreParachuteActuatorDescriptor(
      const DtVreParachuteActuatorDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtVreParachuteActuatorDescriptor& operator=(const DtVreParachuteActuatorDescriptor& orig);
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return 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.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtVreParachuteActuatorDescriptor() override;
 
   //! \brief Sets the oxygen consumption rate
   //! \param val The oxygen consumption rate in units per minute
   //!
   //! Sets the rate at which oxygen is consumed when operating above the
   //! oxygen use altitude threshold.
   virtual void setOxygenUsePerMinute(double val);
 
   //! \brief Gets the oxygen consumption rate
   //! \return The oxygen consumption rate in units per minute
   //!
   //! Returns the rate at which oxygen is consumed when operating above the
   //! oxygen use altitude threshold.
   virtual double oxygenUsePerMinute() const;
 
   //! \brief Sets the oxygen use altitude threshold
   //! \param val The altitude threshold in meters
   //!
   //! Sets the altitude threshold above which oxygen begins to be consumed.
   virtual void setOxygenUseAltitude(double val);
 
   //! \brief Gets the oxygen use altitude threshold
   //! \return The altitude threshold in meters
   //!
   //! Returns the altitude threshold above which oxygen begins to be consumed.
   virtual double oxygenUseAltitude() const;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
protected:
   //! \brief Oxygen consumption rate in units per minute
   //!
   //! The rate at which oxygen is consumed when operating above the
   //! oxygen use altitude threshold.
   DtRwReal myOxygenUsePerMinute;
 
   //! \brief Oxygen use altitude threshold in meters
   //!
   //! The altitude threshold above which oxygen begins to be consumed.
   DtRwReal myOxygenUseAltitude;
};
 
} // namespace makVre