com.openxc.messages

Class CanMessage

java.lang.Object

com.openxc.messages.VehicleMessage

com.openxc.messages.KeyedMessage

com.openxc.messages.CanMessage

All Implemented Interfaces:

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

public class CanMessage
extends KeyedMessage

A VehicleMessage that is a low-level CAN message. A CAN message is keyed on the bus and message ID.

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 java.lang.String	DATA_KEY
protected static java.lang.String	ID_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
	CanMessage(int canBus, int id, byte[] data)
protected	CanMessage(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
int	compareTo(VehicleMessage other) Sort by bus, then by message ID.
static boolean	containsRequiredFields(java.util.Set<java.lang.String> fields)
boolean	equals(java.lang.Object obj)
int	getBusId()
byte[]	getData()
int	getId()
MessageKey	getKey() Return the identifying key for this message.
void	readFromParcel(android.os.Parcel in)
java.lang.String	toString()
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, describeContents, getDate, getExtras, getTimestamp, hasExtras, isTimestamped, setExtras, setTimestamp, timestamp, 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

DATA_KEY

protected static final java.lang.String DATA_KEY

See Also:

Constant Field Values

Constructor Detail

CanMessage

public CanMessage(int canBus,
                  int id,
                  byte[] data)

CanMessage

protected CanMessage(android.os.Parcel in)

Method Detail

getBusId

public int getBusId()

getId

public int getId()

getData

public byte[] getData()

getKey

public MessageKey getKey()

Description copied from class: KeyedMessage

Return the identifying key for this message.

Overrides:

getKey in class KeyedMessage

containsRequiredFields

public static boolean containsRequiredFields(java.util.Set<java.lang.String> fields)

compareTo

public int compareTo(VehicleMessage other)

Sort by bus, then by message ID.

Specified by:

compareTo in interface java.lang.Comparable<VehicleMessage>

Overrides:

compareTo in class VehicleMessage

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class VehicleMessage

toString

public java.lang.String toString()

Overrides:

toString 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

public void readFromParcel(android.os.Parcel in)

Overrides:

readFromParcel in class VehicleMessage