ControlDamperUseCases.hpp

Go to the documentation of this file.

#ifndef IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLDAMPERUSECASES_HPP_
#define IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLDAMPERUSECASES_HPP_
 
#include "model/control/enums.hpp"
#include "model/control/structs.hpp"
#include "ui/panels/editor/control/PanelControlDamperFactory.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 ControlDamperUseCases
{
public:
    ControlDamperUseCases() = delete;
 
    static UseCaseResult isValidDamperChannelsLink(const iv::panels::control::damper::DamperData &damperData,
                                                   const iv::model::control::damper::eDamperType &damperType);
    static UseCaseResult isValidDamperTypeAndLomId(const iv::model::control::damper::eDamperType &damperType,
                                                   const iv::types::unitId &lomId);
 
    static UseCaseResult addDamper(const iv::panels::control::damper::DamperData &damperData);
    static UseCaseResult updateDamper(const iv::panels::control::damper::DamperData &damperData,
                                      const iv::panels::control::damper::DamperData &oldDamperData);
    static UseCaseResult removeDamper(const iv::types::control::damper::damperId &oldDamperId,
                                      const iv::panels::control::RemoveDamperResult &removeDamperResult);
 
    static UseCaseResult canAddDamper(const iv::types::control::damper::damperOrder &damperOrder,
                                      const iv::types::control::damper::damperDescription &damperDescription);
 
    static UseCaseResult canUpdateDamper(const iv::panels::control::damper::DamperData &oldDamperData,
                                         const iv::types::control::damper::damperOrder &damperOrder,
                                         const iv::types::control::damper::damperDescription &damperDescription);
 
    static UseCaseResult canGenerateLogic(const iv::types::control::damper::damperId &damperId);
    static std::map<iv::logic::ParamId, iv::panels::control::LibraryLinkedChannel>
    getLinkedLibraryChannels(const iv::types::control::damper::damperId &damperId,
                             iv::types::logic::customBlockId customBlockId);
    static std::map<iv::types::logic::customBlockId, std::string> getAvailableCustomBlocksNames();
    static UseCaseResult
    generateLogic(const types::control::damper::damperId &damperId,
                  const iv::types::logic::customBlockId &selectedCustomBlockId,
                  std::map<iv::logic::ParamId, iv::panels::control::LibraryLinkedChannel> &channelsLinked);
 
private:
    static UseCaseResult isValidDamperOrder(const iv::types::control::damper::damperOrder &newDamperOrder);
    static UseCaseResult
    isValidDamperDescription(const iv::types::control::damper::damperDescription &damperDescription);
};
 
}// namespace iv::panels::control
 
#endif//IV_SRC_UI_PANELS_EDITOR_CONTROL_CONTROLDAMPERUSECASES_HPP_