A single symbol within a CAN bus protocol decode. More...

#include <CANChannel.h>

Public Types
enum	stype { TYPE_SOF , TYPE_ID , TYPE_RTR , TYPE_R0 , TYPE_FD , TYPE_DLC , TYPE_DATA , TYPE_CRC_OK , TYPE_CRC_BAD , TYPE_CRC_DELIM , TYPE_ACK , TYPE_ACK_DELIM , TYPE_EOF }
	Type of the symbol. More...

Public Member Functions
	CANSymbol ()
	Default constructor, performs no initialization.

	CANSymbol (stype t, uint32_t data)
	Initializes a CAN symbol. More...

bool	operator== (const CANSymbol &s) const
	Checks this symbol for equality against a second. More...

Public Attributes
stype	m_stype
	Type of the symbol.

uint32_t	m_data
	Data value (meaning depends on type)

Detailed Description

A single symbol within a CAN bus protocol decode.

Member Enumeration Documentation

Type of the symbol.

Enumerator
TYPE_SOF	Start of frame.
TYPE_ID	CAN ID.
TYPE_RTR	Remote transmission request bit.
TYPE_R0	Reserved bit.
TYPE_FD	Full-duplex bit.
TYPE_DLC	Data length code.
TYPE_DATA	A data byte.
TYPE_CRC_OK	CRC with a correct value.
TYPE_CRC_BAD	CRC with an incorrect value.
TYPE_CRC_DELIM	CRC delimiter.
TYPE_ACK	Acknowledgement bit.
TYPE_ACK_DELIM	ACK delimiter.
TYPE_EOF	End of frame.

inline

Initializes a CAN symbol.

Parameters

t	Type of the symbol
data	Data value

bool CANSymbol::operator== ( const CANSymbol & s ) const

inline

Checks this symbol for equality against a second.

Two symbols are considered equal if both the type and data are equal.

Parameters

s	The other symbol

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