com.openxc.messages

Class VehicleMessage

java.lang.Object

com.openxc.messages.VehicleMessage

All Implemented Interfaces:

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

Direct Known Subclasses:

KeyedMessage

public class VehicleMessage
extends java.lang.Object
implements android.os.Parcelable, java.lang.Comparable<VehicleMessage>

The VehicleMessage is the most basic, root form of data going back and forth between the OpenXC library and a vehicle interface. The VI's data stream is message based, where each message is a subtype of a VehicleMessage. This base class implements Parcelable, so it can be sent over an AIDL interface, i.e. between the singleton VehicleService and the VehicleManager instance in each app's process.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	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
static android.os.Parcelable.Creator<VehicleMessage>	CREATOR
static java.lang.String	EXTRAS_KEY

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	VehicleMessage()
	VehicleMessage(java.lang.Long timestamp) Construct a new empty VehicleMessage.
	VehicleMessage(java.lang.Long timestamp, java.util.Map<java.lang.String,java.lang.Object> extras) Construct a new VehicleMessage with the given extra data and an overridden timestamp.
	VehicleMessage(java.util.Map<java.lang.String,java.lang.Object> extras) Construct a new VehicleMessage with the given extra data.
protected	VehicleMessage(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
CanMessage	asCanMessage()
CommandResponse	asCommandResponse()
DiagnosticRequest	asDiagnosticRequest()
DiagnosticResponse	asDiagnosticResponse()
EventedSimpleVehicleMessage	asEventedMessage()
KeyedMessage	asKeyedMessage()
NamedVehicleMessage	asNamedMessage()
SimpleVehicleMessage	asSimpleMessage()
int	compareTo(VehicleMessage other)
int	describeContents()
boolean	equals(java.lang.Object obj)
java.util.Date	getDate()
java.util.Map<java.lang.String,java.lang.Object>	getExtras()
java.lang.Long	getTimestamp()
boolean	hasExtras()
boolean	isTimestamped()
protected void	readFromParcel(android.os.Parcel in)
void	setExtras(java.util.Map<java.lang.String,java.lang.Object> extras)
void	setTimestamp(java.lang.Long timestamp) Override the timestamp of the message.
void	timestamp()
java.lang.String	toString()
void	untimestamp() Make the message's timestamp invalid so it won't end up in the serialized version.
void	writeToParcel(android.os.Parcel out, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

EXTRAS_KEY

public static final java.lang.String EXTRAS_KEY

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<VehicleMessage> CREATOR

Constructor Detail

VehicleMessage

public VehicleMessage()

VehicleMessage

public VehicleMessage(java.lang.Long timestamp)

Construct a new empty VehicleMessage.

Parameters:

timestamp - timestamp as milliseconds since unix epoch

VehicleMessage

public VehicleMessage(java.lang.Long timestamp,
                      java.util.Map<java.lang.String,java.lang.Object> extras)

Construct a new VehicleMessage with the given extra data and an overridden timestamp.

VehicleMessage

public VehicleMessage(java.util.Map<java.lang.String,java.lang.Object> extras)

Construct a new VehicleMessage with the given extra data. The extras field can hold any arbitrary key/value pairs.

Parameters:

extras - A map of any extra data to attach to this message.

VehicleMessage

protected VehicleMessage(android.os.Parcel in)

Method Detail

setTimestamp

public void setTimestamp(java.lang.Long timestamp)

Override the timestamp of the message.

Parameters:

timestamp - the timestamp to set for this message.

isTimestamped

public boolean isTimestamped()

Returns:

true if the message has a valid timestamp.

getTimestamp

public java.lang.Long getTimestamp()

Returns:

the timestamp of the message in milliseconds since the UNIX epoch.

getDate

public java.util.Date getDate()

setExtras

public void setExtras(java.util.Map<java.lang.String,java.lang.Object> extras)

hasExtras

public boolean hasExtras()

getExtras

public java.util.Map<java.lang.String,java.lang.Object> getExtras()

untimestamp

public void untimestamp()

Make the message's timestamp invalid so it won't end up in the serialized version.

timestamp

public void timestamp()

asNamedMessage

public NamedVehicleMessage asNamedMessage()

asSimpleMessage

public SimpleVehicleMessage asSimpleMessage()

asEventedMessage

public EventedSimpleVehicleMessage asEventedMessage()

asCanMessage

public CanMessage asCanMessage()

asCommandResponse

public CommandResponse asCommandResponse()

asDiagnosticRequest

public DiagnosticRequest asDiagnosticRequest()

asDiagnosticResponse

public DiagnosticResponse asDiagnosticResponse()

asKeyedMessage

public KeyedMessage asKeyedMessage()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

compareTo

public int compareTo(VehicleMessage other)

Specified by:

compareTo in interface java.lang.Comparable<VehicleMessage>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

readFromParcel

protected void readFromParcel(android.os.Parcel in)