SerialMessage (JMRI API)

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRMessage

jmri.jmrix.tmcc.SerialMessage

All Implemented Interfaces:: Message

public class SerialMessage extends AbstractMRMessage

Contains the data payload of a TMCC serial packet.

Note that only the payload, not the header or trailer, nor the padding DLE characters are included. These are added during transmission.

Field Summary

Fields inherited from class jmri.jmrix.AbstractMRMessage
LONG_TIMEOUT, SHORT_TIMEOUT

Fields inherited from class jmri.jmrix.AbstractMessage
_dataChars, _nDataChars
Constructor Summary

Constructors

Constructor

Description

SerialMessage()

SerialMessage(byte[] a)

Deprecated, for removal: This API element is subject to removal in a future version.
5.13.5, unused, requires further development.

SerialMessage(int value)

This ctor takes an int value for the 16 bit data content, with an optional leading byte.

SerialMessage(String m)

This ctor interprets the String as the exact sequence to send, byte-for-byte.

SerialMessage(SerialMessage m)
Method Summary

Modifier and Type

Method

Description

int

getAsWord()

void

putAsWord(int val)

String

toString()

Methods inherited from class jmri.jmrix.AbstractMRMessage
addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getTimeout, isBinary, replyExpected, setBinary, setNeededMode, setOpCode, setRetries, setTimeout

Methods inherited from class jmri.jmrix.AbstractMessage
equals, getElement, getNumDataElements, hashCode, setElement

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.jmrix.Message
toMonitorString

Constructor Details
- SerialMessage
  
  public SerialMessage()
- SerialMessage
  
  public SerialMessage(SerialMessage m)
- SerialMessage
  
  public SerialMessage(String m)
  
  This ctor interprets the String as the exact sequence to send, byte-for-byte.
  
  Parameters:
  
  m - string form of bytes to send
- SerialMessage
  
  @Deprecated(since="5.13.5", forRemoval=true) public SerialMessage(byte[] a)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  5.13.5, unused, requires further development.
  
  This ctor interprets the byte array as a sequence of characters to send.
  
  Parameters:
  
  a - Array of bytes to send
- SerialMessage
  
  public SerialMessage(int value)
  
  This ctor takes an int value for the 16 bit data content, with an optional leading byte. If the value is greater than 0xFFFF, i.e. the upper byte of three is non-zero, the upper byte is used as the op code, otherwise 0xFE (TMCC 1) will be used.
  
  Parameters:
  
  value - The value stored in the content of the packet
Method Details
- toString
  
  public String toString()
  
  Description copied from interface: Message
  
  Specified by:
  
  toString in interface Message
  
  Overrides:
  
  toString in class AbstractMRMessage
- putAsWord
  
  public void putAsWord(int val)
- getAsWord
  
  public int getAsWord()