ibusmessage.h

Go to the documentation of this file.

/*
* Copyright 2025 Ingemar Hedvall
* SPDX-License-Identifier: MIT
*/

 
#pragma once
#include <cstdint>
#include <memory>
#include <vector>
 
namespace bus {

enum class BusMessageType : uint16_t {
  Unknown = 0,
  Ctrl_BusChannel = 1,
  CAN_DataFrame = 10,
  CAN_RemoteFrame = 11,
  CAN_ErrorFrame = 12,
  CAN_OverloadFrame = 13,
 
};

class IBusMessage {
public:
 
  IBusMessage() = default;
  explicit IBusMessage(BusMessageType type);
 
  virtual ~IBusMessage() = default;

  static std::shared_ptr<IBusMessage> Create(BusMessageType type);

  virtual void ToRaw(std::vector<uint8_t>& dest) const;

  virtual void FromRaw(const std::vector<uint8_t>& source);

  [[nodiscard]] BusMessageType Type() const { return type_; }

  void Version(uint16_t version) { version_ = version; }
  [[nodiscard]] uint16_t Version() const { return version_; }

  [[nodiscard]] uint32_t Size() const { return size_;};

  [[nodiscard]] bool Valid() const { return valid_;};

  void Timestamp(uint64_t timestamp) { timestamp_ = timestamp; }

  [[nodiscard]] uint64_t Timestamp() const { return timestamp_; }

  void BusChannel(uint16_t channel) { bus_channel_ = channel; }

  [[nodiscard]] uint16_t BusChannel() const { return bus_channel_; }
 
protected:
  void Size(uint32_t size) const {size_ = size; }

  void Valid(bool valid) const { valid_ = valid;}
 
private:
  uint64_t timestamp_ = 0;
  BusMessageType type_ = BusMessageType::Unknown;
  uint16_t version_ = 0;
  uint8_t bus_channel_ = 0;
 
  mutable uint32_t size_ = 18;
  mutable bool valid_ = true;
 
};
 
} // bus