vreAmmunitionParams.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreAmmunitionParams.h
//! \ingroup vreVrfobjparam
//! \brief Ammunition parameters for VREngage
//!
//! This file defines the DtVreAmmunitionParams class, which manages ammunition
//! parameter entries for VREngage simulations. It specializes the base ammunition
//! parameters to handle VREngage-specific ammunition properties.
 
#pragma once
 
#include <vreVrfobjparam/export.h>
#include <vrfobjparam/ammunitionParams.h>
 
 
namespace makVre
{
class DtVreAmmunitionParamsEntry;
 
//! \brief Ammunition parameters for VREngage weapon systems
//!
//! This class manages a collection of ammunition parameter entries that
//! configure the DtVreAmmunitionManager. It extends the base ammunition parameters
//! class to support VREngage-specific ammunition properties and behaviors.
class VREVRFOBJPARAM_DLL DtVreAmmunitionParams : public DtAmmunitionParams
{
public:
   //! \brief Constructor with reader/writer name
   //! \param rwName The name of this parameters object
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ammunition parameters object with the specified name.
   DtVreAmmunitionParams(const DtString& rwName, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with reader/writer name as symbol string
   //! \param rwName The name of this parameters object as a symbol string
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ammunition parameters object with the specified name.
   DtVreAmmunitionParams(const DtSymbolString& rwName, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor
   //! \param orig The source parameters object to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ammunition parameters object as a copy of the provided original.
   DtVreAmmunitionParams(const DtVreAmmunitionParams& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Assignment operator
   //! \param orig The source parameters object to copy from
   //! \return Reference to this parameters object after assignment
   //!
   //! Assigns the contents of the provided parameters object to this one.
   DtVreAmmunitionParams& operator=(const DtVreAmmunitionParams& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the parameters object.
   virtual ~DtVreAmmunitionParams() override;
 
   //! \brief Empties the ammunition parameter entries list
   //! \param clearMemory Whether to also clear allocated memory
   //!
   //! Removes all ammunition parameter entries from the list, optionally
   //! freeing the associated memory.
   virtual void emptyList(bool clearMemory) override;
 
   //! \brief Copies ammunition parameter entries from another list
   //! \param source The source ammunition parameters to copy from
   //!
   //! Copies all ammunition parameter entries from the provided source parameters.
   virtual void copyList(const DtAmmunitionParams& source) override;
 
   //! \brief Creates a new ammunition parameter entry
   //! \return Pointer to a newly created ammunition parameter entry
   //!
   //! Factory method that creates a new VREngage-specific ammunition parameter entry.
   //! This method enables creating the appropriate derived entry type for VREngage.
   virtual DtAmmunitionParamsEntry* createAmmunitionTableEntry() const override;
 
protected:
   //! \brief Processes input data to create ammunition parameter entries
   //! \param args Input arguments to process
   //! \param searchPaths Search paths for resolving file references
   //! \param variableBindings Variable bindings for resolving script variables
   //! \return Object pointer containing the processed data
   //!
   //! Constructs a DtVreAmmunitionParamsEntry object, reads data from
   //! the MTL stream, and adds it to the parameters list.
   virtual DtlObjPtr getData(DtlObjPtr args,
      const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;
};
} // namespace makVre