Package jmri.jmrix.mrc

Class MrcPackets

java.lang.Object

jmri.jmrix.mrc.MrcPackets

public class MrcPackets
extends Object

Some of the message formats used in this class are Copyright MRC, Inc. and used with permission as part of the JMRI project. That permission does not extend to uses in other software products. If you wish to use this code, algorithm or these message formats outside of JMRI, please contact Mrc Inc for separate permission.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCESSORYPACKETCMD
(package private) static final int[]	ACCESSORYPACKETHEADER
(package private) static final int	ACCESSORYPACKETLENGTH
static final int	ADDTOCONSISTPACKETCMD
(package private) static final int[]	ADDTOCONSISTPACKETHEADER
(package private) static final int	ADDTOCONSISTPACKETLENGTH
static final int	ADDTOROUTEPACKETCMD
(package private) static final int[]	ADDTOROUTEPACKETHEADER
(package private) static final int	ADDTOROUTEPACKETLENGTH
(package private) static final int[]	BADCMDRECEIVED
static final int	BADCMDRECEIVEDCODE
static final int	CLEARCONSISTPACKETCMD
(package private) static final int[]	CLEARCONSISTPACKETHEADER
(package private) static final int	CLEARCONSISTPACKETLENGTH
static final int	CLEARROUTEPACKETCMD
(package private) static final int[]	CLEARROUTEPACKETHEADER
(package private) static final int	CLEARROUTEPACKETLENGTH
static final int	FUNCTIONGROUP1PACKETCMD
(package private) static final int[]	FUNCTIONGROUP1PACKETHEADER
static final int	FUNCTIONGROUP2PACKETCMD
(package private) static final int[]	FUNCTIONGROUP2PACKETHEADER
static final int	FUNCTIONGROUP3PACKETCMD
(package private) static final int[]	FUNCTIONGROUP3PACKETHEADER
static final int	FUNCTIONGROUP4PACKETCMD
(package private) static final int[]	FUNCTIONGROUP4PACKETHEADER
static final int	FUNCTIONGROUP5PACKETCMD
(package private) static final int[]	FUNCTIONGROUP5PACKETHEADER
static final int	FUNCTIONGROUP6PACKETCMD
(package private) static final int[]	FUNCTIONGROUP6PACKETHEADER
(package private) static final int	FUNCTIONGROUPLENGTH
(package private) static final int[]	GOODCMDRECEIVED
static final int	GOODCMDRECEIVEDCODE
(package private) static final int[]	LOCODBLCONTROL
static final int	LOCODBLCONTROLCODE
(package private) static final int[]	LOCOSOLECONTROL
static final int	LOCOSOLECONTROLCODE
(package private) static final int[]	POWEROFF
static final int	POWEROFFCMD
(package private) static final int[]	POWERON
static final int	POWERONCMD
(package private) static final int[]	PROGCMDSENT
static final int	PROGCMDSENTCODE
static final int	READCVCMD
(package private) static final int[]	READCVHEADER
(package private) static final int[]	READCVHEADERREPLY
static final int	READCVHEADERREPLYCODE
(package private) static final int	READCVPACKETLENGTH
(package private) static final int[]	READDECODERADDRESS
static final int	READDECODERADDRESSCMD
static final int	ROUTECONTROLPACKETCMD
(package private) static final int[]	ROUTECONTROLPACKETHEADER
(package private) static final int	ROUTECONTROLPACKETLENGTH
static final int	SETCLOCKAMPMCMD
(package private) static final int[]	SETCLOCKAMPMHEADER
static final int	SETCLOCKRATIOCMD
(package private) static final int[]	SETCLOCKRATIOHEADER
static final int	SETCLOCKTIMECMD
(package private) static final int[]	SETCLOCKTIMEHEADER
static final int	THROTTLEPACKETCMD
(package private) static final int[]	THROTTLEPACKETHEADER
(package private) static final int	THROTTLEPACKETLENGTH
static final int	WRITECVPOMCMD
(package private) static final int[]	WRITECVPOMHEADER
static final int	WRITECVPROGCMD
(package private) static final int[]	WRITECVPROGHEADER

Constructor Summary

Constructors

Constructor	Description
MrcPackets()

Method Summary

Modifier and Type	Method	Description
(package private) static void	appendClockMessage(MrcMessage m, StringBuilder txt)	Adds the description of the clock's mode to a message being built
static int	getAccessoryPacketLength()
static int	getAddToConsistPacketLength()
static int	getAddToRoutePacketLength()
static int	getClearConsistPacketLength()
static int	getClearRoutePacketLength()
static int	getFunctionPacketLength()
static int	getPowerOffPacketLength()
static int	getPowerOnPacketLength()
static int	getReadCVPacketLength()
static int	getReadCVPacketReplyLength()
static int	getReadDecoderAddressLength()
static int	getRouteControlPacketLength()
static int	getSetClockAmPmPacketLength()
static int	getSetClockRatioPacketLength()
static int	getSetClockTimePacketLength()
static int	getThrottlePacketLength()
static int	getWriteCVPOMPacketLength()
static int	getWriteCVPROGPacketLength()
static boolean	startsWith(MrcMessage source, int[] match)
static String	toString(MrcMessage m)
static boolean	validCheckSum(MrcMessage m)

Methods inherited from class java.lang.Object

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

Field Details

THROTTLEPACKETCMD

public static final int THROTTLEPACKETCMD

See Also:

• Constant Field Values

THROTTLEPACKETHEADER

static final int[] THROTTLEPACKETHEADER

THROTTLEPACKETLENGTH

static final int THROTTLEPACKETLENGTH

See Also:

• Constant Field Values

FUNCTIONGROUP1PACKETCMD

public static final int FUNCTIONGROUP1PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP1PACKETHEADER

static final int[] FUNCTIONGROUP1PACKETHEADER

FUNCTIONGROUP2PACKETCMD

public static final int FUNCTIONGROUP2PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP2PACKETHEADER

static final int[] FUNCTIONGROUP2PACKETHEADER

FUNCTIONGROUP3PACKETCMD

public static final int FUNCTIONGROUP3PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP3PACKETHEADER

static final int[] FUNCTIONGROUP3PACKETHEADER

FUNCTIONGROUP4PACKETCMD

public static final int FUNCTIONGROUP4PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP4PACKETHEADER

static final int[] FUNCTIONGROUP4PACKETHEADER

FUNCTIONGROUP5PACKETCMD

public static final int FUNCTIONGROUP5PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP5PACKETHEADER

static final int[] FUNCTIONGROUP5PACKETHEADER

FUNCTIONGROUP6PACKETCMD

public static final int FUNCTIONGROUP6PACKETCMD

See Also:

• Constant Field Values

FUNCTIONGROUP6PACKETHEADER

static final int[] FUNCTIONGROUP6PACKETHEADER

FUNCTIONGROUPLENGTH

static final int FUNCTIONGROUPLENGTH

See Also:

• Constant Field Values

ADDTOCONSISTPACKETCMD

public static final int ADDTOCONSISTPACKETCMD

See Also:

• Constant Field Values

ADDTOCONSISTPACKETHEADER

static final int[] ADDTOCONSISTPACKETHEADER

ADDTOCONSISTPACKETLENGTH

static final int ADDTOCONSISTPACKETLENGTH

See Also:

• Constant Field Values

CLEARCONSISTPACKETCMD

public static final int CLEARCONSISTPACKETCMD

See Also:

• Constant Field Values

CLEARCONSISTPACKETHEADER

static final int[] CLEARCONSISTPACKETHEADER

CLEARCONSISTPACKETLENGTH

static final int CLEARCONSISTPACKETLENGTH

See Also:

• Constant Field Values

ROUTECONTROLPACKETCMD

public static final int ROUTECONTROLPACKETCMD

See Also:

• Constant Field Values

ROUTECONTROLPACKETHEADER

static final int[] ROUTECONTROLPACKETHEADER

ROUTECONTROLPACKETLENGTH

static final int ROUTECONTROLPACKETLENGTH

See Also:

• Constant Field Values

CLEARROUTEPACKETCMD

public static final int CLEARROUTEPACKETCMD

See Also:

• Constant Field Values

CLEARROUTEPACKETHEADER

static final int[] CLEARROUTEPACKETHEADER

CLEARROUTEPACKETLENGTH

static final int CLEARROUTEPACKETLENGTH

See Also:

• Constant Field Values

ADDTOROUTEPACKETCMD

public static final int ADDTOROUTEPACKETCMD

See Also:

• Constant Field Values

ADDTOROUTEPACKETHEADER

static final int[] ADDTOROUTEPACKETHEADER

ADDTOROUTEPACKETLENGTH

static final int ADDTOROUTEPACKETLENGTH

See Also:

• Constant Field Values

ACCESSORYPACKETCMD

public static final int ACCESSORYPACKETCMD

See Also:

• Constant Field Values

ACCESSORYPACKETHEADER

static final int[] ACCESSORYPACKETHEADER

ACCESSORYPACKETLENGTH

static final int ACCESSORYPACKETLENGTH

See Also:

• Constant Field Values

WRITECVPOMCMD

public static final int WRITECVPOMCMD

See Also:

• Constant Field Values

WRITECVPOMHEADER

static final int[] WRITECVPOMHEADER

WRITECVPROGCMD

public static final int WRITECVPROGCMD

See Also:

• Constant Field Values

WRITECVPROGHEADER

static final int[] WRITECVPROGHEADER

READDECODERADDRESSCMD

public static final int READDECODERADDRESSCMD

See Also:

• Constant Field Values

READDECODERADDRESS

static final int[] READDECODERADDRESS

READCVCMD

public static final int READCVCMD

See Also:

• Constant Field Values

READCVHEADER

static final int[] READCVHEADER

PROGCMDSENTCODE

public static final int PROGCMDSENTCODE

See Also:

• Constant Field Values

PROGCMDSENT

static final int[] PROGCMDSENT

READCVHEADERREPLYCODE

public static final int READCVHEADERREPLYCODE

See Also:

• Constant Field Values

READCVHEADERREPLY

static final int[] READCVHEADERREPLY

READCVPACKETLENGTH

static final int READCVPACKETLENGTH

See Also:

• Constant Field Values

SETCLOCKRATIOCMD

public static final int SETCLOCKRATIOCMD

See Also:

• Constant Field Values

SETCLOCKRATIOHEADER

static final int[] SETCLOCKRATIOHEADER

SETCLOCKTIMECMD

public static final int SETCLOCKTIMECMD

See Also:

• Constant Field Values

SETCLOCKTIMEHEADER

static final int[] SETCLOCKTIMEHEADER

SETCLOCKAMPMCMD

public static final int SETCLOCKAMPMCMD

See Also:

• Constant Field Values

SETCLOCKAMPMHEADER

static final int[] SETCLOCKAMPMHEADER

LOCOSOLECONTROLCODE

public static final int LOCOSOLECONTROLCODE

See Also:

• Constant Field Values

LOCOSOLECONTROL

static final int[] LOCOSOLECONTROL

LOCODBLCONTROLCODE

public static final int LOCODBLCONTROLCODE

See Also:

• Constant Field Values

LOCODBLCONTROL

static final int[] LOCODBLCONTROL

GOODCMDRECEIVEDCODE

public static final int GOODCMDRECEIVEDCODE

See Also:

• Constant Field Values

GOODCMDRECEIVED

static final int[] GOODCMDRECEIVED

BADCMDRECEIVEDCODE

public static final int BADCMDRECEIVEDCODE

See Also:

• Constant Field Values

BADCMDRECEIVED

static final int[] BADCMDRECEIVED

POWERONCMD

public static final int POWERONCMD

See Also:

• Constant Field Values

POWERON

static final int[] POWERON

POWEROFFCMD

public static final int POWEROFFCMD

See Also:

• Constant Field Values

POWEROFF

static final int[] POWEROFF

Constructor Details

MrcPackets

public MrcPackets()

Method Details

getAddToConsistPacketLength

public static int getAddToConsistPacketLength()

getClearConsistPacketLength

public static int getClearConsistPacketLength()

getRouteControlPacketLength

public static int getRouteControlPacketLength()

getClearRoutePacketLength

public static int getClearRoutePacketLength()

getAddToRoutePacketLength

public static int getAddToRoutePacketLength()

getAccessoryPacketLength

public static int getAccessoryPacketLength()

getWriteCVPROGPacketLength

public static int getWriteCVPROGPacketLength()

getWriteCVPOMPacketLength

public static int getWriteCVPOMPacketLength()

getSetClockRatioPacketLength

public static int getSetClockRatioPacketLength()

getSetClockAmPmPacketLength

public static int getSetClockAmPmPacketLength()

getFunctionPacketLength

public static int getFunctionPacketLength()

getReadDecoderAddressLength

public static int getReadDecoderAddressLength()

getSetClockTimePacketLength

public static int getSetClockTimePacketLength()

getThrottlePacketLength

public static int getThrottlePacketLength()

getReadCVPacketLength

public static int getReadCVPacketLength()

getReadCVPacketReplyLength

public static int getReadCVPacketReplyLength()

getPowerOnPacketLength

public static int getPowerOnPacketLength()

getPowerOffPacketLength

public static int getPowerOffPacketLength()

startsWith

public static boolean startsWith(MrcMessage source,
 int[] match)

toString

public static String toString(MrcMessage m)

appendClockMessage

static void appendClockMessage(MrcMessage m,
 StringBuilder txt)

Adds the description of the clock's mode to a message being built

Parameters:

m - clock info message

txt - build description of clock info onto this

validCheckSum

public static boolean validCheckSum(MrcMessage m)