com.openxc.messages

Class DiagnosticMessage

java.lang.Object

com.openxc.messages.VehicleMessage

com.openxc.messages.KeyedMessage

com.openxc.messages.DiagnosticMessage

All Implemented Interfaces:

android.os.Parcelable, java.lang.Comparable<VehicleMessage>

Direct Known Subclasses:

DiagnosticRequest, DiagnosticResponse

public abstract class DiagnosticMessage
extends KeyedMessage

An abstract base class to hold common fields and logic for diagnostic requests and responses. Diagnostic messages are keyed on the bus, message ID, mode and PID (if set).

Nested Class Summary

Nested classes/interfaces inherited from class com.openxc.messages.VehicleMessage

VehicleMessage.Listener

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BUS_KEY
protected static Range<java.lang.Integer>	BUS_RANGE
protected static java.lang.String	ID_KEY
protected static java.lang.String	MODE_KEY
protected static Range<java.lang.Integer>	MODE_RANGE
protected static java.lang.String	PAYLOAD_KEY
protected static java.lang.String	PID_KEY

Fields inherited from class com.openxc.messages.VehicleMessage

CREATOR, EXTRAS_KEY

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiagnosticMessage()
	DiagnosticMessage(int busId, int id, int mode)
	DiagnosticMessage(int busId, int id, int mode, int pid)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getBusId()
int	getId()
MessageKey	getKey() Return the identifying key for this message.
int	getMode()
byte[]	getPayload()
java.lang.Integer	getPid()
boolean	hasPayload()
boolean	hasPid()
protected void	readFromParcel(android.os.Parcel in)
void	setPayload(byte[] payload)
void	setPid(int pid)
void	writeToParcel(android.os.Parcel out, int flags)

Methods inherited from class com.openxc.messages.KeyedMessage

setKey

Methods inherited from class com.openxc.messages.VehicleMessage

asCanMessage, asCommandResponse, asDiagnosticRequest, asDiagnosticResponse, asEventedMessage, asKeyedMessage, asNamedMessage, asSimpleMessage, compareTo, describeContents, getDate, getExtras, getTimestamp, hasExtras, isTimestamped, setExtras, setTimestamp, timestamp, toString, untimestamp

Methods inherited from class java.lang.Object

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

Field Detail

ID_KEY

protected static final java.lang.String ID_KEY

See Also:

Constant Field Values

BUS_KEY

protected static final java.lang.String BUS_KEY

See Also:

Constant Field Values

MODE_KEY

protected static final java.lang.String MODE_KEY

See Also:

Constant Field Values

PID_KEY

protected static final java.lang.String PID_KEY

See Also:

Constant Field Values

PAYLOAD_KEY

protected static final java.lang.String PAYLOAD_KEY

See Also:

Constant Field Values

BUS_RANGE

protected static final Range<java.lang.Integer> BUS_RANGE

MODE_RANGE

protected static final Range<java.lang.Integer> MODE_RANGE

Constructor Detail

DiagnosticMessage

public DiagnosticMessage(int busId,
                         int id,
                         int mode)

DiagnosticMessage

public DiagnosticMessage(int busId,
                         int id,
                         int mode,
                         int pid)

DiagnosticMessage

protected DiagnosticMessage()

Method Detail

hasPid

public boolean hasPid()

getBusId

public int getBusId()

getId

public int getId()

getMode

public int getMode()

getPid

public java.lang.Integer getPid()

getPayload

public byte[] getPayload()

setPid

public void setPid(int pid)

hasPayload

public boolean hasPayload()

setPayload

public void setPayload(byte[] payload)

getKey

public MessageKey getKey()

Description copied from class: KeyedMessage

Return the identifying key for this message.

Overrides:

getKey in class KeyedMessage

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class VehicleMessage

writeToParcel

public void writeToParcel(android.os.Parcel out,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class VehicleMessage

readFromParcel

protected void readFromParcel(android.os.Parcel in)

Overrides:

readFromParcel in class VehicleMessage