DecodeFrame Struct Reference

Runtime-ready frame definition. More...

#include <decode_database.h>

Public Member Functions
FrameKey	GetKey () const
	Return the stable normalized frame identifier.

Public Attributes
std::string	name
std::uint32_t	canId = 0U
bool	isExtended = false
std::uint8_t	dlc = 0U
std::uint32_t	pgn = 0U
bool	hasPgn = false
std::string	transmitter
std::string	comment
std::vector< DecodeSignal >	public
AttributeMap	attributes
std::optional< std::string >	frameFormat
std::optional< std::uint32_t >	cycleTimeMs

Detailed Description

Runtime-ready frame definition.

Definition at line 68 of file decode_database.h.

Member Function Documentation

GetKey()

FrameKey DecodeFrame::GetKey ( ) const

inline

Return the stable normalized frame identifier.

Definition at line 86 of file decode_database.h.

References canId, and isExtended.

Member Data Documentation

name

std::string DecodeFrame::name

Frame name.

Definition at line 69 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

canId

std::uint32_t DecodeFrame::canId = 0U

Normalized CAN ID.

Definition at line 70 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build(), and GetKey().

isExtended

bool DecodeFrame::isExtended = false

true for extended frame.

Definition at line 71 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build(), and GetKey().

dlc

std::uint8_t DecodeFrame::dlc = 0U

Payload length.

Definition at line 72 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

pgn

std::uint32_t DecodeFrame::pgn = 0U

PGN if available.

Definition at line 73 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

hasPgn

bool DecodeFrame::hasPgn = false

Explicit J1939 opt-in; pgn must match canId.

Definition at line 74 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

transmitter

std::string DecodeFrame::transmitter

Transmitter ECU.

Definition at line 75 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

comment

std::string DecodeFrame::comment

Frame comment.

Definition at line 76 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

public

std::vector<DecodeSignal> DecodeFrame::public

Signal definitions.

Definition at line 77 of file decode_database.h.

attributes

AttributeMap DecodeFrame::attributes

Effective attributes after defaults and overrides.

Definition at line 79 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

frameFormat

std::optional<std::string> DecodeFrame::frameFormat

VFrameFormat label, when declared.

Definition at line 80 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

cycleTimeMs

std::optional<std::uint32_t> DecodeFrame::cycleTimeMs

GenMsgCycleTime in milliseconds, when declared.

Definition at line 81 of file decode_database.h.

Referenced by DbcDecodeBuilder::Build().

---

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

• decode_database.h