jmri.jmrix.can.adapters.lawicell
Class Message

java.lang.Object
  extended by jmri.jmrix.AbstractMessage
      extended by jmri.jmrix.AbstractMRMessage
          extended by jmri.jmrix.can.adapters.lawicell.Message
All Implemented Interfaces:
Message

public class Message
extends AbstractMRMessage

Class for messages for a LAWICELL CAN hardware adapter.

The Lawicell adapter protocol encodes messages as an ASCII string of up to 24 characters of the form: tiiildd...[CR] Tiiiiiiiildd...[CR] The t or T indicates a standard or extended CAN frame iiiiiiii is the header as hex digits l is the number of bytes of data dd are the (up to) 8 data bytes

Author:
Andrew Crosland Copyright (C) 2008, Bob Jacobsen Copyright (C) 2008, 2009

Field Summary
 
Fields inherited from class jmri.jmrix.AbstractMRMessage
LONG_TIMEOUT, SHORT_TIMEOUT
 
Fields inherited from class jmri.jmrix.AbstractMessage
_dataChars, _nDataChars
 
Constructor Summary
Message()
           
Message(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)
           
 int setHeader(int header, int index)
          Set the CAN header as ASCII hex digits.
 void setNumDataElements(int n)
           
 
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

Message

public Message()

Message

public Message(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 int setHeader(int header,
                     int index)
Set the CAN header as ASCII hex digits. Handles extended/standard internally

Parameters:
header - A valid CAN header value
Returns:
index to next bytes, after this

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


Copyright © 1997 - 2011 JMRI Community.
JMRI, DecoderPro, PanelPro, SoundPro, DispatcherPro and associated logos are our trademarks.

Additional information on copyright, trademarks and licenses is linked here.
Site hosted by: Get JMRI Model Railroad Interface at SourceForge.net. Fast, secure and Free Open Source software downloads