OnlineVariables.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_ONLINEVARIABLES_HPP_
#define IV_SRC_MIMICS_ONLINEVARIABLES_HPP_
 
#include "channels/AbstractChannel.hpp"
#include "filehandlers/xmlFile.hpp"
#include "logic/CParamOnline.hpp"
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace iv::mimics
{
 
enum class eOnlineVariableType
{
    AnalogChannel,
    ParameterOnline,
};
 
struct OnlineVariable
{
    eOnlineVariableType type {eOnlineVariableType::ParameterOnline};
    iv::types::onlineVariableId nameVariable;
 
    std::optional<std::weak_ptr<iv::channels::AbstractChannel>> analogChannel;
    std::optional<std::weak_ptr<CParamOnline>> parameterOnline;
 
    std::optional<double> m_value;
 
    [[nodiscard]] std::string getStringValue() const;
};
 
class OnlineVariables
{
public:
    OnlineVariables() = default;
    ~OnlineVariables() = default;
    OnlineVariables(const OnlineVariables &) = default;
    OnlineVariables(OnlineVariables &&) = default;
    OnlineVariables &operator=(const OnlineVariables &) = default;
    OnlineVariables &operator=(OnlineVariables &&) = default;
 
    bool load(const iv::file::xml::node &nodeOnlineVariables);
    bool save(iv::file::xml::node &nodeOnlineVariables) const;
 
    void addVariable(const std::shared_ptr<OnlineVariable> &variable);
    [[nodiscard]] std::weak_ptr<OnlineVariable> getVariable(const iv::types::onlineVariableId &variableName) const;
    [[nodiscard]] std::weak_ptr<OnlineVariable> getVariable(uint64_t variableIndex) const;
    [[nodiscard]] std::weak_ptr<OnlineVariable>
    getVariableByParamExternalId(const iv::types::externalParameterOnlineId &paramOnlineExternalId) const;
    [[nodiscard]] uint64_t numVariables() const;
 
    [[nodiscard]] const std::vector<std::shared_ptr<OnlineVariable>> &getAllVariables() const;
 
    void removeVariable(uint64_t variableIndex);
    void removeVariable(const iv::types::onlineVariableId &variableName);
 
    [[nodiscard]] bool hasVariables() const;
 
    bool uploadVariablesValues() const;
    bool downloadVariablesValues() const;
 
    [[nodiscard]] bool allVariablesUploadedCorrectly() const;
 
    std::vector<std::shared_ptr<OnlineVariable>> m_variables;
 
private:
    struct DefaultValues
    {
        static constexpr std::string string {};
        static constexpr std::string type {"AnalogChannel"};
    };
    struct Keys
    {
        static constexpr std::string_view type {"Type"};
        static constexpr std::string_view name {"Name"};
        static constexpr std::string_view analogChannel {"AnalogChannel"};
        static constexpr std::string_view parameterOnline {"ParameterOnline"};
    };
    struct Sections
    {
        static constexpr std::string_view variables {"Variables"};
        static constexpr std::string_view variable {"Variable"};
    };
};
 
}// namespace iv::mimics
 
#endif//IV_SRC_MIMICS_ONLINEVARIABLES_HPP_