vreTaskSetBuilder.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreTaskSetBuilder.h
//! \ingroup vreVrfobjcore
//! \brief Task set builder class for VREngage
//!
//! This file defines the DtVreTaskSetBuilder class, which provides functionality for
//! dynamically building tasks and sets based on parameters provided in a map. It extends
//! the base task set builder with VREngage-specific functionality for creating simulation
//! tasks and data requests.
 
#pragma once
 
#include <vreVrfobjcore/export.h>
 
#include <vrflua/taskSetBuilder.h>
 
//! \brief Class for dynamically building tasks and sets in VREngage
//!
//! This class extends the base task set builder to provide VREngage-specific
//! functionality for dynamically creating simulation tasks and data requests.
//! It builds tasks and sets based on parameters provided in a map of DtReaderWriters,
//! allowing for flexible task creation in Lua scripts and other contexts.
class VREVRFOBJCORE_DLL DtVreTaskSetBuilder : public DtTaskSetBuilder
{
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without a scripted task manager.
   DtVreTaskSetBuilder();
 
   //! \brief Copy constructor (not implemented)
   //! \param orig The source builder to copy from
   //!
   //! Copy constructor is private and not implemented to prevent copying.
   DtVreTaskSetBuilder(const DtVreTaskSetBuilder& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source builder to copy from
   //! \return Reference to this builder after assignment
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreTaskSetBuilder& operator=(const DtVreTaskSetBuilder& orig);
 
public:
   //! \brief Constructor with scripted task manager
   //! \param scriptedTaskManager Pointer to the scripted task manager
   //!
   //! Creates a new task set builder associated with the specified scripted task manager.
   //! The scripted task manager provides access to task and set creation facilities.
   DtVreTaskSetBuilder(const DtScriptedTaskManager* scriptedTaskManager);
 
   //! \brief Type definition for parameter map
   //!
   //! Maps parameter names to their corresponding DtReaderWriter values.
   //! This is used to pass parameters to task and set creation methods.
   using ParamMap = std::map<DtString, DtReaderWriter*>;
 
   //! \brief Builds a simulation task
   //! \param taskType The type of task to build
   //! \param paremeters Map of parameter names to their values
   //! \return Pointer to the newly created task, or nullptr if creation failed
   //!
   //! Creates a new simulation task of the specified type, using the parameters
   //! provided in the parameter map. The returned task is owned by the caller
   //! and must be deleted when no longer needed.
   virtual DtSimTask* buildTask(const DtSimTaskMessageType& taskType, const ParamMap& paremeters);
 
   //! \brief Builds a set data request
   //! \param setType The type of set to build
   //! \param paremeters Map of parameter names to their values
   //! \return Pointer to the newly created set data request, or nullptr if creation failed
   //!
   //! Creates a new set data request of the specified type, using the parameters
   //! provided in the parameter map. The returned request is owned by the caller
   //! and must be deleted when no longer needed.
   virtual DtSetDataRequest* buildSet(const DtSetMessageType& setType, const ParamMap& paremeters);
 
protected:
   //! \brief Fills a reader/writer parameter from the parameter map
   //! \param rw Pointer to the reader/writer to fill
   //! \param parameters Map of available parameters
   //! \param usedParam Output parameter that will receive the name of the parameter used
   //! \return True if the parameter was successfully filled, false otherwise
   //!
   //! Attempts to fill the specified reader/writer from the parameter map. If successful,
   //! usedParam will be set to the name of the parameter that was used to fill the
   //! reader/writer. This method is used internally by buildTask and buildSet to
   //! populate task and set parameters from the provided parameter map.
   virtual bool fillInParameter(DtReaderWriter* rw, const ParamMap& parameters, DtString& usedParam);
};