DObject.h

Go to the documentation of this file.

/* ***********************************************************************
//
//   Copyright (C) 2025 -- The 4D-STAR Collaboration
//   File Author: Emily Boudreaux
//   Last Modified: March 17, 2025
//
//   4DSSE is free software; you can use it and/or modify
//   it under the terms and restrictions the GNU General Library Public
//   License version 3 (GPLv3) as published by the Free Software Foundation.
//
//   4DSSE is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU Library General Public License for more details.
//
//   You should have received a copy of the GNU Library General Public License
//   along with this software; if not, write to the Free Software
//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// *********************************************************************** */
#ifndef DOBJECT_H
#define DOBJECT_H
 
#include <variant>
#include <memory>
#include <vector>
#include <string>
#include <mutex>
#include <map>
#include <functional>


class DObject {
public:
    using DataType = std::variant<
        bool, short int, int, long int, float, double, 
        long double, std::string, std::monostate, std::vector<int>,
        std::vector<float>, std::vector<double>, std::vector<std::string>,
        std::vector<std::vector<int>>, std::vector<std::vector<float>>,
        std::vector<std::vector<double>>,
        std::vector<std::vector<std::vector<int>>>,
        std::vector<std::vector<std::vector<float>>>,
        std::vector<std::vector<std::vector<double>>>
    >;
 
    // Mapping of data types to their string representations
    std::map<int, std::string> dataTypeMap = {
        {0, "bool"}, {1, "short int"}, {2, "int"}, {3, "long int"}, {4, "float"},
        {5, "double"}, {6, "long double"}, {7, "string"}, {8, "std::monostate"},
        {9, "vector<int>"}, {10, "vector<float>"}, {11, "vector<double>"},
        {12, "vector<string>"}, {13, "vector<vector<int>"},
        {14, "vector<vector<float>"}, {15, "vector<vector<double>"},
        {16, "vector<vector<vector<int>>"}, {17, "vector<vector<vector<float>>"},
        {18, "vector<vector<vector<double>>"}
    };
 

    using Plugin = std::function<void(DObject&)>;

    DObject();

    DObject(const DataType& data);

    const DataType& getData() const noexcept;

    template <typename T>
    T getDataAs() const {
        if (std::holds_alternative<T>(data_)) {
            return std::get<T>(data_);
        } else {
            throw std::bad_variant_access();
        }
    }

    void setData(const DataType& data);

    void setDebugging(bool enableDebug);

    bool isDebuggingEnabled() const noexcept;

    int setErrorCode(int code) noexcept;

    int getErrorCode() const noexcept;
 

    void registerPlugin(const std::string& id, Plugin plugin);

    void unregisterPlugin(const std::string& id);

    void runPlugin(const std::string& id);

    void runAllPlugins();

    friend std::ostream& operator<<(std::ostream& os, const DObject& obj);
 
private:
    DataType data_;                              
    bool debugEnabled_ = false;                  
    int errorCode_ = 0;                          
    std::map<std::string, Plugin> plugins_;      
};
 
#endif // DOBJECT_H