structs.hpp

Go to the documentation of this file.

 
#ifndef IV_SRC_COMMS_CANJ1939_STRUCTS_HPP_
#define IV_SRC_COMMS_CANJ1939_STRUCTS_HPP_
 
#include "channels/AbstractChannel.hpp"
#include "core/enums.hpp"
#include "comms/canJ1939/enums.hpp"
#include "third_party/JSON.hpp"
 
#include <cstdint>
 
using JSON = nlohmann::json;
 
namespace iv::comms::canJ1939
{
 
struct SpnInfo
{
    bool read(const JSON &pgnJSON, iv::types::comms::spn spn);
    bool write(JSON &pgnJSON) const;
 
    iv::types::comms::spn m_spn;// SPN number
 
    std::string m_name;       // Name of the SPN
    std::string m_description;// Description of the SPN
 
    bool m_isSigned;
    iv::eEndianType m_endianness;
 
    iv::types::channelValue m_factor {1.};
    iv::types::channelValue m_offset {0.};
 
    uint32_t m_startingBit;
    uint32_t m_length;
 
    std::optional<iv::types::channelValue> m_min {std::nullopt};
    std::optional<iv::types::channelValue> m_max {std::nullopt};
 
    iv::eMeasurementUnit m_unit {iv::eMeasurementUnit::NoUnit};
};
 
struct PgnInfo
{
    bool read(const JSON &pgnJSON, iv::types::comms::pgn pgn);
    bool write(JSON &pgnJSON) const;
 
    iv::types::comms::pgn m_pgn;// PGN number
    uint32_t m_length;          // Number of SPNs
    std::string m_name;         // Name of the PGN
 
    std::map<iv::types::comms::spn, SpnInfo> m_SPNs;// SPNs in the PGN
};
 
struct CanJ1939Filter
{
    iv::types::comms::spn spn;
    iv::eDataType dataType;
    iv::types::channelValue value;
};
 
struct CanJ1939ChannelBinding
{
    iv::types::comms::pgn pgn;
    iv::types::comms::spn spn;
    std::vector<CanJ1939Filter> filterSPNs;
    iv::eDataType dataType;
    std::weak_ptr<iv::channels::AbstractChannel> channel;
};
 
struct CanJ1939Dm1ChannelBinding
{
    iv::types::comms::fmi fmi;
    std::weak_ptr<iv::channels::AbstractChannel> channel;
};
 
struct onGoingCanJ1939MultiPacketCommunication
{
    uint32_t currentPacketIndex;
    uint16_t size;
    uint8_t numOfPackets;
    iv::types::comms::pgn pgn;
    iv::types::comms::j1939SourceAddress sourceAddress;
    eJ1939TransportProtocol transportProtocol;
    std::vector<std::byte> data;
    iv::types::timestamp lastPacketProcessed;
};
}// namespace iv::comms::canJ1939
#endif//IV_SRC_COMMS_CANJ1939_STRUCTS_HPP_