Package jmri.jmrix.dcc4pc

Class Dcc4PcMessage

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRMessage

jmri.jmrix.dcc4pc.Dcc4PcMessage

All Implemented Interfaces:

Message

public class Dcc4PcMessage
extends AbstractMRMessage

Encodes a message to the DCC4PC Interface.

The Dcc4PcReply class handles the response from the command station.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	board
(package private) static final int	BUSRESETSPEEDS
(package private) static final int	BUSSETSPEED
(package private) boolean	childBoard
(package private) static final int	CHILDENABLEDINPUTS
(package private) static final int	CHILDPOLL
(package private) static final int	CHILDRESET
(package private) static final int	CHILDSELECTENCODING
(package private) static final int	CHILDSETSPEED
(package private) static final int	DESC
(package private) static final int	INFO
(package private) boolean	isResponse
static final int	MAXSIZE
(package private) int	messageType
(package private) boolean	noDataReply
(package private) static final int	RESPONSE
(package private) static final int	SERIAL
static final int	SPEED_62K5	SPEED code for 62.5 kbps (Omnibus spec section 6).

Fields inherited from class jmri.jmrix.AbstractMRMessage

LONG_TIMEOUT, SHORT_TIMEOUT, sourceLetter

Fields inherited from class jmri.jmrix.AbstractMessage

_dataChars, _nDataChars

Constructor Summary

Constructors

Constructor	Description
Dcc4PcMessage(byte[] packet)	Creates a new Dcc4PcMessage containing a byte array to represent a packet to output
Dcc4PcMessage(int i)
Dcc4PcMessage(String s)
Dcc4PcMessage(Dcc4PcMessage m)

Method Summary

Modifier and Type	Method	Description
static Dcc4PcMessage	busResetSpeeds()	BUS Reset Speeds (0x0D, BUS 1.1): every board and the interface go back to 8 kbps.
static Dcc4PcMessage	busSetSpeed(int address, int speed)	BUS Set Speed (0x07): the speed the interface uses to talk to one board.
int	getBoard()
static Dcc4PcMessage	getDescription()
static Dcc4PcMessage	getDescription(int address)
static Dcc4PcMessage	getEnabledInputs(int address)
static Dcc4PcMessage	getExitProgMode()
byte[]	getFormattedMessage()	Get formatted message for direct output to stream - this is the final format of the message as a byte array
static Dcc4PcMessage	getInfo()
static Dcc4PcMessage	getInfo(int address)
int	getMessageType()
static Dcc4PcMessage	getProgMode()
static Dcc4PcMessage	getResponse()
static Dcc4PcMessage	getSerialNumber()
static Dcc4PcMessage	getSerialNumber(int address)
boolean	isForChildBoard()
boolean	isGetResponse()
boolean	isNoDataReply()
static Dcc4PcMessage	pollBoard(int address)
boolean	replyExpected()	Is a reply expected to this message?
static Dcc4PcMessage	resetBoardData(int address)
static Dcc4PcMessage	selectRawEncoding(int address)	Select the Raw RailCom encoding (encoding 0), the only one decoded.
static Dcc4PcMessage	setBoardSpeed(int address, int speed)	Mandatory Set Speed (0x04) for a board: it switches to the new bus speed once this transaction is complete.
void	setElement(int n, int v)	Set a single Data Element at a particular index.
void	setForChildBoard(boolean boo)
String	toString()

Methods inherited from class jmri.jmrix.AbstractMRMessage

addIntAsFourHex, addIntAsThree, addIntAsThreeHex, addIntAsTwoHex, getNeededMode, getOpCode, getOpCodeHex, getRetries, getSourceLetter, getTimeout, isBinary, setBinary, setNeededMode, setOpCode, setRetries, setTimeout

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

MAXSIZE

public static final int MAXSIZE

See Also:

• Constant Field Values

childBoard

boolean childBoard

isResponse

boolean isResponse

board

int board

messageType

int messageType

INFO

static final int INFO

See Also:

• Constant Field Values

DESC

static final int DESC

See Also:

• Constant Field Values

SERIAL

static final int SERIAL

See Also:

• Constant Field Values

CHILDSELECTENCODING

static final int CHILDSELECTENCODING

See Also:

• Constant Field Values

CHILDENABLEDINPUTS

static final int CHILDENABLEDINPUTS

See Also:

• Constant Field Values

CHILDRESET

static final int CHILDRESET

See Also:

• Constant Field Values

CHILDPOLL

static final int CHILDPOLL

See Also:

• Constant Field Values

RESPONSE

static final int RESPONSE

See Also:

• Constant Field Values

CHILDSETSPEED

static final int CHILDSETSPEED

See Also:

• Constant Field Values

BUSSETSPEED

static final int BUSSETSPEED

See Also:

• Constant Field Values

BUSRESETSPEEDS

static final int BUSRESETSPEEDS

See Also:

• Constant Field Values

SPEED_62K5

public static final int SPEED_62K5

SPEED code for 62.5 kbps (Omnibus spec section 6).

See Also:

• Constant Field Values

noDataReply

boolean noDataReply

Constructor Details

Dcc4PcMessage

public Dcc4PcMessage(int i)

Dcc4PcMessage

public Dcc4PcMessage(byte[] packet)

Creates a new Dcc4PcMessage containing a byte array to represent a packet to output

Parameters:

packet - The contents of the packet

Dcc4PcMessage

public Dcc4PcMessage(String s)

Dcc4PcMessage

public Dcc4PcMessage(Dcc4PcMessage m)

Method Details

setForChildBoard

public void setForChildBoard(boolean boo)

isForChildBoard

public boolean isForChildBoard()

setElement

public void setElement(int n,
 int v)

Set a single Data Element at a particular index.

Specified by:

setElement in interface Message

Overrides:

setElement in class AbstractMessage

Parameters:

n - index of element.

v - value of element.

toString

public String toString()

Specified by:

toString in interface Message

Overrides:

toString in class AbstractMRMessage

getFormattedMessage

public byte[] getFormattedMessage()

Get formatted message for direct output to stream - this is the final format of the message as a byte array

Returns:

the formatted message as a byte array

getProgMode

public static Dcc4PcMessage getProgMode()

getExitProgMode

public static Dcc4PcMessage getExitProgMode()

isGetResponse

public boolean isGetResponse()

getBoard

public int getBoard()

getMessageType

public int getMessageType()

getInfo

public static Dcc4PcMessage getInfo(int address)

getDescription

public static Dcc4PcMessage getDescription(int address)

getSerialNumber

public static Dcc4PcMessage getSerialNumber(int address)

setBoardSpeed

public static Dcc4PcMessage setBoardSpeed(int address,
 int speed)

Mandatory Set Speed (0x04) for a board: it switches to the new bus speed once this transaction is complete. The interface must then be told with busSetSpeed(int, int).

Parameters:

address - board address

speed - SPEED code, 0 for 8 kbps

Returns:

the message

busSetSpeed

public static Dcc4PcMessage busSetSpeed(int address,
 int speed)

BUS Set Speed (0x07): the speed the interface uses to talk to one board.

Parameters:

address - board address

speed - SPEED code, 0 for 8 kbps

Returns:

the message

isNoDataReply

public boolean isNoDataReply()

Returns:

true if the interface answers this message with no data, only its DSR handshake

replyExpected

public boolean replyExpected()

Description copied from class: AbstractMRMessage

Is a reply expected to this message?

By default, a reply is expected to every message; either a reply or a timeout is needed before the next message can be sent.

If this returns false, the transmit queue will immediately go on to transmit the next message (if any).

Overrides:

replyExpected in class AbstractMRMessage

Returns:

true by default in Abstract MR message.

busResetSpeeds

public static Dcc4PcMessage busResetSpeeds()

BUS Reset Speeds (0x0D, BUS 1.1): every board and the interface go back to 8 kbps.

Returns:

the message

selectRawEncoding

public static Dcc4PcMessage selectRawEncoding(int address)

Select the Raw RailCom encoding (encoding 0), the only one decoded.

Parameters:

address - board address

Returns:

the message

resetBoardData

public static Dcc4PcMessage resetBoardData(int address)

pollBoard

public static Dcc4PcMessage pollBoard(int address)

getEnabledInputs

public static Dcc4PcMessage getEnabledInputs(int address)

getInfo

public static Dcc4PcMessage getInfo()

getResponse

public static Dcc4PcMessage getResponse()

getDescription

public static Dcc4PcMessage getDescription()

getSerialNumber

public static Dcc4PcMessage getSerialNumber()