org.openlcb.messages

Class TractionControlReplyMessage

java.lang.Object

org.openlcb.Message

org.openlcb.AddressedMessage

org.openlcb.AddressedPayloadMessage

org.openlcb.messages.TractionControlReplyMessage

All Implemented Interfaces:

OpenLcb

@Immutable
 @ThreadSafe
public class TractionControlReplyMessage
extends AddressedPayloadMessage

Traction Control Reply message implementation.

Created by bracz on 12/29/15.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	CMD_CONSIST
static byte	CMD_CONTROLLER
static byte	CMD_GET_FN
static byte	CMD_GET_SPEED
static byte	CMD_MGMT
private static Logger	logger
static byte	SUBCMD_CONSIST_ATTACH
static byte	SUBCMD_CONSIST_DETACH
static byte	SUBCMD_CONSIST_QUERY
static byte	SUBCMD_CONTROLLER_ASSIGN
static byte	SUBCMD_CONTROLLER_CHANGE
static byte	SUBCMD_CONTROLLER_QUERY
static byte	SUBCMD_MGMT_RESERVE

Fields inherited from class org.openlcb.AddressedPayloadMessage

payload

Fields inherited from interface org.openlcb.OpenLcb

MTI_CONSUMER_IDENTIFIED, MTI_DATAGRAM, MTI_DATAGRAM_RCV_OK, MTI_DATAGRAM_REJECTED, MTI_IDENTIFY_CONSUMERS, MTI_IDENTIFY_CONSUMERS_RANGE, MTI_IDENTIFY_EVENTS, MTI_IDENTIFY_PRODUCERS, MTI_IDENTIFY_PRODUCERS_RANGE, MTI_INITIALIZATION_COMPLETE, MTI_LEARN_EVENT, MTI_OPT_INT_REJECTED, MTI_PC_EVENT_REPORT, MTI_PRODUCER_IDENTIFIED, MTI_PROTOCOL_IDENT_REPLY, MTI_PROTOCOL_IDENT_REQUEST, MTI_SIMPLE_NODE_IDENT_REPLY, MTI_SIMPLE_NODE_IDENT_REQUEST, MTI_STREAM_DATA_COMPLETE, MTI_STREAM_DATA_PROCEED, MTI_STREAM_DATA_SEND, MTI_STREAM_INIT_REPLY, MTI_STREAM_INIT_REQUEST, MTI_VERIFIED_NID, MTI_VERIFY_NID

Constructor Summary

Constructors

Constructor and Description
TractionControlReplyMessage(NodeID source, NodeID dest, byte[] payload)

Method Summary

Modifier and Type	Method and Description
void	applyTo(MessageDecoder decoder, Connection sender) Implement message-type-specific processing when this message is received by a node.
Float16	getActualSpeed()
byte	getAssignControllerReply()
byte	getCmd()
Float16	getCommandedSpeed()
int	getConsistIndex()
int	getConsistLength()
int	getConsistQueryFlags() Extract the consist entry's flag byte.
NodeID	getConsistQueryNodeID() Extract the consisted train's node ID from the consist list query response.
NodeID	getCurrentControllerReply()
MessageTypeIdentifier	getEMTI()
int	getFnNumber()
int	getFnVal()
byte	getReserveReply()
Float16	getSetSpeed()
byte	getSubCmd()

Methods inherited from class org.openlcb.AddressedPayloadMessage

getMTI, getPayload, toString

Methods inherited from class org.openlcb.AddressedMessage

equals, getDestNodeID, hashCode

Methods inherited from class org.openlcb.Message

getSourceNodeID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final Logger logger

CMD_GET_SPEED

public static final byte CMD_GET_SPEED

See Also:

Constant Field Values

CMD_GET_FN

public static final byte CMD_GET_FN

See Also:

Constant Field Values

CMD_CONTROLLER

public static final byte CMD_CONTROLLER

See Also:

Constant Field Values

SUBCMD_CONTROLLER_ASSIGN

public static final byte SUBCMD_CONTROLLER_ASSIGN

See Also:

Constant Field Values

SUBCMD_CONTROLLER_QUERY

public static final byte SUBCMD_CONTROLLER_QUERY

See Also:

Constant Field Values

SUBCMD_CONTROLLER_CHANGE

public static final byte SUBCMD_CONTROLLER_CHANGE

See Also:

Constant Field Values

CMD_MGMT

public static final byte CMD_MGMT

See Also:

Constant Field Values

SUBCMD_MGMT_RESERVE

public static final byte SUBCMD_MGMT_RESERVE

See Also:

Constant Field Values

CMD_CONSIST

public static final byte CMD_CONSIST

See Also:

Constant Field Values

SUBCMD_CONSIST_ATTACH

public static final byte SUBCMD_CONSIST_ATTACH

See Also:

Constant Field Values

SUBCMD_CONSIST_DETACH

public static final byte SUBCMD_CONSIST_DETACH

See Also:

Constant Field Values

SUBCMD_CONSIST_QUERY

public static final byte SUBCMD_CONSIST_QUERY

See Also:

Constant Field Values

Constructor Detail

TractionControlReplyMessage

public TractionControlReplyMessage(NodeID source,
                                   NodeID dest,
                                   byte[] payload)

Method Detail

getCmd

public byte getCmd()
            throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getSubCmd

public byte getSubCmd()
               throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getAssignControllerReply

public byte getAssignControllerReply()
                              throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getCurrentControllerReply

public NodeID getCurrentControllerReply()
                                 throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getReserveReply

public byte getReserveReply()
                     throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getSetSpeed

public Float16 getSetSpeed()
                    throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getCommandedSpeed

public Float16 getCommandedSpeed()
                          throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getActualSpeed

public Float16 getActualSpeed()
                       throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getFnNumber

public int getFnNumber()

getFnVal

public int getFnVal()

getConsistLength

public int getConsistLength()

Returns:

the length of the consist list. Valid only for consist query reply message

getConsistIndex

public int getConsistIndex()

Returns:

the index of the returned node in the consist list, or -1 if there is no consist entry in the response. Valid only for consist query reply message

getConsistQueryNodeID

@Nullable
public NodeID getConsistQueryNodeID()

Extract the consisted train's node ID from the consist list query response.

Returns:

the consisted train's node ID from the consist query response, or null if the response did not contain a node ID.

getConsistQueryFlags

public int getConsistQueryFlags()

Extract the consist entry's flag byte. Call it only if the consist index is nonnegative.

Returns:

consist flags

applyTo

public void applyTo(MessageDecoder decoder,
                    Connection sender)

Description copied from class: Message

Implement message-type-specific processing when this message is received by a node.

Default is to do nothing.

Overrides:

applyTo in class Message

Parameters:

decoder - the node (or processing component) to apply to this message

sender - the source of the message

getEMTI

public MessageTypeIdentifier getEMTI()

Specified by:

getEMTI in class AddressedPayloadMessage