Describes one CAN frame from a DBC file. More...

#include <frame_info.h>

Public Attributes
std::string	name

std::uint32_t	canId = 0U

bool	isExtended = false

std::uint32_t	pgn = 0U

bool	hasPgn = false

std::uint8_t	dlc = 0U

std::string	transmitter

std::string	comment

std::vector< SignalInfo >	public

std::optional< std::string >	frameFormat

std::optional< std::uint32_t >	cycleTimeMs

AttributeMap	attributes

Detailed Description

Describes one CAN frame from a DBC file.

Definition at line 25 of file frame_info.h.

Member Data Documentation

◆ name

std::string FrameInfo::name

Frame name.

Definition at line 26 of file frame_info.h.

Referenced by DbcSignalHandler::Handle().

◆ canId

std::uint32_t FrameInfo::canId = 0U

Normalized CAN identifier.

Definition at line 27 of file frame_info.h.

Referenced by DbcTreeModel::data(), and DbcFrameHandler::Handle().

◆ isExtended

bool FrameInfo::isExtended = false

true for extended frame.

Definition at line 28 of file frame_info.h.

Referenced by DbcTreeModel::data(), and DbcFrameHandler::Handle().

◆ pgn

std::uint32_t FrameInfo::pgn = 0U

J1939 PGN if applicable.

Definition at line 29 of file frame_info.h.

Referenced by DbcFrameHandler::Handle().

◆ hasPgn

bool FrameInfo::hasPgn = false

Explicit J1939 opt-in; pgn is derived from canId.

Definition at line 30 of file frame_info.h.

Referenced by DbcFrameHandler::Handle().

◆ dlc

std::uint8_t FrameInfo::dlc = 0U

Frame payload length.

Definition at line 31 of file frame_info.h.

Referenced by DbcTreeModel::data(), and DbcSignalHandler::Handle().

◆ transmitter

std::string FrameInfo::transmitter

Transmitter ECU name.

Definition at line 32 of file frame_info.h.

◆ comment

std::string FrameInfo::comment

Optional frame comment.

Definition at line 33 of file frame_info.h.

Referenced by DbcTreeModel::data(), and DbcParseContext::ResolveComments().

◆ public

std::vector<SignalInfo> FrameInfo::public

Signals contained in the frame.

Definition at line 34 of file frame_info.h.

◆ frameFormat

std::optional<std::string> FrameInfo::frameFormat

VFrameFormat label, when declared. VFrameFormat enum label.

Definition at line 36 of file frame_info.h.

◆ cycleTimeMs

std::optional<std::uint32_t> FrameInfo::cycleTimeMs

GenMsgCycleTime in milliseconds, when declared. GenMsgCycleTime; zero means unspecified.

Definition at line 37 of file frame_info.h.

◆ attributes

AttributeMap FrameInfo::attributes

Effective attributes after defaults and overrides. Effective values, including defaults.

Definition at line 39 of file frame_info.h.

The documentation for this struct was generated from the following file:

frame_info.h

Public Attributes