vreAirVehicleSetController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreAirVehicleSetController.h
//! \ingroup vreVrfmodel
//! \brief Controller for managing sets of air vehicles
//!
//! This file defines the DtVreAirVehicleSetController class which extends the base
//! set controller functionality for air vehicles. It provides specialized commands
//! and behaviors specific to air vehicles, such as altitude control.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSetController.h"
 
#include <vrfmodel/airVehicleSetController.h>
 
namespace makVre
{
//! \brief Type identifier for the VRE air vehicle set controller component
const char DtVreAirVehicleSetControllerType[] = "vre-air-vehicle-set-controller";
 
//! \brief Controller for managing sets of air vehicles
//!
//! DtVreAirVehicleSetController extends the base set controller functionality
//! specifically for air vehicles. It provides specialized commands and behavior
//! for air vehicles, such as altitude control and location setting. This controller
//! manages multiple air vehicle entities as a coordinated set.
class VREVRFMODEL_DLL DtVreAirVehicleSetController : public DtVreSetController<DtAirVehicleSetController>
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new air vehicle set controller component with the specified parameters.
   DtVreAirVehicleSetController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the air vehicle set controller component.
   virtual ~DtVreAirVehicleSetController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreAirVehicleSetControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Processes a set altitude message
   //! \param msg The simulation message containing the altitude setting request
   //!
   //! Handles messages requesting to set the altitude for all air vehicles in the set.
   //! Extracts the altitude value from the message and applies it to the set members.
   virtual void processSetAltitude(DtSimMessage* msg) override;
   //! \brief Sets the location for air vehicles in the set
   //! \param geocentricLocation The new geocentric location vector
   //! \param dataAvailable Output parameter set to true if the location was successfully set
   //!
   //! Sets the geocentric location for all air vehicles in the set. The method updates
   //! the dataAvailable flag to indicate whether the location was successfully applied.
   virtual void setLocation(DtVector geocentricLocation, bool& dataAvailable);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreAirVehicleSetController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreAirVehicleSetController(const DtVreAirVehicleSetController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreAirVehicleSetController& operator=(const DtVreAirVehicleSetController& orig);
};
 
} // namespace makVre