jmri.jmrix.can.adapters.gridconnect
Class GridConnectMessage

java.lang.Object
  jmri.jmrix.AbstractMessage
      jmri.jmrix.AbstractMRMessage
          jmri.jmrix.can.adapters.gridconnect.GridConnectMessage

All Implemented Interfaces:

Message

Direct Known Subclasses:

MergMessage

public class GridConnectMessage
extends AbstractMRMessage

Class for GridConnect messages for a CAN hardware adapter.

The GridConnect protocol encodes messages as an ASCII string of up to 24 characters of the form: :ShhhhNd0d1d2d3d4d5d6d7; The S indicates a standard CAN frame :XhhhhhhhhNd0d1d2d3d4d5d6d7; The X indicates an extended CAN frame hhhh is the two byte header N or R indicates a normal or remote frame, in position 6 or 10 d0 - d7 are the (up to) 8 data bytes

Author:

Andrew Crosland Copyright (C) 2008

Field Summary

Fields inherited from class jmri.jmrix.AbstractMRMessage

LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.jmrix.AbstractMessage

_dataChars, _nDataChars

Constructor Summary

GridConnectMessage()

GridConnectMessage(CanMessage m)

Method Summary

int	getElement(int n)
int	getNumDataElements()
boolean	isExtended()
void	setByte(int val, int n) Set a byte as two ASCII hex digits Data bytes are encoded as two ASCII hex digits starting at byte 7 of the message.
void	setData(int[] d)
void	setElement(int n, int v)
void	setExtended(boolean extended)
void	setHeader(int header) Set the header
protected void	setHexDigit(int val, int n)
void	setNumDataElements(int n)
void	setRtr(boolean rtr)

Methods inherited from class jmri.jmrix.AbstractMRMessage

addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setOpCode, setRetries, setTimeout, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GridConnectMessage

public GridConnectMessage()

GridConnectMessage

public GridConnectMessage(CanMessage m)

Method Detail

getNumDataElements

public int getNumDataElements()

Specified by:

getNumDataElements in interface Message

Overrides:

getNumDataElements in class AbstractMessage

setNumDataElements

public void setNumDataElements(int n)

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

setData

public void setData(int[] d)

setExtended

public void setExtended(boolean extended)

isExtended

public boolean isExtended()

setHeader

public void setHeader(int header)

Set the header

Parameters:

header - A valid CAN header value

setRtr

public void setRtr(boolean rtr)

setByte

public void setByte(int val,
                    int n)

Set a byte as two ASCII hex digits

Data bytes are encoded as two ASCII hex digits starting at byte 7 of the message.

Parameters:

val - the value to set

n - the index of the byte to be set

setHexDigit

protected void setHexDigit(int val,
                           int n)