SerialMessage (JMRI API)

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRMessage

jmri.jmrix.cmri.serial.SerialMessage

All Implemented Interfaces:: Message

public class SerialMessage extends AbstractMRMessage

Contains the data payload of a CMRI 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

Modifier and Type

Field

Description

(package private) static final int

POLL_TIMEOUT

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 i)

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

static SerialMessage

getPoll(int UA)

int

getUA()

boolean

isInit()

boolean

isPoll()

boolean

isXmt()

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

Field Details
- POLL_TIMEOUT
  
  static final int POLL_TIMEOUT
  See Also:
  
  Constant Field Values
Constructor Details
- SerialMessage
  
  public SerialMessage()
- SerialMessage
  
  public SerialMessage(int i)
- 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 - message string.
- 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
Method Details
- toString
  
  public String toString()
  
  Description copied from interface: Message
  
  Specified by:
  
  toString in interface Message
  
  Overrides:
  
  toString in class AbstractMRMessage
- isPoll
  
  public boolean isPoll()
- isXmt
  
  public boolean isXmt()
- isInit
  
  public boolean isInit()
- getUA
  
  public int getUA()
- getPoll
  
  public static SerialMessage getPoll(int UA)