Package jmri.jmrix.oaktree

Class SerialMessage

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRMessage

jmri.jmrix.oaktree.SerialMessage

All Implemented Interfaces:

Message

public class SerialMessage
extends AbstractMRMessage

Contains the data payload of a 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) int	responseLength

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(byte[] a, int l)	Deprecated, for removal: This API element is subject to removal in a future version. 5.13.5, unused, requires further development.
SerialMessage(int l)
SerialMessage(String m, int l)	Interpret the String as the exact sequence to send, byte-for-byte.
SerialMessage(SerialMessage m, int l)

Method Summary

Modifier and Type	Method	Description
int	getAddr()
static SerialMessage	getPoll(int addr)
int	getResponseLength()
boolean	isPoll()
boolean	isXmt()
void	setElement(int element, int value)	Override parent method to ensure that message always has valid error check byte.
void	setResponseLength(int l)

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 jmri.jmrix.AbstractMessage

equals, getElement, getNumDataElements, hashCode

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

responseLength

int responseLength

Constructor Details

SerialMessage

public SerialMessage(int l)

SerialMessage

public SerialMessage(SerialMessage m,
 int l)

SerialMessage

public SerialMessage(String m,
 int l)

Interpret the String as the exact sequence to send, byte-for-byte.

Parameters:

m - message string.

l - response length.

SerialMessage

@Deprecated(since="5.13.5",
            forRemoval=true)
public SerialMessage(byte[] a,
 int l)

Deprecated, for removal: This API element is subject to removal in a future version.

5.13.5, unused, requires further development.

Interpret the byte array as a sequence of characters to send.

Parameters:

a - Array of bytes to send

l - response length.

Method Details

setResponseLength

public void setResponseLength(int l)

getResponseLength

public int getResponseLength()

setElement

public void setElement(int element,
 int value)

Override parent method to ensure that message always has valid error check byte.

Specified by:

setElement in interface Message

Overrides:

setElement in class AbstractMessage

Parameters:

element - index of element.

value - value of element.

isPoll

public boolean isPoll()

isXmt

public boolean isXmt()

getAddr

public int getAddr()

getPoll

public static SerialMessage getPoll(int addr)