de.morknet.mrw.comm.can

Class CANMessage

java.lang.Object

de.morknet.mrw.comm.can.CANMessage

Direct Known Subclasses:

MrwMessage

public class CANMessage
extends java.lang.Object

Diese Klasse repräsentiert eine CAN-Message.

Author:

sm

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	data Hier wird die Nutzlast der CAN-Message gespeichert.
protected int	eid Die Extended Object ID.
static int	FRAME_EXT Flag, ob es sich hierbei um ein Extended Frame handelt.
static int	FRAME_REMOTE Flag, ob es sich hierbei um ein Remote Frame handelt.
protected int	length Die Länge der CAN-Message.
static int	RX_STAT_FRAME_EXTENDED Die empfangene CAN-Message ist ein Extended Frame
static int	RX_STAT_FRAME_REMOTE Die empfangene CAN-Message ist ein Remote Frame.
protected int	sid Die Standard Object ID.
protected int	status Der Zustand der CAN-Message.

Constructor Summary

Constructors

Constructor and Description
CANMessage(int sid, int eid, int status) Dieser Konstruktor initialisiert diese CAN-Message mit IDs und Status.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataByte(int i) Diese Methode fügt dieser CAN-Message ein Byte hinzu.
void	addDataWord(int i) Diese Methode fügt dieser CAN-Message ein Wort hinzu.
void	dump(java.lang.String comment) Diese Methode loggt diese CAN-Message im Klartext aus.
byte[]	getBytes() Diese Methode gibt diese CAN-Meldung als Folge von Bytes zurück, so dass sie sofort versendet werden können.
int	getData(int idx) Diese Methode gibt ein Datenbyte aus der CAN-Message zurück.
int	getEid() Diese Methode gibt die Extended-ID zurück.
java.lang.Integer	getId() Diese Methode baut aus der Standard-ID und der Extended-ID eine 32-Bit-ID zusammen.
int	getSid() Diese Methode gibt die Standard-ID zurück.
boolean	isExtended() Diese Methode gibt zurück, ob es sich bei dieser CAN-Message um ein Extended Frame handelt.
int	length() Diese Methode gibt die Länge der CAN-Meldung zurück.
void	modifyData(int idx, int value) Diese Methode modifiziert ein Datenbyte in der CAN-Message.
void	setEid(int eid) Diese Methode setzt die Standard-ID.
void	setExtended(boolean ext) Diese Methode definiert, ob diese CAN-Message ein Standard Frame oder ein Extended Frame sein soll.
void	setSid(int sid) Diese Methode setzt die Standard-ID.
(package private) void	setStatus(int status) Diese Methode setzt den Zustand dieser CAN-Message.

Methods inherited from class java.lang.Object

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

Field Detail

FRAME_REMOTE

public static final int FRAME_REMOTE

Flag, ob es sich hierbei um ein Remote Frame handelt.

See Also:

Constant Field Values

FRAME_EXT

public static final int FRAME_EXT

Flag, ob es sich hierbei um ein Extended Frame handelt.

See Also:

Constant Field Values

RX_STAT_FRAME_REMOTE

public static final int RX_STAT_FRAME_REMOTE

Die empfangene CAN-Message ist ein Remote Frame.

See Also:

Constant Field Values

RX_STAT_FRAME_EXTENDED

public static final int RX_STAT_FRAME_EXTENDED

Die empfangene CAN-Message ist ein Extended Frame

See Also:

Constant Field Values

sid

protected int sid

Die Standard Object ID.

eid

protected int eid

Die Extended Object ID.

status

protected int status

Der Zustand der CAN-Message. Hier wird definiert, ob es sich um ein Remote oder/und Extended Frame handelt.

See Also:

FRAME_REMOTE, FRAME_EXT

length

protected int length

Die Länge der CAN-Message. Dieser Wert darf zwischen 0 und 8 inkl. variieren.

data

protected final int[] data

Hier wird die Nutzlast der CAN-Message gespeichert.

Constructor Detail

CANMessage

public CANMessage(int sid,
          int eid,
          int status)

Dieser Konstruktor initialisiert diese CAN-Message mit IDs und Status.

Parameters:

sid - Die 11-bittige Standard-ID.

eid - Die 18-bittige zusätzliche Extended-ID

status - Flag, ob die Extended-ID gültig ist, bzw. ob es sich um ein Remote Frame handelt.

See Also:

FRAME_EXT, FRAME_REMOTE

Method Detail

getBytes

public final byte[] getBytes()

Diese Methode gibt diese CAN-Meldung als Folge von Bytes zurück, so dass sie sofort versendet werden können.

Returns:

Die zu versendenden Bytes dieser CAN-Meldung.

addDataByte

public final void addDataByte(int i)

Diese Methode fügt dieser CAN-Message ein Byte hinzu. Es muss noch Platz im Frame (max. acht Bytes) sein, damit keine IllegalStateException geworfen wird.

Parameters:

i - Das hinzuzufügende Byte.

addDataWord

public final void addDataWord(int i)

Diese Methode fügt dieser CAN-Message ein Wort hinzu. Es muss noch Platz im Frame (max. acht Bytes) sein, damit keine IllegalStateException geworfen wird. Das Wort wird in Little Endian gespeichert. (Low Byte first).

Parameters:

i - Das hinzuzufügende Wort.

getData

public final int getData(int idx)

Diese Methode gibt ein Datenbyte aus der CAN-Message zurück. Ein Index außerhalb des gültigen Bereichs forciert eine ArrayIndexOutOfBoundsException.

Parameters:

idx - Der Datenindex.

Returns:

Das angeforderte Datenbyte.

modifyData

public final void modifyData(int idx,
              int value)

Diese Methode modifiziert ein Datenbyte in der CAN-Message. Ein Index außerhalb des gültigen Bereichs forciert eine ArrayIndexOutOfBoundsException.

Parameters:

idx - Der Datenindex.

value - Das zu modifizierende Byte.

getSid

public final int getSid()

Diese Methode gibt die Standard-ID zurück.

Returns:

Die Standard-ID.

setSid

public final void setSid(int sid)

Diese Methode setzt die Standard-ID.

Parameters:

sid - Die zu setzende Standard-ID.

getEid

public final int getEid()

Diese Methode gibt die Extended-ID zurück. Die 18-bittige ID ist rechtsbündig!

Returns:

Die Extended-ID.

setEid

public final void setEid(int eid)

Diese Methode setzt die Standard-ID. Die 18-bittige ID ist rechtsbündig!

Parameters:

eid - Die zu setzende Standard-ID.

setStatus

void setStatus(int status)

Diese Methode setzt den Zustand dieser CAN-Message.

Parameters:

status - Der neue Zustand dieser CAN-Message.

See Also:

FRAME_EXT, FRAME_REMOTE

setExtended

public final void setExtended(boolean ext)

Diese Methode definiert, ob diese CAN-Message ein Standard Frame oder ein Extended Frame sein soll.

Parameters:

ext - Flag, das zwischen Standard und Extended Frame unterscheidet.

getId

public java.lang.Integer getId()

Diese Methode baut aus der Standard-ID und der Extended-ID eine 32-Bit-ID zusammen. Die oberen 2 Bits der 18-bittigen Extended-ID gehen dabei verloren. Die Standard-ID ist in den oberen 16 Bit untergebracht, die Extended-ID in den unteren.

Returns:

Die zusammengesetzte ID.

isExtended

public boolean isExtended()

Diese Methode gibt zurück, ob es sich bei dieser CAN-Message um ein Extended Frame handelt.

Returns:

Flag, ob CAN-Message ein Extended Frame ist.

length

public int length()

Diese Methode gibt die Länge der CAN-Meldung zurück.

Returns:

Die Länge der CAN-Meldung.

dump

public void dump(java.lang.String comment)

Diese Methode loggt diese CAN-Message im Klartext aus.

Parameters:

comment - Ein ergänzender Kommentar.