jmri.jmrix.sprog
Class SprogMessage

java.lang.Object
  jmri.jmrix.AbstractMessage
      jmri.jmrix.AbstractMRMessage
          jmri.jmrix.sprog.SprogMessage

All Implemented Interfaces:

Message

public class SprogMessage
extends AbstractMRMessage

Encodes a message to an SPROG command station.

The SprogReply class handles the response from the command station.

Author:

Bob Jacobsen Copyright (C) 2001

Field Summary

static int	CR
static int	DLE
static int	ER_FLASH
static int	ETX
static int	LF
static int	MAXSIZE
static int	RD_VER
static int	STX
static int	WT_EEDATA
static int	WT_FLASH

Fields inherited from class jmri.jmrix.AbstractMRMessage

LONG_TIMEOUT, SHORT_TIMEOUT

Constructor Summary

SprogMessage(int i)

SprogMessage(SprogMessage m)

SprogMessage(String s)

Method Summary

SprogMessage	frame()
int	getElement(int n)
static SprogMessage	getEnableMain()
static SprogMessage	getEraseFlash(int addr, int rows)
static SprogMessage	getExitProgMode()
static SprogMessage	getKillMain()
int	getNumDataElements()
int	getOpCode()
String	getOpCodeHex()
static SprogMessage	getProgMode()
static SprogMessage	getReadBootVersion()
static SprogMessage	getReadCV(int cv, int mode)
static SprogMessage	getReadRegister(int reg)
static SprogMessage	getReset()
static SprogMessage	getStatus()
static SprogMessage	getV4EndOfFile()
static SprogMessage	getv4ExtAddr()
static SprogMessage	getV4WriteFlash(int addr, int[] data, int type)
static SprogMessage	getWriteCV(int cv, int val, int mode)
static SprogMessage	getWriteEE(int addr, int[] data)
static SprogMessage	getWriteFlash(int addr, int[] data)
static SprogMessage	getWriteRegister(int reg, int val)
boolean	isEnableMain()
boolean	isKillMain()
static SprogMessage	sendPacketMessage(byte[] bytes) Send a DCC packet
void	setAddress(int i)
void	setChecksum()
void	setData(int[] d)
void	setElement(int n, int v)
void	setLength(int i)
void	setOpCode(int i)
void	setV4Address(int i)
void	setV4Checksum(int length, int addr, int type, int[] data)
void	setV4Data(int[] d)
void	setV4Length(int i)
void	setV4RecType(int i)
String	toString()
SprogMessage	v4frame()

Methods inherited from class jmri.jmrix.AbstractMRMessage

addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getRetries, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setRetries, setTimeout

Methods inherited from class java.lang.Object

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

Field Detail

STX

public static final int STX

See Also:

Constant Field Values

DLE

public static final int DLE

See Also:

Constant Field Values

ETX

public static final int ETX

See Also:

Constant Field Values

CR

public static final int CR

See Also:

Constant Field Values

LF

public static final int LF

See Also:

Constant Field Values

RD_VER

public static final int RD_VER

See Also:

Constant Field Values

WT_FLASH

public static final int WT_FLASH

See Also:

Constant Field Values

ER_FLASH

public static final int ER_FLASH

See Also:

Constant Field Values

WT_EEDATA

public static final int WT_EEDATA

See Also:

Constant Field Values

MAXSIZE

public static int MAXSIZE

Constructor Detail

SprogMessage

public SprogMessage(int i)

SprogMessage

public SprogMessage(String s)

SprogMessage

public SprogMessage(SprogMessage m)

Method Detail

setOpCode

public void setOpCode(int i)

Overrides:

setOpCode in class AbstractMRMessage

getOpCode

public int getOpCode()

Overrides:

getOpCode in class AbstractMRMessage

getOpCodeHex

public String getOpCodeHex()

Overrides:

getOpCodeHex in class AbstractMRMessage

getNumDataElements

public int getNumDataElements()

Specified by:

getNumDataElements in interface Message

Overrides:

getNumDataElements in class AbstractMessage

getElement

public int getElement(int n)

Specified by:

getElement in interface Message

Overrides:

getElement in class AbstractMessage

setElement

public void setElement(int n,
                       int v)

Specified by:

setElement in interface Message

Overrides:

setElement in class AbstractMessage

setLength

public void setLength(int i)

setV4Length

public void setV4Length(int i)

setAddress

public void setAddress(int i)

setV4Address

public void setV4Address(int i)

setV4RecType

public void setV4RecType(int i)

setData

public void setData(int[] d)

setV4Data

public void setV4Data(int[] d)

setChecksum

public void setChecksum()

setV4Checksum

public void setV4Checksum(int length,
                          int addr,
                          int type,
                          int[] data)

frame

public SprogMessage frame()

v4frame

public SprogMessage v4frame()

toString

public String toString()

Specified by:

toString in interface Message

Overrides:

toString in class AbstractMRMessage

isKillMain

public boolean isKillMain()

isEnableMain

public boolean isEnableMain()

getEnableMain

public static SprogMessage getEnableMain()

getKillMain

public static SprogMessage getKillMain()

getProgMode

public static SprogMessage getProgMode()

getExitProgMode

public static SprogMessage getExitProgMode()

getStatus

public static SprogMessage getStatus()

getReadCV

public static SprogMessage getReadCV(int cv,
                                     int mode)

getWriteCV

public static SprogMessage getWriteCV(int cv,
                                      int val,
                                      int mode)

getReadRegister

public static SprogMessage getReadRegister(int reg)

getWriteRegister

public static SprogMessage getWriteRegister(int reg,
                                            int val)

sendPacketMessage

public static SprogMessage sendPacketMessage(byte[] bytes)

Send a DCC packet

Parameters:

bytes - byte[]

Returns:

SprogMessage

getReadBootVersion

public static SprogMessage getReadBootVersion()

getWriteFlash

public static SprogMessage getWriteFlash(int addr,
                                         int[] data)

getV4WriteFlash

public static SprogMessage getV4WriteFlash(int addr,
                                           int[] data,
                                           int type)

getV4EndOfFile

public static SprogMessage getV4EndOfFile()

getv4ExtAddr

public static SprogMessage getv4ExtAddr()

getEraseFlash

public static SprogMessage getEraseFlash(int addr,
                                         int rows)

getWriteEE

public static SprogMessage getWriteEE(int addr,
                                      int[] data)

getReset

public static SprogMessage getReset()