de.morknet.mrw.comm

Class MrwMessage

java.lang.Object

de.morknet.mrw.comm.can.CANMessage

de.morknet.mrw.comm.MrwMessage

public class MrwMessage
extends CANMessage

Diese Klasse repräsentiert eine MRW-Message. Diese kann entweder ein Kommando, oder eine Kommando-Rückmeldung beinhalten. Die Klasse ist von CANMessage abgeleitet, welche nur eine allgemeine Form einer CAN-Meldung darstellt. Diese Klasse ist speziell für MRW zugeschnitten und beinhaltet so auch einige nützliche Konstanten.

Author:

smork

Field Summary

Fields

Modifier and Type	Field and Description
static int	BROADCAST_SID Die Boradcast ID.
static int	GATEWAY_SID Die Standard ID des RS232-CAN-Gateway.
static int	IDX_COMMAND Der Data-Index für den Command.
static int	IDX_HEID Der Data-Index für das High Byte der Gerätenummer des sendenden Controller.
static int	IDX_INFO_START Der Data-Index für den Start der Infobytes.
static int	IDX_LEID Der Data-Index für das Low Byte der Gerätenummer des sendenden Controller.
static int	IDX_MSG_CODE Der Data-Index für den MsgCode.
static int	IDX_RESULT Der Data-Index für den Rückmelde-Code des Kommandos.
static int	IDX_SIGNAL_CODE Der Data-Index für den SignalCode beim SETSGN-Kommando.
static boolean	xUSE_SID_IN_RESULT Diese Flag gibt an, ob die sendende Controller-Adresse auch in der Result-Meldung enthalten sein soll.

Fields inherited from class de.morknet.mrw.comm.can.CANMessage

data, eid, FRAME_EXT, FRAME_REMOTE, length, RX_STAT_FRAME_EXTENDED, RX_STAT_FRAME_REMOTE, sid, status

Constructor Summary

Constructors

Constructor and Description
MrwMessage() Der Konstruktur für eine leere MRW-Message.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataByte(Command cmd) Diese Methode fügt einer Meldung ein Kommando-Code hinzu.
static int	computeWord(int l, int h) Diese Methode baut aus zwei Int-Werten einen 16-bit-Wert zusammen.
static MrwMessage	createCommandMsg(Command cmd, int id, int no) Diese statische Methode erzeugt eine Meldung und initialisiert diese.
static MrwMessage	createGetVersionMsg() Erzeugt eine Versionsabfrage-Meldung.
static MrwMessage	createPingMsg() Erzeugt eine Ping-Meldung.
static MrwMessage	createQueryBufferMsg() Erzeugt eine Query Buffer State Meldung.
static MrwMessage	createQueryErrorMsg() Erzeugt eine Query Error State Meldung.
static MrwMessage	createResetMsg() Erzeugt eine Reset-Meldung.
static MrwMessage	createResultMessage(Command cmd, MsgCode code, int id, int no) Diese Methode erzeugt eine Antwort-Meldung.
void	dump(java.lang.String comment) Diese Methode gibt den Inhalt dieser Meldung im Klartext aus.
Command	getCommand() Gibt das Kommando zurück, das dieser Ergebnis-Meldung zu Grunde liegt.
MsgCode	getResultCode() Gibt den Ergebnis-Code zurück.
int	getResultId() Gibt die gesamte ID des Absenders an.
int	getSourceControllerId() Gibt die ID des Quellcontrollers zurück.
int	getSourceUnitNo() Gibt die ID des Quellgerätes zurück.
boolean	isResult() Prüft, ob es sich um eine Ergebnis-Meldung handelt.
java.lang.String	toString() Wandelt den Inhalt dieser Meldung in Klartext um.

Methods inherited from class de.morknet.mrw.comm.can.CANMessage

addDataByte, addDataWord, getBytes, getData, getEid, getId, getSid, isExtended, length, modifyData, setEid, setExtended, setSid

Methods inherited from class java.lang.Object

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

Field Detail

BROADCAST_SID

public static final int BROADCAST_SID

Die Boradcast ID.

See Also:

Constant Field Values

GATEWAY_SID

public static final int GATEWAY_SID

Die Standard ID des RS232-CAN-Gateway.

See Also:

Constant Field Values

IDX_COMMAND

public static final int IDX_COMMAND

Der Data-Index für den Command.

See Also:

Constant Field Values

IDX_RESULT

public static final int IDX_RESULT

Der Data-Index für den Rückmelde-Code des Kommandos.

See Also:

Constant Field Values

IDX_MSG_CODE

public static final int IDX_MSG_CODE

Der Data-Index für den MsgCode.

See Also:

Constant Field Values

IDX_SIGNAL_CODE

public static final int IDX_SIGNAL_CODE

Der Data-Index für den SignalCode beim SETSGN-Kommando.

See Also:

Constant Field Values

xUSE_SID_IN_RESULT

public static final boolean xUSE_SID_IN_RESULT

Diese Flag gibt an, ob die sendende Controller-Adresse auch in der Result-Meldung enthalten sein soll. Diese Adresse ist schon in der OID eingebaut, so dass sie hier doppelt übertragen wird.

See Also:

Constant Field Values

IDX_INFO_START

public static final int IDX_INFO_START

Der Data-Index für den Start der Infobytes.

See Also:

Constant Field Values

IDX_LEID

public static final int IDX_LEID

Der Data-Index für das Low Byte der Gerätenummer des sendenden Controller.

See Also:

Constant Field Values

IDX_HEID

public static final int IDX_HEID

Der Data-Index für das High Byte der Gerätenummer des sendenden Controller.

See Also:

Constant Field Values

Constructor Detail

MrwMessage

public MrwMessage()

Der Konstruktur für eine leere MRW-Message.

Method Detail

isResult

public boolean isResult()

Prüft, ob es sich um eine Ergebnis-Meldung handelt.

Returns:

True, falls diese Meldung eine Ergebnis-Meldung ist.

getResultId

public int getResultId()

Gibt die gesamte ID des Absenders an. Das erzwingt eine Überprüfung auf eine Ergebnis-Meldung.

Returns:

Die gesamte ID des Absenders.

getResultCode

public MsgCode getResultCode()

Gibt den Ergebnis-Code zurück. Das erzwingt eine Überprüfung auf eine Ergebnis-Meldung.

Returns:

Der Ergebnis-Code der Meldung.

getCommand

public Command getCommand()

Gibt das Kommando zurück, das dieser Ergebnis-Meldung zu Grunde liegt. Das erzwingt eine Überprüfung auf eine Ergebnis-Meldung.

Returns:

Das auslösende Kommando.

createCommandMsg

public static MrwMessage createCommandMsg(Command cmd,
                          int id,
                          int no)

Diese statische Methode erzeugt eine Meldung und initialisiert diese.

Parameters:

cmd - Das Kommando

id - Der Ziel-Controller

no - Das Ziel Gerät

Returns:

Die erzeugt Meldung.

createPingMsg

public static MrwMessage createPingMsg()

Erzeugt eine Ping-Meldung.

Returns:

Die erzeugte Ping-Meldung.

createQueryBufferMsg

public static MrwMessage createQueryBufferMsg()

Erzeugt eine Query Buffer State Meldung.

Returns:

Die erzeugte Query Buffer State Meldung

createQueryErrorMsg

public static MrwMessage createQueryErrorMsg()

Erzeugt eine Query Error State Meldung.

Returns:

Die erzeugte Query Error State Meldung

createResetMsg

public static MrwMessage createResetMsg()

Erzeugt eine Reset-Meldung.

Returns:

Die erzeugte Reset-Meldung.

createGetVersionMsg

public static MrwMessage createGetVersionMsg()

Erzeugt eine Versionsabfrage-Meldung.

Returns:

Die erzeugte Versionsabfrage-Meldung.

createResultMessage

public static MrwMessage createResultMessage(Command cmd,
                             MsgCode code,
                             int id,
                             int no)

Diese Methode erzeugt eine Antwort-Meldung. Eine so erzeugte Meldung macht nur zu Simulationszwecken Sinn.

Parameters:

cmd - Der Kommando-Code

code - Der Antwort-Code

id - Die Controller-ID von der die Antwort stammen soll.

no - Die Gerätenummer, die die Antwort erzeugt.

Returns:

Die Antwort-Meldung.

addDataByte

public void addDataByte(Command cmd)

Diese Methode fügt einer Meldung ein Kommando-Code hinzu.

Parameters:

cmd - Der hinzuzufügende Kommando-Code.

toString

public java.lang.String toString()

Wandelt den Inhalt dieser Meldung in Klartext um.

Overrides:

toString in class java.lang.Object

Returns:

Klartext Der Klartext dieser meldung.

dump

public void dump(java.lang.String comment)

Diese Methode gibt den Inhalt dieser Meldung im Klartext aus.

Overrides:

dump in class CANMessage

Parameters:

comment - Ein optionaler zusätzlicher Kommentar.

getSourceControllerId

public int getSourceControllerId()

Gibt die ID des Quellcontrollers zurück.

Returns:

Die ID des Absenders.

getSourceUnitNo

public int getSourceUnitNo()

Gibt die ID des Quellgerätes zurück.

Returns:

Die ID des Gerätes.

computeWord

public static int computeWord(int l,
              int h)

Diese Methode baut aus zwei Int-Werten einen 16-bit-Wert zusammen.

Parameters:

l - Das Lowbyte.

h - Date Highbyte.

Returns:

Das zusammengesetzte 16-Bit-Wort.