defines.hpp

Go to the documentation of this file.

#ifndef IV_SRC_LOGIC_DEFINES_HPP_
#define IV_SRC_LOGIC_DEFINES_HPP_
 
#include <cstdint>
#include <map>
#include <string>
 
#include "alarms/enums.hpp"
#include "logic/types.hpp"
 
namespace iv::logic
{
 
enum class eDBBlockParamType
{
    Input = 1,
    Output = 2,
    Byte = 3,
    Word = 4,
    Type = 5,
    SubType = 6,
    Float = 7,
    String6 = 10,
    InputSerial = 11,
    OutputSerial = 12,
    Without = 0
};
 
namespace constants
{
 
inline constexpr iv::types::logic::componentType kInvalidType {0};
// alias of kInvalidType, to be used when iv::types::logic::componentType is irrelevant
inline constexpr iv::types::logic::componentType kAnyType {std::numeric_limits<iv::types::logic::componentType>::max()};
inline constexpr iv::types::logic::componentFinalType kInvalidFinalType {0};
inline constexpr iv::types::logic::componentFinalType kAnyFinalType {
        std::numeric_limits<iv::types::logic::componentFinalType>::max()};
 
inline constexpr iv::types::logic::logicExecutionOrder kInvalidOrderOfExecution {0};
inline constexpr iv::types::logic::logicExecutionOrder kInitialOrderOfExecution {1};
 
// For InfoLogicTxt
inline constexpr std::string_view kKeySectionInfoLogic {"Info"};
inline constexpr std::string_view kKeyInfoLogicName {"Name"};
inline constexpr std::string_view kKeyInfoLogicUnit {"Unit"};
inline constexpr std::string_view kKeyInfoLogicAuthor {"Author"};
inline constexpr std::string_view kKeyInfoLogicFile {"File"};
inline constexpr std::string_view kKeyInfoLogicDate {"Date"};
inline constexpr std::string_view kKeyInfoLogicTime {"Time"};
inline constexpr std::string_view kKeyInfoLogicVersion {"Version"};
inline constexpr std::string_view kKeyInfoLogicDescription {"Description"};
 
// Reserved memory positions for constant values in the firmware
inline constexpr uint32_t kConstNotConnected {444};
inline constexpr uint32_t kConstLomInit {445};
inline constexpr uint32_t kConstZeroLogicState {446};
inline constexpr uint32_t kConstOneLogicState {447};
inline constexpr uint32_t kStartingIntermediateMemory {448};
 
inline constexpr std::string_view kCstNotConnectedStr {"CST_NOT_CONNECTED"};
inline constexpr std::string_view kCstLomInitStr {"CST_LOM_INIT"};
inline constexpr std::string_view kCstZeroLogicStateStr {"CST_ZERO_LOGIC_STATE"};
inline constexpr std::string_view kCstOneLogicStateStr {"CST_ONE_LOGIC_STATE"};
inline constexpr std::string_view kTxtFileSeparator {"-----------------------------------------------------------------"
                                                     "----------------------------------------------------------"};
inline constexpr std::string_view kTxtFrontPadding {"|    "};
 
namespace types
{
inline constexpr iv::types::logic::componentType timer {1};
inline constexpr iv::types::logic::componentType counter {2};
inline constexpr iv::types::logic::componentType logicGates {3};
inline constexpr iv::types::logic::componentType latch {4};
inline constexpr iv::types::logic::componentType failSafe {10};
inline constexpr iv::types::logic::componentType analog {11};
inline constexpr iv::types::logic::componentType system {13};
inline constexpr iv::types::logic::componentType control {14};
inline constexpr iv::types::logic::componentType exhaustGases {15};
inline constexpr iv::types::logic::componentType modbus {16};
inline constexpr iv::types::logic::componentType pmm {17};
inline constexpr iv::types::logic::componentType watchcall {18};
inline constexpr iv::types::logic::componentType pms {19};
inline constexpr iv::types::logic::componentType nmea {20};
}// namespace types
 
namespace subtypes
{
inline constexpr iv::types::logic::componentFinalType analogFollower {86};
inline constexpr iv::types::logic::componentFinalType analogAddStation {163};
inline constexpr iv::types::logic::componentFinalType analogSubStation {164};
inline constexpr iv::types::logic::componentFinalType analogDivStation {165};
inline constexpr iv::types::logic::componentFinalType analogMultStation {166};
inline constexpr iv::types::logic::componentFinalType analogAndStation {167};
inline constexpr iv::types::logic::componentFinalType analogOrStation {168};
inline constexpr iv::types::logic::componentFinalType analogCompareStation {169};
inline constexpr iv::types::logic::componentFinalType analogNotStation {170};
inline constexpr iv::types::logic::componentFinalType analogMeanStation {171};
inline constexpr iv::types::logic::componentFinalType analogIfElseStation {172};
inline constexpr iv::types::logic::componentFinalType analogAbsStation {173};
inline constexpr iv::types::logic::componentFinalType analogConstantStation {174};
inline constexpr iv::types::logic::componentFinalType analogRootStation {175};
inline constexpr iv::types::logic::componentFinalType analogAlarmTypeStation {176};
inline constexpr iv::types::logic::componentFinalType analogAlarmType2LimStation {177};
inline constexpr iv::types::logic::componentFinalType analogAlarmStateStation {178};
}// namespace subtypes
 
namespace parameterType
{
inline constexpr uint8_t Input {1};
inline constexpr uint8_t Output {2};
inline constexpr uint8_t Byte {3};
inline constexpr uint8_t Word {4};
inline constexpr uint8_t Type {5};
inline constexpr uint8_t Subtype {6};
inline constexpr uint8_t Float {7};
inline constexpr uint8_t String {10};
inline constexpr uint8_t InputSerial {11};
inline constexpr uint8_t OutputSerial {12};
 
inline constexpr std::string_view InputName {"Input"};
inline constexpr std::string_view OutputName {"Output"};
inline constexpr std::string_view ByteName {"Byte"};
inline constexpr std::string_view WordName {"Word"};
inline constexpr std::string_view TypeName {"Type"};
inline constexpr std::string_view SubtypeName {"SubType"};
inline constexpr std::string_view FloatName {"Float"};
inline constexpr std::string_view StringName {"String6"};
inline constexpr std::string_view InputSerialName {"InputSerial"};
inline constexpr std::string_view OutputSerialName {"OutputSerial"};
}// namespace parameterType
 
namespace parameterOptions
{
 
enum class eAlarmTypeStation
{
    NoAlarm = 0,
    OpenAlarm = 1,
    CloseAlarm = 2,
    InstrumentFailureHighAlarm = 3,
    HighHighAlarm = 4,
    HighAlarm = 5,
    LowAlarm = 6,
    LowLowAlarm = 7,
    InstrumentFailureLowAlarm = 8,
    OffscanAlarm = 9,
    FailureAlarm = 10,
    InhibitedAlarm = 11,
};
 
inline const std::map<iv::alarms::eAlarmType, eAlarmTypeStation> mapAlarmTypesRelation {
        {iv::alarms::eAlarmType::AlarmOpen, eAlarmTypeStation::OpenAlarm},
        {iv::alarms::eAlarmType::AlarmClose, eAlarmTypeStation::CloseAlarm},
        {iv::alarms::eAlarmType::AlarmIfh, eAlarmTypeStation::InstrumentFailureHighAlarm},
        {iv::alarms::eAlarmType::AlarmHh, eAlarmTypeStation::HighHighAlarm},
        {iv::alarms::eAlarmType::AlarmH, eAlarmTypeStation::HighAlarm},
        {iv::alarms::eAlarmType::AlarmL, eAlarmTypeStation::LowAlarm},
        {iv::alarms::eAlarmType::AlarmLl, eAlarmTypeStation::LowLowAlarm},
        {iv::alarms::eAlarmType::AlarmIfl, eAlarmTypeStation::InstrumentFailureLowAlarm},
        {iv::alarms::eAlarmType::AlarmOffScan, eAlarmTypeStation::OffscanAlarm},
        {iv::alarms::eAlarmType::AlarmFail, eAlarmTypeStation::FailureAlarm},
        {iv::alarms::eAlarmType::AlarmInh, eAlarmTypeStation::InhibitedAlarm}};
 
enum class eAlarmType2LimitsStation
{
    NoAlarm = 0,
    InstrumentFailureHighAlarm = 3,
    HighHighAlarm = 4,
    HighAlarm = 5,
    LowAlarm = 6,
    LowLowAlarm = 7,
    InstrumentFailureLowAlarm = 8,
};
 
inline const std::map<iv::alarms::eAlarmType, eAlarmType2LimitsStation> mapAlarmTypes2LimitsRelation {
        {iv::alarms::eAlarmType::AlarmIfh, eAlarmType2LimitsStation::InstrumentFailureHighAlarm},
        {iv::alarms::eAlarmType::AlarmHh, eAlarmType2LimitsStation::HighHighAlarm},
        {iv::alarms::eAlarmType::AlarmH, eAlarmType2LimitsStation::HighAlarm},
        {iv::alarms::eAlarmType::AlarmL, eAlarmType2LimitsStation::LowAlarm},
        {iv::alarms::eAlarmType::AlarmLl, eAlarmType2LimitsStation::LowLowAlarm},
        {iv::alarms::eAlarmType::AlarmIfl, eAlarmType2LimitsStation::InstrumentFailureLowAlarm}};
 
enum class eAlarmStateStation
{
    Inactive = 0,
    Acknowledged = 1,
    Active = 2,
    Unacknowledged = 3,
    Undefined = 4
};
 
inline const std::map<iv::alarms::eAlarmState, eAlarmStateStation> mapAlarmStatesRelation {
        {iv::alarms::eAlarmState::Inactive, eAlarmStateStation::Inactive},
        {iv::alarms::eAlarmState::Acknowledged, eAlarmStateStation::Acknowledged},
        {iv::alarms::eAlarmState::Active, eAlarmStateStation::Active},
        {iv::alarms::eAlarmState::Unacknowledged, eAlarmStateStation::Unacknowledged},
        {iv::alarms::eAlarmState::Undefined, eAlarmStateStation::Undefined}};
 
}// namespace parameterOptions
 
}// namespace constants
 
}// namespace iv::logic
 
#endif//IV_SRC_LOGIC_DEFINES_HPP_