vreVrfTurretedBalGunPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfTurretedBalGunPSR.h
//! \ingroup vreVrfobjcore
//! \brief Turreted ballistic gun process state repository for VREngage
//!
//! This file defines the DtVreVrfTurretedBalGunPSR class, which extends the basic turreted
//! ballistic gun PSR to provide VREngage-specific functionality. It adds support for
//! VREngage-specific munition loading and tracking features.
 
#pragma once
 
#include "vreVrfobjcore/export.h"
#include "vreVrfobjcore/vreMunitionLoader.h"
 
#include <vrfobjcore/vrfTurretedBalGunPSR.h>
 
namespace makVre
{
//! \brief Default name for the VREngage turreted ballistic gun PSR
const char DtVreVrfTurretedBalGunPSRDefaultName[] = "vre-vrf-turreted-ballistic-gun-process-state-repository-default";
 
//! \brief Type identifier string for the VREngage turreted ballistic gun PSR
const char DtVreVrfTurretedBalGunPSRType[] = "vre-vrf-turreted-ballistic-gun-process-state-repository";
 
//! \brief Extended turreted ballistic gun process state repository for VREngage
//!
//! This class extends the basic turreted ballistic gun PSR to provide VREngage-specific
//! functionality. It uses a VREngage-specific munition loader to support additional
//! features such as tracking and displaying ammunition counts in user interfaces.
class VREVRFOBJCORE_DLL DtVreVrfTurretedBalGunPSR : public DtVrfTurretedBalGunPSR
{
protected:
   //! \brief Protected default constructor (not for direct use)
   //!
   //! Default constructor is protected and only intended for use by derived classes.
   //! Normal instantiation should use the public constructor with a VRF object.
   DtVreVrfTurretedBalGunPSR();
 
public:
   //! \brief Constructor with VRF object and optional name
   //! \param vrfObject Pointer to the local object this PSR is associated with
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new turreted ballistic gun PSR for the specified VRF object.
   //! Initializes the VREngage-specific munition loader for ammunition tracking.
   DtVreVrfTurretedBalGunPSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source PSR to copy from
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new turreted ballistic gun PSR as a copy of the provided original.
   DtVreVrfTurretedBalGunPSR(const DtVreVrfTurretedBalGunPSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source PSR to copy from
   //! \return Reference to this PSR after assignment
   //!
   //! Assigns the contents of the provided PSR to this one.
   const DtVreVrfTurretedBalGunPSR& operator=(const DtVreVrfTurretedBalGunPSR& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the PSR.
   virtual ~DtVreVrfTurretedBalGunPSR() override;
 
   //! \brief Gets the type identifier for this PSR
   //! \return String identifying this PSR type
   //!
   //! Returns a unique type identifier string for this PSR type.
   //! Will return DtVreVrfTurretedBalGunPSRType.
   virtual DtString type() const override;
 
   //! \brief Creates a clone of this PSR
   //! \param rwName Optional reader/writer name for the clone
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to a new PSR that is a clone of this one
   //!
   //! Creates a new turreted ballistic gun PSR as a deep copy of this one.
   virtual DtVrfProcessStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Factory function to create a new instance of this PSR
   //! \param name The reader/writer name for the new instance
   //! \param vrfObject Pointer to the local object this PSR will be associated with
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a newly created PSR instance
   //!
   //! Static factory function used by the PSR creation system to instantiate
   //! new instances of this PSR type.
   static DtVrfProcessStateRepository* creator(
      const DtString& name, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
   //! \brief Gets the munition loader (const version)
   //! \return Const reference to the munition loader
   //!
   //! Returns a constant reference to the VREngage-specific munition loader.
   //! This loader provides extended functionality for tracking ammunition counts.
   virtual const DtVrfMunitionLoader& munitionLoader() const override;
 
   //! \brief Gets the munition loader (non-const version)
   //! \return Reference to the munition loader
   //!
   //! Returns a reference to the VREngage-specific munition loader, allowing
   //! modification of its state. This loader provides extended functionality
   //! for tracking ammunition counts.
   virtual DtVrfMunitionLoader& munitionLoader() override;
 
protected:
   //! \brief VREngage-specific munition loader
   //!
   //! Instance of the VREngage-specific munition loader to support publishing
   //! ammunition counts and other extended functionality. This loader tracks
   //! and publishes the amount of ammunition left in the magazine for display
   //! in user interfaces.
   DtVreMunitionLoader myVreMunitionLoader;
};
} // namespace makVre