Package jmri.jmrix.can

Class CanReply

java.lang.Object

jmri.jmrix.AbstractMessage

jmri.jmrix.AbstractMRReply

jmri.jmrix.can.CanReply

All Implemented Interfaces:

CanFrame, CanMutableFrame, Message

public class CanReply
extends AbstractMRReply
implements CanMutableFrame

Base class for replies in a CANbus based message/reply protocol.

It is expected that any CAN based system will be based upon basic CANbus concepts such as ID (standard or extended), Normal and RTR frames and a data field.

"header" refers to the full 11 or 29 bit header; which mode is separately set via the "extended" parameter

CBUS uses a 2-bit "Pri" field and 7-bit "ID" ("CAN ID") field, with separate accessors.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	_header
(package private) boolean	_isExtended
(package private) boolean	_isRtr

Fields inherited from class jmri.jmrix.AbstractMRReply

DEFAULTMAXSIZE

Fields inherited from class jmri.jmrix.AbstractMessage

_dataChars, _nDataChars

Constructor Summary

Constructors

Constructor	Description
CanReply()	Create a new CanReply
CanReply(int i)	Create a new CanReply of given data length
CanReply(int[] d)	Create a new CanReply from an int array
CanReply(int[] d, int header)	Create a new CanReply from an int array, with header
CanReply(CanMessage m)	Create a new CanReply from an existing CanMessage
CanReply(CanReply m)	Create a new CanReply from an existing CanReply

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object a)	Note that a CanMessage and a CanReply can be tested for equality
int[]	getData()	Get the data byte array.
int	getElement(int n)	Get a particular element in a Message.
int	getHeader()	Get the CAN Frame header.
int	getNumDataElements()	Get the number of data elements in a Message.
int	hashCode()	Hash on the header
boolean	isExtended()	Get if the CAN Frame has an extended header.
boolean	isRtr()	Get if the CAN Frame is an RTR Frame.
void	setElement(int n, int v)	Set a single Data Element at a particular index.
void	setExtended(boolean b)	Set if the CAN Frame header is extended.
final void	setHeader(int h)	Set the CAN Frame header.
final void	setNumDataElements(int n)	Set the number of data elements in the main CAN Frame body.
void	setRtr(boolean b)	Set if the CAN Frame is an RTR Frame.
protected int	skipPrefix(int index)
String	toMonitorString()	this format matches @CanMessage
String	toString()	this format matches @CanMessage

Methods inherited from class jmri.jmrix.AbstractMRReply

flush, getOpCode, isBinary, isRetransmittableErrorMsg, isUnsolicited, match, maxSize, pollValue, setBinary, setOpCode, setUnsolicited, skipWhiteSpace, value

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.can.CanFrame

appendHexElements, dataFramesEqual, extendedOrRtr, getToString, isEqual, monString

Methods inherited from interface jmri.jmrix.can.CanMutableFrame

setData, setData

Field Details

_header

int _header

_isExtended

boolean _isExtended

_isRtr

boolean _isRtr

Constructor Details

CanReply

public CanReply()

Create a new CanReply

CanReply

public CanReply(int i)

Create a new CanReply of given data length

Parameters:

i - number of data bytes, 0-8

CanReply

public CanReply(int[] d)

Create a new CanReply from an int array

Parameters:

d - array of CAN Frame data bytes, max 8

CanReply

public CanReply(int[] d,
 int header)

Create a new CanReply from an int array, with header

Parameters:

d - array of CAN Frame data bytes, max 8

header - the Frame header value

CanReply

public CanReply(@Nonnull
 CanReply m)

Create a new CanReply from an existing CanReply

Parameters:

m - The existing CanReply

CanReply

public CanReply(@Nonnull
 CanMessage m)

Create a new CanReply from an existing CanMessage

Parameters:

m - The existing CanMessage

Method Details

hashCode

public int hashCode()

Hash on the header

Overrides:

hashCode in class AbstractMessage

Returns:

hashcode from sum of elements.

equals

public boolean equals(Object a)

Note that a CanMessage and a CanReply can be tested for equality

Overrides:

equals in class AbstractMessage

skipPrefix

protected int skipPrefix(int index)

Specified by:

skipPrefix in class AbstractMRReply

getNumDataElements

public int getNumDataElements()

Get the number of data elements in a Message.

Specified by:

getNumDataElements in interface CanFrame

Specified by:

getNumDataElements in interface Message

Overrides:

getNumDataElements in class AbstractMessage

Returns:

number elements.

setNumDataElements

public final void setNumDataElements(int n)

Set the number of data elements in the main CAN Frame body.

Specified by:

setNumDataElements in interface CanMutableFrame

Parameters:

n - true number of data bytes, 0-8

getElement

public int getElement(int n)

Get a particular element in a Message.

Specified by:

getElement in interface CanFrame

Specified by:

getElement in interface Message

Overrides:

getElement in class AbstractMessage

Parameters:

n - Element Index.

Returns:

single element of message.

setElement

public void setElement(int n,
 int v)

Set a single Data Element at a particular index.

Specified by:

setElement in interface CanMutableFrame

Specified by:

setElement in interface Message

Overrides:

setElement in class AbstractMRReply

Parameters:

n - index of element.

v - value of element.

getData

public int[] getData()

Get the data byte array.

Returns:

the actual byte array, not a Copy Of

getHeader

public int getHeader()

Get the CAN Frame header.

Specified by:

getHeader in interface CanFrame

Returns:

header value

setHeader

public final void setHeader(int h)

Set the CAN Frame header.

Specified by:

setHeader in interface CanMutableFrame

Parameters:

h - new header value

isExtended

public boolean isExtended()

Get if the CAN Frame has an extended header.

Specified by:

isExtended in interface CanFrame

Returns:

true if extended, else false

setExtended

public void setExtended(boolean b)

Set if the CAN Frame header is extended.

Specified by:

setExtended in interface CanMutableFrame

Parameters:

b - true if extended, else false

isRtr

public boolean isRtr()

Get if the CAN Frame is an RTR Frame.

Specified by:

isRtr in interface CanFrame

Returns:

true if RTR, else false

setRtr

public void setRtr(boolean b)

Set if the CAN Frame is an RTR Frame.

Specified by:

setRtr in interface CanMutableFrame

Parameters:

b - true if RTR, else false

toString

public String toString()

this format matches @CanMessage

Specified by:

toString in interface Message

Overrides:

toString in class AbstractMRReply

toMonitorString

public String toMonitorString()

this format matches @CanMessage

Specified by:

toMonitorString in interface Message

Returns:

a human-readable representation of the message.