frame_info.h

Go to the documentation of this file.

/**
 * @file frame_info.h
 * @brief
 *
 * Created: 2026-03-13
 * Author: Deeaitch (Dim. Himro)
 *
 * Licensed under the MIT License.
 * See LICENSE file in the project root for full license text.
 */
 
#ifndef FRAME_INFO_H
#define FRAME_INFO_H
 
#include <string>
#include <vector>
#include <cstdint>
 
#include "signal_info.h"
 
/**
 * @brief Describes one CAN frame from a DBC file.
 */
struct FrameInfo {
  std::string name;                /**< Frame name. */
  std::uint32_t canId;             /**< Normalized CAN identifier. */
  bool isExtended;                 /**< true for extended frame. */
  std::uint32_t pgn;               /**< J1939 PGN if applicable. */
  bool hasPgn;                     /**< true if PGN was derived. */
  std::uint8_t dlc;                /**< Frame payload length. */
  std::string transmitter;         /**< Transmitter ECU name. */
  std::string comment;             /**< Optional frame comment. */
  std::vector<SignalInfo> signals; /**< Signals contained in the frame. */
 
  FrameInfo()
    : name()
    , canId (0U)
    , isExtended (false)
    , pgn (0U)
    , hasPgn (false)
    , dlc (0U)
    , transmitter()
    , comment()
    , signals() {
  }
};
 
#endif /* FRAME_INFO_H */