Mbed OS Reference
Loading...
Searching...
No Matches
CANFDMessage Class Reference

CANFDMessage class. More...

#include <InterfaceCAN.h>

Inheritance diagram for CANFDMessage:
CANFD_Message

Public Member Functions

 CANFDMessage ()
 Creates empty CANFD message.
 
 CANFDMessage (unsigned int _id, const unsigned char *_data, unsigned char _len=64, CANType _type=CANData, CANFormat _format=CANStandard)
 Creates CANFD message with specific content.
 
 CANFDMessage (unsigned int _id, const char *_data, unsigned char _len=64, CANType _type=CANData, CANFormat _format=CANStandard)
 Creates CANFD message with specific content.
 
 CANFDMessage (unsigned int _id, CANFormat _format=CANStandard)
 Creates CANFD remote message.
 
bool operator== (const CANFDMessage &b) const
 "Deep" comparison operator (ie: compare value of each data member)
 

Data Fields

unsigned int id
 29 bit identifier
 
unsigned char data [64]
 Data field.
 
unsigned char len
 Length of data field in bytes.
 
CANFormat format
 Format CANFormat.
 
CANType type
 Type CANType.
 

Detailed Description

CANFDMessage class.

Definition at line 145 of file InterfaceCAN.h.

Constructor & Destructor Documentation

◆ CANFDMessage() [1/4]

Creates empty CANFD message.

Definition at line 150 of file InterfaceCAN.h.

◆ CANFDMessage() [2/4]

CANFDMessage ( unsigned int  _id,
const unsigned char *  _data,
unsigned char  _len = 64,
CANType  _type = CANData,
CANFormat  _format = CANStandard 
)

Creates CANFD message with specific content.

Parameters
_idMessage ID
_dataMesaage Data
_lenMessage Data length
_typeType of Data: Use enum CANType for valid parameter values
_formatData Format: Use enum CANFormat for valid parameter values

Definition at line 167 of file InterfaceCAN.h.

◆ CANFDMessage() [3/4]

CANFDMessage ( unsigned int  _id,
const char *  _data,
unsigned char  _len = 64,
CANType  _type = CANData,
CANFormat  _format = CANStandard 
)

Creates CANFD message with specific content.

Parameters
_idMessage ID
_dataMesaage Data
_lenMessage Data length
_typeType of Data: Use enum CANType for valid parameter values
_formatData Format: Use enum CANFormat for valid parameter values

Definition at line 185 of file InterfaceCAN.h.

◆ CANFDMessage() [4/4]

CANFDMessage ( unsigned int  _id,
CANFormat  _format = CANStandard 
)

Creates CANFD remote message.

Parameters
_idMessage ID
_formatData Format: Use enum CANType for valid parameter values

Definition at line 199 of file InterfaceCAN.h.

Member Function Documentation

◆ operator==()

bool operator== ( const CANFDMessage b) const

"Deep" comparison operator (ie: compare value of each data member)

Definition at line 211 of file InterfaceCAN.h.

Field Documentation

◆ id

unsigned int id
inherited

29 bit identifier

Definition at line 80 of file can_helper.h.

◆ data

unsigned char data[64]
inherited

Data field.

Definition at line 81 of file can_helper.h.

◆ len

unsigned char len
inherited

Length of data field in bytes.

Definition at line 82 of file can_helper.h.

◆ format

CANFormat format
inherited

Format CANFormat.

Definition at line 83 of file can_helper.h.

◆ type

CANType type
inherited

Type CANType.

Definition at line 84 of file can_helper.h.