EnumDataFlowParameter.hpp

Go to the documentation of this file.

#ifndef IV_SRC_CHANNELS_ENUMDATAFLOWPARAMETER_HPP_
#define IV_SRC_CHANNELS_ENUMDATAFLOWPARAMETER_HPP_
 
#include "channels/NetworkInfo.hpp"
#include "core/enums.hpp"
 
#include <cstdint>
#include <memory>
#include <set>
#include <string>
 
namespace iv::channels
{
 
class AbstractChannel;
 
class EnumDataFlowParameter
{
public:
    enum class eParameterJ1939
    {
        Type,
        Pgn,
        SourceAddress,
        Spn,
        DataType,
        ExtraIdentifier
    };
 
    static std::string getJ1939ParameterName(eParameterJ1939 param, bool shortName = true);
    static std::string getJ1939ParameterColumnName(eParameterJ1939 param);
    static uint16_t getJ1939ParameterColumnWidth(eParameterJ1939 param);
    static uint16_t getJ1939ParameterMaxChars(eParameterJ1939 param);
    static std::string getJ1939ParameterValueAsString(const std::shared_ptr<INetworkInfo> &networkInfo,
                                                      iv::channels::EnumDataFlowParameter::eParameterJ1939 param);
 
    enum class eParameterModbus
    {
        Description,
        Direction,
        Type,
        IsExtended,
        Address,
        DataType,
        EndianType,
        RegisterBitsLength,
        BitPosition,
        SlaveId
    };
 
    static std::string getModbusParameterName(eParameterModbus param, bool shortName = true);
    static uint16_t getModbusParameterColumnWidth(eParameterModbus param);
    static uint16_t getModbusParameterMaxChars(eParameterModbus param);
    static std::string getModbusParameterValueAsString(const std::shared_ptr<iv::channels::INetworkInfo> &networkInfo,
                                                       const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                                       iv::eLanguage language, eParameterModbus param);
    static std::set<iv::comms::modbus::eRegisterType>
    getModbusRegisterTypesForDirection(iv::channels::INetworkInfo::eDirection modbusRegisterDirection);
    static std::set<iv::eDataType> getModbusDataTypesForRegisterType(iv::comms::modbus::eRegisterType modbusType);
 
    enum class eParameterNmea0183
    {
        Description,
        Header,
        FieldPosition,
        FieldType
    };
 
    static std::string getNmea0183ParameterName(eParameterNmea0183 param, bool shortName = true);
    static uint16_t getNmea0183ParameterMaxChars(eParameterNmea0183 param);
    static uint16_t getNmea0183ParameterColumnWidth(eParameterNmea0183 param);
    static std::string getNmea0183ParameterValueAsString(const std::shared_ptr<iv::channels::INetworkInfo> &networkInfo,
                                                         const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                                         iv::eLanguage language, eParameterNmea0183 param);
 
    enum class eParameterVdr
    {
        Description,
        id
    };
 
    static std::string getVdrParameterName(eParameterVdr param, bool shortName = true);
    static uint16_t getVdrParameterMaxChars(eParameterVdr param);
    static uint16_t getVdrParameterColumnWidth(eParameterVdr param);
    static std::string getVdrParameterValueAsString(const std::shared_ptr<iv::channels::INetworkInfo> &networkInfo,
                                                    const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                                    iv::eLanguage language, eParameterVdr param);
 
    enum class eParameterNmea2k
    {
        Pgn,
        SourceAddress,
        FieldPosition,
        DataType,
        ExtraIdentifier
    };
 
    static std::string getNmea2kParameterColumnName(eParameterNmea2k param);
    static std::string getNmea2kParameterName(eParameterNmea2k param, bool shortName = true);
    static uint16_t getNmea2kParameterMaxChars(eParameterNmea2k param);
    static uint16_t getNmea2kParameterColumnWidth(eParameterNmea2k param);
    static std::string getNmea2kParameterValueAsString(const std::shared_ptr<iv::channels::INetworkInfo> &networkInfo,
                                                       eParameterNmea2k param);
};
 
}// namespace iv::channels
 
#endif//IV_SRC_CHANNELS_ENUMDATAFLOWPARAMETER_HPP_