utils.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MIMICS_UTILS_HPP_
#define IV_SRC_MIMICS_UTILS_HPP_
 
#include "alarms/enums.hpp"
#include "core/assert.hpp"
#include "mimics/enums.hpp"
#include "mimics/model/Channel.hpp"
 
namespace iv::mimics
{
 
inline double minElementSize(const eMimicElementType type)
{
    switch (type)
    {
        case eMimicElementType::GeneratorPms:
        case eMimicElementType::OperationModesPms:
        case eMimicElementType::Image:
        case eMimicElementType::Link:
        case eMimicElementType::Command:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Display:
        case eMimicElementType::Generator:
        case eMimicElementType::LevelBar:
        case eMimicElementType::Motor:
        case eMimicElementType::Shaft:
        case eMimicElementType::TextChannel:
        case eMimicElementType::DynamicText:
        case eMimicElementType::Tank:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
        case eMimicElementType::PmsPriorities:
            return 16;
 
        case eMimicElementType::Line:
        case eMimicElementType::Polyline:
        case eMimicElementType::Square:
            break;
 
        case eMimicElementType::Fan:
        case eMimicElementType::Compressor:
        case eMimicElementType::Dial:
        case eMimicElementType::Propeller:
        case eMimicElementType::Pump:
            return 15;
 
        case eMimicElementType::Text:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
            return 5;
    }
 
    return 0;
}
 
inline bool prvHasBackground(const eMimicElementType type)
{
    switch (type)
    {
        case eMimicElementType::Dial:
            return true;
 
        case eMimicElementType::Command:
        case eMimicElementType::Pump:
        case eMimicElementType::Compressor:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Fan:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Shaft:
        case eMimicElementType::Display:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
        case eMimicElementType::Tank:
        case eMimicElementType::Image:
        case eMimicElementType::Motor:
        case eMimicElementType::Line:
        case eMimicElementType::LevelBar:
        case eMimicElementType::PmsPriorities:
            return false;
 
        default:
            IV_MISSING_CASE_CHECK("expression");
            break;
    }
 
    return false;
}
 
inline bool hasTitle(const eMimicElementType type)
{
    bool hasTitle {true};
 
    switch (type)
    {
        case eMimicElementType::Command:
        case eMimicElementType::Line:
        case eMimicElementType::Text:
        case eMimicElementType::Polyline:
        case eMimicElementType::Square:
        case eMimicElementType::TextChannel:
        case eMimicElementType::DynamicText:
        case eMimicElementType::PmsPriorities:
            hasTitle = false;
            break;
 
        case eMimicElementType::Display:
        case eMimicElementType::LevelBar:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Compressor:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Dial:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
        case eMimicElementType::Fan:
        case eMimicElementType::Generator:
        case eMimicElementType::Image:
        case eMimicElementType::Link:
        case eMimicElementType::Motor:
        case eMimicElementType::Propeller:
        case eMimicElementType::Pump:
        case eMimicElementType::Shaft:
        case eMimicElementType::Tank:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
            hasTitle = true;
            break;
 
        default:
            IV_MISSING_CASE_CHECK("expression");
            break;
    }
 
    return hasTitle;
}
 
inline bool prvHasForeground(const eMimicElementType type)
{
    bool hasForeground {true};
 
    switch (type)
    {
        case eMimicElementType::Pump:
        case eMimicElementType::Compressor:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Propeller:
        case eMimicElementType::Generator:
        case eMimicElementType::Fan:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Shaft:
        case eMimicElementType::Display:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
        case eMimicElementType::Tank:
        case eMimicElementType::Command:
        case eMimicElementType::Image:
        case eMimicElementType::Motor:
        case eMimicElementType::Line:
        case eMimicElementType::Dial:
        case eMimicElementType::LevelBar:
        case eMimicElementType::PmsPriorities:
            hasForeground = false;
            break;
 
        default:
            IV_MISSING_CASE_CHECK("expression");
            break;
    }
 
    return hasForeground;
}
 
inline bool prvWithScale(const eMimicElementType type)
{
    bool withScale {false};
 
    switch (type)
    {
        case eMimicElementType::Display:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
        case eMimicElementType::Text:
            withScale = false;
            break;
 
        case eMimicElementType::Pump:
        case eMimicElementType::Compressor:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Propeller:
        case eMimicElementType::Generator:
        case eMimicElementType::Fan:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Shaft:
        case eMimicElementType::Tank:
        case eMimicElementType::Command:
        case eMimicElementType::Image:
        case eMimicElementType::Motor:
        case eMimicElementType::Line:
        case eMimicElementType::Dial:
        case eMimicElementType::LevelBar:
        case eMimicElementType::PmsPriorities:
            withScale = true;
            break;
 
        default:
            IV_MISSING_CASE_CHECK("expression");
            break;
    }
    return withScale;
}
 
inline iv::mimics::eZDepth mimicElementDepth(const eMimicElementType type)
{
    switch (type)
    {
        case eMimicElementType::Line:
        case eMimicElementType::Square:
        case eMimicElementType::Polyline:
            return iv::mimics::eZDepth::Low;
 
        case eMimicElementType::Image:
        case eMimicElementType::Link:
        case eMimicElementType::Text:
            return iv::mimics::eZDepth::Normal;
 
        case eMimicElementType::PmsPriorities:
        case eMimicElementType::Breaker:
        case eMimicElementType::BreakerPms:
        case eMimicElementType::Command:
        case eMimicElementType::Compressor:
        case eMimicElementType::Damper:
        case eMimicElementType::DamperAutomated:
        case eMimicElementType::Dial:
        case eMimicElementType::Digital:
        case eMimicElementType::AlarmIndicator:
        case eMimicElementType::Display:
        case eMimicElementType::Fan:
        case eMimicElementType::Generator:
        case eMimicElementType::GeneratorPms:
        case eMimicElementType::OperationModesPms:
        case eMimicElementType::LevelBar:
        case eMimicElementType::Motor:
        case eMimicElementType::Propeller:
        case eMimicElementType::Pump:
        case eMimicElementType::Shaft:
        case eMimicElementType::TextChannel:
        case eMimicElementType::DynamicText:
        case eMimicElementType::Tank:
        case eMimicElementType::Valve:
        case eMimicElementType::ValveAutomated:
            return iv::mimics::eZDepth::High;
    }
 
    return iv::mimics::eZDepth::Normal;
}
 
inline std::optional<iv::mimics::eAlarmState>
alarmStateToMimicAlarmState(const iv::alarms::eAlarmState alarmState, const iv::alarms::eAlarmPriority alarmPriority,
                            const iv::alarms::eAlarmType alarmType)
{
    switch (alarmType)
    {
        case alarms::eAlarmType::AlarmOffScan:
            return eAlarmState::OffScan;
 
        case alarms::eAlarmType::AlarmInh:
            return eAlarmState::Inhibited;
 
        default:
            break;
    }
 
    switch (alarmState)
    {
        case alarms::eAlarmState::Inactive:
            return eAlarmState::Normal;
 
        case alarms::eAlarmState::Acknowledged:
        {
            if (alarmPriority == alarms::eAlarmPriority::Warning)
            {
                return eAlarmState::AcknowledgedWarning;
            }
            return eAlarmState::AcknowledgedAlarm;
        }
 
        case alarms::eAlarmState::Active:
        {
            if (alarmPriority == alarms::eAlarmPriority::Warning)
            {
                return eAlarmState::Warning;
            }
            return eAlarmState::Alarm;
        }
 
        case alarms::eAlarmState::Unacknowledged:
        {
            if (alarmPriority == alarms::eAlarmPriority::Warning)
            {
                return eAlarmState::UnacknowledgedWarning;
            }
            return eAlarmState::UnacknowledgedAlarm;
        }
 
        case alarms::eAlarmState::Undefined:
            return eAlarmState::Offline;
    }
 
    return std::nullopt;
}
 
inline std::optional<iv::mimics::eAlarmState> mimicChannelToMimicAlarmState(const iv::mimics::Channel &channel)
{
    if (const auto auxChannel = channel.getChannelActive())
    {
        if (auxChannel->hasValue())
        {
            const auto channelState = iv::mimics::alarmStateToMimicAlarmState(
                    auxChannel->getAlarmState(), auxChannel->getAlarmPriority(), auxChannel->getAlarmType());
 
            if (channelState.has_value())
            {
                return channelState.value();
            }
        }
        else
        {
            return eAlarmState::Offline;
        }
    }
    return std::nullopt;
}
 
inline std::optional<std::string> alarmStateIcon(const iv::mimics::eAlarmState alarmState)
{
    switch (alarmState)
    {
        case eAlarmState::Alarm:
            return "diamar/Icon-Alarm";
 
        case eAlarmState::Warning:
            return "diamar/Icon-Warning";
 
        case eAlarmState::UnacknowledgedAlarm:
        case eAlarmState::UnacknowledgedWarning:
            return "diamar/Icon-ReturnNoACK";
 
        case eAlarmState::AcknowledgedAlarm:
            return "diamar/Icon-AlarmACK";
 
        case eAlarmState::AcknowledgedWarning:
            return "diamar/Icon-WarningACK";
 
        case eAlarmState::Inhibited:
            return "diamar/Icon-Inhibited";
 
        case eAlarmState::OffScan:
            return "diamar/Icon-Offscan";
 
        case eAlarmState::Normal:
            return "diamar/Icon-Transparent";
 
        case eAlarmState::Offline:
            return "diamar/Icon-Offline";
    }
 
    return std::nullopt;
}
 
}// namespace iv::mimics
 
#endif//IV_SRC_MIMICS_UTILS_HPP_