com.digi.android.can

Class CANId

java.lang.Object

com.digi.android.can.CANId

public class CANId
extends java.lang.Object

This class represents a CAN Frame identifier.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_EXTENDED_MAX_LENGTH Maximum length for extended ID: 29 bits.
static int	ID_MAX_LENGTH Maximum length for ID: 11 bits.

Constructor Summary

Constructors

Constructor and Description
CANId(int value, boolean extended) Creates a CAN identifier with the given value and whether it is extended.

Method Summary

Modifier and Type	Method and Description
int	getValue() Retrieves the value of this CAN identifier.
boolean	isExtended() Returns if this CAN identifier is extended.

Methods inherited from class java.lang.Object

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

Field Detail

ID_MAX_LENGTH

public static final int ID_MAX_LENGTH

Maximum length for ID: 11 bits.

See Also:

Constant Field Values

ID_EXTENDED_MAX_LENGTH

public static final int ID_EXTENDED_MAX_LENGTH

Maximum length for extended ID: 29 bits.

See Also:

Constant Field Values

Constructor Detail

CANId

public CANId(int value,
             boolean extended)

Creates a CAN identifier with the given value and whether it is extended.

A standard identifier (extended = false) has 11 bits.

An extended identifier (extended = true) has 29 bits.

Parameters:

value - The value of this CAN identifier.

extended - true if it is extended, false otherwise.

Throws:

java.lang.IllegalArgumentException - If the length of value is invalid.

Method Detail

getValue

public int getValue()

Retrieves the value of this CAN identifier.

Returns:

The value of this CAN identifier.

isExtended

public boolean isExtended()

Returns if this CAN identifier is extended.

Returns:

true if it is extended, false otherwise.