topAndDirectLauncherPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file topAndDirectLauncherPSR.h
//! \ingroup vreVrfobjcore
//! \brief Javelin launcher process state repository for VREngage
//!
//! This file defines the DtJavelinLauncherPSR class, which provides a process state repository
//! for Javelin missile launcher components in VREngage. It maintains the attack mode state
//! (top attack or direct attack) for a Javelin missile launcher.
 
//! Maintains the attack mode state (top attack or direct attack) for a missile launcher.
 
#pragma once
 
#include "vreVrfObjcore/export.h"
 
#include <vrfobjcore/vrfWeaponPSR.h>
 
// Forward declarations
 
namespace makVre
{
const char DtTopAndDirectLauncherPSRType[] = "top-and-direct-launcher-PSR";
 
class VREVRFOBJCORE_DLL DtTopAndDirectLauncherPSR : public DtVrfWeaponPSR
{
protected:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is protected and not implemented to prevent
   //! creation of instances without proper initialization.
   DtTopAndDirectLauncherPSR();
 
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 Javelin launcher PSR for the specified VRF object.
   DtTopAndDirectLauncherPSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   DtTopAndDirectLauncherPSR(const DtTopAndDirectLauncherPSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   const DtTopAndDirectLauncherPSR& operator=(const DtTopAndDirectLauncherPSR& orig);
 
   virtual ~DtTopAndDirectLauncherPSR() 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 Javelin launcher PSR as a deep copy of this one.
   virtual DtVrfProcessStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! Returns the string type of the repository, DtTopAndDirectLauncherPSRType.
   virtual DtString type() const override;
 
   // Accessor/mutator for launcher attack mode.
   virtual void setMissileFlightMode(const DtString& mode);
 
   //! \brief Gets the missile flight mode
   //! \return String identifying the current flight mode ("top" or "direct")
   //!
   //! Returns the current flight mode setting for Javelin missiles launched from this weapon.
   virtual DtString missileFlightMode() const;
 
   //! Create an instance of a DtTopAndDirectLauncherPSR
   static DtVrfProcessStateRepository* creator(
      const DtString& name, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
protected:
   //! \brief The missile flight mode setting
   //!
   //! Stores the current flight mode for Javelin missiles launched from this weapon.
   //! Valid values are "top" for top attack mode and "direct" for direct attack mode.
   DtRwString myMissileFlightMode;
};
} // namespace makVre