vreFixedWingEntitySetController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreFixedWingEntitySetController.h
//! \ingroup vreVrfmodel
//! \brief Controller for managing sets of fixed wing entities
//!
//! This file defines the DtVreFixedWingEntitySetController class which extends
//! the base set controller specifically for fixed wing aircraft entities. It enables
//! coordinated control over groups of fixed wing aircraft in a simulation.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSetController.h"
 
#include <vrfmodel/fixedWingEntitySetController.h>
 
namespace makVre
{
//! \brief Type identifier for the VRE fixed wing entity set controller component
const char DtVreFixedWingEntitySetControllerType[] = "vre-fixed-wing-entity-set-controller";
 
//! \brief Controller for managing sets of fixed wing aircraft entities
//!
//! DtVreFixedWingEntitySetController extends the base set controller functionality
//! specifically for fixed wing aircraft. It provides specialized commands and behavior
//! for fixed wing aircraft entities, allowing them to be controlled as a coordinated
//! set. This controller manages formation flying, coordinated movement, and other
//! fixed-wing-specific operations for multiple aircraft.
class VREVRFMODEL_DLL DtVreFixedWingEntitySetController : public DtVreSetController<DtFixedWingEntitySetController>
{
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 fixed wing entity set controller component with the specified parameters.
   DtVreFixedWingEntitySetController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the fixed wing entity set controller component.
   virtual ~DtVreFixedWingEntitySetController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreFixedWingEntitySetControllerType)
   //!
   //! 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);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreFixedWingEntitySetController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreFixedWingEntitySetController(const DtVreFixedWingEntitySetController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreFixedWingEntitySetController& operator=(const DtVreFixedWingEntitySetController& orig);
};
 
} // namespace makVre