ControlValveUseCases.hpp

Go to the documentation of this file.

#ifndef IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLVALVEUSECASES_HPP_
#define IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLVALVEUSECASES_HPP_
 
#include "model/control/enums.hpp"
#include "model/control/structs.hpp"
#include "ui/panels/editor/control/PanelControlValveFactory.hpp"
#include "ui/panels/editor/control/structs.hpp"
 
namespace iv::panels::control
{
 
struct UseCaseResult
{
    bool isSuccessful {false};
 
    std::optional<std::string> successMsg;
    std::optional<std::string> confirmationRequest;
    std::optional<iv::types::errorMessage> errorMsg;
};
 
class ControlValveUseCases
{
public:
    ControlValveUseCases() = delete;
 
    static UseCaseResult isValidValveOrder(const iv::types::control::valve::valveOrder &valveOrder);
    static UseCaseResult isValidValveSystemAndOrder(iv::types::control::valve::valveOrder newValveOrder,
                                                    iv::model::control::valve::eValveSystem newValveSystem);
 
    static UseCaseResult isValidValveChannelsLink(const iv::panels::control::valve::ValveData &valveData,
                                                  const iv::model::control::valve::eValveType &valveType);
    static UseCaseResult isValidValveTypeAndLomId(const iv::model::control::valve::eValveType &valveType,
                                                  const iv::types::unitId &lomId);
 
    static UseCaseResult addValve(const iv::panels::control::valve::ValveData &valveData);
    static UseCaseResult updateValve(const iv::panels::control::valve::ValveData &valveData,
                                     const iv::types::control::valve::valveId &oldValveId);
    static UseCaseResult removeValve(const iv::types::control::valve::valveId &oldValveId,
                                     const iv::panels::control::RemoveValveResult &removeValveResult);
 
    static UseCaseResult canGenerateLogic(const iv::types::control::valve::valveId &valveId);
    static std::map<iv::logic::ParamId, iv::panels::control::LibraryLinkedChannel>
    getLinkedLibraryChannels(const iv::types::control::valve::valveId &valveId,
                             iv::types::logic::customBlockId customBlockId);
    static std::map<iv::types::logic::customBlockId, std::string> getAvailableCustomBlocksNames();
    static UseCaseResult
    generateLogic(const types::control::valve::valveId &valveId,
                  const iv::types::logic::customBlockId &selectedCustomBlockId,
                  std::map<iv::logic::ParamId, iv::panels::control::LibraryLinkedChannel> &channelsLinked);
};
 
}// namespace iv::panels::control
 
#endif//IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLVALVEUSECASES_HPP_