SpecificMessage (JMRI API)

java.lang.Object
- jmri.jmrix.AbstractMessage
- - jmri.jmrix.AbstractMRMessage
  - - jmri.jmrix.powerline.SerialMessage
    - - jmri.jmrix.powerline.dmx512.SpecificMessage

All Implemented Interfaces:

Message
```
public class SpecificMessage
extends SerialMessage
```
Contains the data payload of a serial packet.
The transmission protocol can come in one of several forms:
- If the interlocked parameter is false (default), the packet is just sent. If the response length is not zero, a reply of that length is expected.
- If the interlocked parameter is true, the transmission will require a CRC interlock, which will be automatically added. (Design note: this is done to make sure that the messages remain atomic)

Field Summary

Fields
Modifier and Type Field Description

(package private) boolean interlocked

(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
`SpecificMessage(byte[] a, int l)`	This ctor interprets the byte array as a sequence of characters to send.
`SpecificMessage(int l)`
`SpecificMessage(java.lang.String m, int l)`	This ctor interprets the String as the exact sequence to send, byte-for-byte.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getInterlocked()`
`int`	`getResponseLength()`
`void`	`setInterlocked(boolean v)`
`void`	`setResponseLength(int l)`
`java.lang.String`	`toMonitorString()`

Methods inherited from class jmri.jmrix.powerline.SerialMessage
getAddr, getPoll, isPoll, isXmt

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, setElement

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

- Field Detail
  - interlocked
```
boolean interlocked
```
  - responseLength
```
int responseLength
```
- Constructor Detail
  - SpecificMessage
```
public SpecificMessage(int l)
```
  - SpecificMessage
```
public SpecificMessage(java.lang.String m,
                       int l)
```
    This ctor interprets the String as the exact sequence to send, byte-for-byte.
    
    Parameters:
    
    m - message
    
    l - response length in bytes
  - SpecificMessage
```
public SpecificMessage(byte[] a,
                       int l)
```
    This ctor interprets the byte array as a sequence of characters to send.
    
    Parameters:
    
    a - Array of bytes to send
    
    l - lenght of expected reply
- Method Detail
  - setInterlocked
```
public void setInterlocked(boolean v)
```
    Overrides:
    
    setInterlocked in class SerialMessage
  - getInterlocked
```
public boolean getInterlocked()
```
    Overrides:
    
    getInterlocked in class SerialMessage
  - toMonitorString
```
public java.lang.String toMonitorString()
```
    Returns:
    
    a human-readable representation of the message.
  - setResponseLength
```
public void setResponseLength(int l)
```
    Overrides:
    
    setResponseLength in class SerialMessage
  - getResponseLength
```
public int getResponseLength()
```
    Overrides:
    
    getResponseLength in class SerialMessage