Package com.digi.android.can

Class CANFrame

java.lang.Object

com.digi.android.can.CANFrame

public class CANFrame
extends java.lang.Object

This class represents a received or sent CAN frame.

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_CAN_DATA	Maximum length of a CAN frame: bytes.

Constructor Summary

Constructors

Constructor	Description
CANFrame(CAN canInterface, CANId id, boolean rtr, boolean errorMsg, byte[] data)	Creates a CAN Frame with the given parameters.
CANFrame(CAN canInterface, CANId id, byte[] data)	Creates a CAN Frame with the given interface, ID, and data.

Method Summary

Modifier and Type	Method	Description
CAN	getCAN()	Retrieves the CAN interface where this CAN frame was received or sent.
byte[]	getData()	Retrieves the CAN frame's data.
int	getDlc()	Retrieves the CAN frame's data length code.
CANId	getId()	Retrieves the CAN frame's ID.
boolean	isErrorMessage()	Retrieves if this is a error message frame.
boolean	isRTR()	Retrieves if this is a remote transmission request (RTR).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_CAN_DATA

public static final int MAX_CAN_DATA

Maximum length of a CAN frame: bytes.

See Also:

Constant Field Values

Constructor Detail

CANFrame

public CANFrame(CAN canInterface,
                CANId id,
                byte[] data)

Creates a CAN Frame with the given interface, ID, and data.

Parameters:

canInterface - The CAN interface where this CAN frame was received or sent.

id - The CAN frame's ID.

data - The CAN frame's data.

Throws:

java.lang.IllegalArgumentException - if data.length > .

java.lang.NullPointerException - if canInterface == null or if id == null or if data == null.

See Also:

CAN, CANId

CANFrame

public CANFrame(CAN canInterface,
                CANId id,
                boolean rtr,
                boolean errorMsg,
                byte[] data)

Creates a CAN Frame with the given parameters.

Parameters:

canInterface - The CAN interface where this CAN frame was received or sent.

id - The CAN frame's ID.

rtr - true if this is a RTR, false otherwise.

errorMsg - true if this is a error message frame, false otherwise.

data - The CAN frame's data.

Throws:

java.lang.IllegalArgumentException - if data.length > .

java.lang.NullPointerException - if canInterface == null or if id == null or if data == null.

See Also:

CAN, CANId

Method Detail

getCAN

public CAN getCAN()

Retrieves the CAN interface where this CAN frame was received or sent.

Returns:

The CAN interface where this CAN frame was received or sent.

See Also:

CAN

getId

public CANId getId()

Retrieves the CAN frame's ID.

Returns:

The CAN frame's ID.

See Also:

CANId

isRTR

public boolean isRTR()

Retrieves if this is a remote transmission request (RTR).

Returns:

true if this is a RTR, false otherwise.

isErrorMessage

public boolean isErrorMessage()

Retrieves if this is a error message frame.

Returns:

true if this is a error message, false otherwise.

getDlc

public int getDlc()

Retrieves the CAN frame's data length code.

Returns:

The CAN frame's data length code.

getData

public byte[] getData()

Retrieves the CAN frame's data.

Returns:

The CAN frame's data.