AgIsoStack++
A control-function-focused implementation of the major ISOBUS and J1939 protocols
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
isobus::CANMessageFrame Class Reference

A CAN frame for interfacing with a hardware layer, like socket CAN or other interface. More...

#include <can_message_frame.hpp>

Public Member Functions

std::uint32_t get_number_bits_in_message () const
 

Public Attributes

std::uint64_t timestamp_us
 A microsecond timestamp.
 
std::uint32_t identifier
 The 32 bit identifier of the frame.
 
std::uint8_t channel
 The CAN channel index associated with the frame.
 
std::uint8_t data [8]
 The data payload of the frame.
 
std::uint8_t dataLength
 The length of the data used in the frame.
 
bool isExtendedFrame
 Denotes if the frame is extended format.
 

Detailed Description

A CAN frame for interfacing with a hardware layer, like socket CAN or other interface.

Definition at line 23 of file can_message_frame.hpp.

Member Function Documentation

◆ get_number_bits_in_message()

std::uint32_t isobus::CANMessageFrame::get_number_bits_in_message ( ) const

Returns the number of bits in a CAN message with averaged bit stuffing

Returns
The number of bits in the message (with average bit stuffing)

Definition at line 15 of file can_message_frame.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ channel

std::uint8_t isobus::CANMessageFrame::channel

The CAN channel index associated with the frame.

Definition at line 32 of file can_message_frame.hpp.

◆ data

std::uint8_t isobus::CANMessageFrame::data[8]

The data payload of the frame.

Definition at line 33 of file can_message_frame.hpp.

◆ dataLength

std::uint8_t isobus::CANMessageFrame::dataLength

The length of the data used in the frame.

Definition at line 34 of file can_message_frame.hpp.

◆ identifier

std::uint32_t isobus::CANMessageFrame::identifier

The 32 bit identifier of the frame.

Definition at line 31 of file can_message_frame.hpp.

◆ isExtendedFrame

bool isobus::CANMessageFrame::isExtendedFrame

Denotes if the frame is extended format.

Definition at line 35 of file can_message_frame.hpp.

◆ timestamp_us

std::uint64_t isobus::CANMessageFrame::timestamp_us

A microsecond timestamp.

Definition at line 30 of file can_message_frame.hpp.


The documentation for this class was generated from the following files: