structs.hpp

Go to the documentation of this file.

#ifndef IV_SRC_IOFILE_STRUCTS_HPP
#define IV_SRC_IOFILE_STRUCTS_HPP
 
#include "channels/enums.hpp"
#include "core/types.hpp"
 
#include <optional>
#include <string>
 
namespace iv::iofile
{
 
struct ModbusColumns
{
    static constexpr std::string channelTag {"ChannelTag"};
    static constexpr std::string shipyardTag {"ShipyardTag"};
    static constexpr std::string channelDescription {"Description"};
    static constexpr std::string readOrWrite {"Read/Write"};
    static constexpr std::string function {"Function"};
    static constexpr std::string isExtended {"IsExtended"};
    static constexpr std::string address {"Address"};
    static constexpr std::string valueType {"ValueType"};
    static constexpr std::string endianness {"Endianness"};
    static constexpr std::string bitsLength {"BitsLength"};
    static constexpr std::string startBit {"StartBit"};
};
 
struct NMEA0183Columns
{
    static constexpr std::string channelTag {"ChannelTag"};
    static constexpr std::string shipyardTag {"ShipyardTag"};
    static constexpr std::string channelDescription {"Description"};
    static constexpr std::string header {"Header"};
    static constexpr std::string fieldPosition {"FieldPosition"};
    static constexpr std::string fieldType {"FieldType"};
};
 
struct VdrColumns
{
    static constexpr std::string channelTag {"ChannelTag"};
    static constexpr std::string shipyardTag {"ShipyardTag"};
    static constexpr std::string channelDescription {"Description"};
    static constexpr std::string vdrId {"VdrId"};
};
 
struct J1939Columns
{
    static constexpr std::string channelTag {"ChannelTag"};
    static constexpr std::string type {"Type"};
    static constexpr std::string pgn {"PGN"};
    static constexpr std::string sourceAddress {"SourceAddress"};
    static constexpr std::string spn {"SPN"};
    static constexpr std::string dataType {"DataType"};
    static constexpr std::string extraIdentifier {"ExtraIdentifier"};
};
 
struct NMEA2KColumns
{
    static constexpr std::string channelTag {"ChannelTag"};
    static constexpr std::string pgn {"PGN"};
    static constexpr std::string sourceAddress {"SourceAddress"};
    static constexpr std::string spn {"SPN"};
    static constexpr std::string dataType {"DataType"};
    static constexpr std::string extraIdentifier {"ExtraIdentifier"};
};
 
struct TankCalibrationTableColumns
{
    static constexpr std::string_view trim {"Trim"};
    static constexpr std::string_view soundingHeight {"SoundingHeight"};
    static constexpr std::string_view volume {"Volume"};
    static constexpr std::string_view xgc {"XGC"};
    static constexpr std::string_view ygc {"YGC"};
    static constexpr std::string_view zgc {"ZGC"};
    static constexpr std::string_view transversalInertia {"TransversalInertia"};
};
 
struct TankCalibrationTableData
{
    double trim {0};
    double soundingHeight {0};
    double volume {0};
    double xgc {0};
    double ygc {0};
    double zgc {0};
    double transversalInertia {0};
};
 
struct ChannelsColumns
{
    static constexpr std::string_view channelEnabled {"Enabled"};
    static constexpr std::string_view channelUnit {"Unit"};
    static constexpr std::string_view channelOrder {"Order"};
    static constexpr std::string_view channelTag {"Tag"};
    static constexpr std::string_view channelShipyardTag {"Shipyard Tag (*)"};
    static constexpr std::string_view channelBaseType {"Base Type"};
    static constexpr std::string_view channelSpecificType {"Specific Type"};
    static constexpr std::string_view channelDescriptionEn {"English Description (*)"};
    static constexpr std::string_view channelDescriptionEs {"Spanish Description (*)"};
    static constexpr std::string_view channelDescriptionFr {"French Description (*)"};
    static constexpr std::string_view channelDescriptionDe {"German Description (*)"};
    static constexpr std::string_view channelDescriptionPt {"Portuguese Description (*)"};
    static constexpr std::string_view channelArea {"Area"};
    static constexpr std::string_view channelTimeout {"Timeout (*)"};
 
    // ALARM PARAMETERS
    static constexpr std::string_view channelAlarmGroup {"Group"};
    static constexpr std::string_view channelAlarmEnabled {"Alarm Enabled (*)"};
    static constexpr std::string_view channelAlarmOffScan {"Off Scan (*)"};
    static constexpr std::string_view channelAlarmPriority {"Priority"};
    static constexpr std::string_view channelAlarmActivationDelay {"Activation Delay (*)"};
    static constexpr std::string_view channelAlarmDeactivationDelay {"Deactivation Delay (*)"};
    static constexpr std::string_view channelAlarmInhibitionTag {"Inhibition Tag"};
    static constexpr std::string_view channelAlarmInhibitionCondition {"Inhibition Condition"};
 
    // DIGITAL
    static constexpr std::string_view channelDigitalInverted {"Inverted (*)"};
    static constexpr std::string_view channelDigitalAlarmLimit {"Alarm Limit (*)"};
    static constexpr std::string_view channelDigitalDelayOn {"On Delay (*)"};
    static constexpr std::string_view channelDigitalDelayOff {"Off Delay (*)"};
 
    // ANALOG
    static constexpr std::string_view channelAnalogDeadBand {"Dead Band (*)"};
    static constexpr std::string_view channelAnalogOffset {"Offset (*)"};
    static constexpr std::string_view channelAnalogFactor {"Factor (*)"};
    static constexpr std::string_view channelAnalogNumDecimals {"Num Decimals (*)"};
    static constexpr std::string_view channelAnalogMeasurementUnit {"Measurement Unit"};
    static constexpr std::string_view channelAnalogSensorType {"Sensor Type"};
    static constexpr std::string_view channelAnalogSensorLow {"Sensor Low (*)"};
    static constexpr std::string_view channelAnalogSensorHigh {"Sensor High (*)"};
 
    // ANALOG (ALARM - AnalogAlarmLimits)
    static constexpr std::string_view channelAnalogAlarmIfl {"Instrument Failure Low (*)"};
    static constexpr std::string_view channelAnalogAlarmIfh {"Instrument Failure High (*)"};
    static constexpr std::string_view channelAnalogAlarmLEL {"Low Engineering Limit (*)"};
    static constexpr std::string_view channelAnalogAlarmHEL {"High Engineering Limit (*)"};
    static constexpr std::string_view channelAnalogAlarmLLALEnable {"Low Low Alarm Limit Enable (*)"};
    static constexpr std::string_view channelAnalogAlarmLLAL {"Low Low Alarm Limit (*)"};
    static constexpr std::string_view channelAnalogAlarmLALEnable {"Low Alarm Limit Enable (*)"};
    static constexpr std::string_view channelAnalogAlarmLAL {"Low Alarm Limit (*)"};
    static constexpr std::string_view channelAnalogAlarmHALEnable {"High Alarm Limit Enable (*)"};
    static constexpr std::string_view channelAnalogAlarmHAL {"High Alarm Limit (*)"};
    static constexpr std::string_view channelAnalogAlarmHHALEnable {"High High Alarm Limit Enable (*)"};
    static constexpr std::string_view channelAnalogAlarmHHAL {"High High Alarm Limit (*)"};
 
    // MISC (ChannelInfo)
    static constexpr std::string_view channelFunctionCode {"Function Code (*)"};
    static constexpr std::string_view channelEquipment {"Equipment (*)"};
    static constexpr std::string_view channelSystem {"System (*)"};
};
 
struct ChannelImporterData
{
    iv::types::channelId channelId;
    std::string shipyardTag;
    std::string descriptionEnglish;
    std::string descriptionSpanish;
    std::string descriptionGerman;
    std::string descriptionFrench;
    std::string descriptionPortuguese;
    std::string function;
    std::string system;
    std::string equipment;
    std::optional<iv::types::milliseconds> timeout;
 
    struct AlarmParameters
    {
        bool alarmEnabled;
        bool alarmOffscan;
        std::optional<iv::types::delay> alarmOnDelay;
        std::optional<iv::types::delay> alarmOffDelay;
        //    iv::types::groupId group;
    };
 
    struct DigitalParameters
    {
        bool inverted;
        iv::channels::eDigitalValue alarmLimit;
        std::optional<iv::types::delay> onDelay;
        std::optional<iv::types::delay> offDelay;
    };
 
    struct AnalogParameters
    {
        std::optional<double> deadBand;
        std::optional<double> offset;
        std::optional<double> factor;
        std::optional<uint16_t> numberOfDecimals;
        std::optional<double> sensorLow;
        std::optional<double> sensorHigh;
    };
 
    struct AnalogAlarmParameters
    {
        bool hasInstrumentFailureLow {false};
        bool hasInstrumentFailureHigh {false};
        std::optional<double> lowEngineeringLimit;
        std::optional<double> highEngineeringLimit;
 
        struct AlarmLimit
        {
            bool hasLimit {false};
            std::optional<double> limitValue;
        };
 
        AlarmLimit lowLowAlarmLimit;
        AlarmLimit lowAlarmLimit;
        AlarmLimit highAlarmLimit;
        AlarmLimit highHighAlarmLimit;
    };
 
    AlarmParameters alarmParameters;
    std::optional<DigitalParameters> digitalParameters;
    std::optional<AnalogParameters> analogParameters;
    std::optional<AnalogAlarmParameters> analogAlarmParameters;
};
 
struct DataLoggerValuesColumns
{
    static constexpr std::string_view timestamp {"Timestamp"};
};
 
}// namespace iv::iofile
 
#endif//IV_SRC_IOFILE_STRUCTS_HPP