vreGroundVehicleSetController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreGroundVehicleSetController.h
//! \ingroup vreVrfmodel
//! \brief Controller for managing sets of ground vehicles
//!
//! This file defines the DtVreGroundVehicleSetController class which extends
//! the base ground vehicle set controller with VRE-specific functionality. It adds
//! the ability to handle set player control data requests for ground vehicles.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSetController.h"
 
#include <vrfmodel/groundVehicleSetController.h>
 
namespace makVre
{
//! \brief Type identifier for the VRE ground vehicle set controller component
const char DtVreGroundVehicleSetControllerType[] = "vre-ground-vehicle-set-controller";
 
//! \brief Controller for managing sets of ground vehicles
//!
//! DtVreGroundVehicleSetController extends the base set controller functionality
//! specifically for ground vehicles. It provides specialized commands and behavior
//! for ground vehicle entities, allowing them to be controlled as a coordinated set.
//! This controller adds the ability to handle set player control data requests
//! for ground vehicles in VRE-specific contexts.
class VREVRFMODEL_DLL DtVreGroundVehicleSetController : public DtVreSetController<DtGroundVehicleSetController>
{
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 ground vehicle set controller component with the specified parameters.
   DtVreGroundVehicleSetController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the ground vehicle set controller component.
   virtual ~DtVreGroundVehicleSetController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreGroundVehicleSetControllerType)
   //!
   //! 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.
   DtVreGroundVehicleSetController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreGroundVehicleSetController(const DtVreGroundVehicleSetController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreGroundVehicleSetController& operator=(const DtVreGroundVehicleSetController& orig);
};
 
} // namespace makVre