CANMessage Class Reference

CANMessage class. More...

#include <InterfaceCAN.h>

Inheritance diagram for CANMessage:

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

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

Detailed Description

CANMessage class.

Definition at line 48 of file InterfaceCAN.h.

Constructor & Destructor Documentation

CANMessage() [1/4]

CANMessage

(

)

Creates empty CAN message.

Definition at line 53 of file InterfaceCAN.h.

CANMessage() [2/4]

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

Creates CAN message with specific content.

Parameters

_id	Message ID
_data	Mesaage Data
_len	Message Data length
_type	Type of Data: Use enum CANType for valid parameter values
_format	Data Format: Use enum CANFormat for valid parameter values

Definition at line 70 of file InterfaceCAN.h.

CANMessage() [3/4]

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

Creates CAN message with specific content.

Parameters

_id	Message ID
_data	Mesaage Data
_len	Message Data length
_type	Type of Data: Use enum CANType for valid parameter values
_format	Data Format: Use enum CANFormat for valid parameter values

Definition at line 88 of file InterfaceCAN.h.

CANMessage() [4/4]

CANMessage	(	unsigned int	_id,
		CANFormat	_format = CANStandard
	)

Creates CAN remote message.

Parameters

_id	Message ID
_format	Data Format: Use enum CANType for valid parameter values

Definition at line 102 of file InterfaceCAN.h.

Member Function Documentation

operator==()

bool operator==

(

const CANMessage &

b

)

const

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

Definition at line 114 of file InterfaceCAN.h.

Field Documentation

id

unsigned int id

inherited

29 bit identifier

Definition at line 62 of file can_helper.h.

data

unsigned char data[8]

inherited

Data field.

Definition at line 63 of file can_helper.h.

len

unsigned char len

inherited

Length of data field in bytes.

Definition at line 64 of file can_helper.h.

format

CANFormat format

inherited

Format CANFormat.

Definition at line 65 of file can_helper.h.

type

CANType type

inherited

Type CANType.

Definition at line 66 of file can_helper.h.