com.openxc.messages

Class Command

java.lang.Object

com.openxc.messages.VehicleMessage

com.openxc.messages.KeyedMessage

com.openxc.messages.Command

All Implemented Interfaces:

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

public class Command
extends KeyedMessage

A Command message defined by the OpenXC message format.

Commands are keyed on the command name.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Command.CommandType

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	ACTION_KEY
protected static java.lang.String	BUS_KEY
protected static java.lang.String	BYPASS_KEY
protected static java.lang.String	COMMAND_KEY
protected static java.lang.String	DIAGNOSTIC_REQUEST_KEY
protected static java.lang.String	ENABLED_KEY
protected static java.lang.String	FORMAT_KEY
protected static java.lang.String	UNIX_TIME_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	Command()
	Command(Command.CommandType command)
	Command(Command.CommandType command, boolean bypass, int bus)
	Command(Command.CommandType command, int bus, boolean enabled)
	Command(Command.CommandType command, long unixTime)
	Command(Command.CommandType command, java.lang.String action)
	Command(DiagnosticRequest request, java.lang.String action)
protected	Command(android.os.Parcel in)
	Command(java.lang.String format, Command.CommandType command)

Method Summary

Modifier and Type	Method and Description
static boolean	containsRequiredFields(java.util.Set<java.lang.String> fields)
boolean	equals(java.lang.Object obj)
java.lang.String	getAction()
int	getBus()
Command.CommandType	getCommand()
DiagnosticRequest	getDiagnosticRequest()
java.lang.String	getFormat()
MessageKey	getKey() Return the identifying key for this message.
long	getUnixTime()
boolean	hasAction()
boolean	isBypass()
boolean	isEnabled()
protected void	readFromParcel(android.os.Parcel in)
void	setBus(int mBus)
void	setBypass(boolean bypass)
void	setEnabled(boolean enabled)
void	setFormat(java.lang.String Format)
void	setUnixTime(long unixTime)
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, compareTo, 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

COMMAND_KEY

protected static final java.lang.String COMMAND_KEY

See Also:

Constant Field Values

DIAGNOSTIC_REQUEST_KEY

protected static final java.lang.String DIAGNOSTIC_REQUEST_KEY

See Also:

Constant Field Values

ACTION_KEY

protected static final java.lang.String ACTION_KEY

See Also:

Constant Field Values

BUS_KEY

protected static final java.lang.String BUS_KEY

See Also:

Constant Field Values

ENABLED_KEY

protected static final java.lang.String ENABLED_KEY

See Also:

Constant Field Values

BYPASS_KEY

protected static final java.lang.String BYPASS_KEY

See Also:

Constant Field Values

FORMAT_KEY

protected static final java.lang.String FORMAT_KEY

See Also:

Constant Field Values

UNIX_TIME_KEY

protected static final java.lang.String UNIX_TIME_KEY

See Also:

Constant Field Values

Constructor Detail

Command

public Command(Command.CommandType command,
               int bus,
               boolean enabled)

Command

public Command(Command.CommandType command,
               boolean bypass,
               int bus)

Command

public Command(java.lang.String format,
               Command.CommandType command)

Command

public Command(Command.CommandType command,
               long unixTime)

Command

public Command(Command.CommandType command,
               java.lang.String action)

Command

public Command(Command.CommandType command)

Command

public Command(DiagnosticRequest request,
               java.lang.String action)

Command

protected Command(android.os.Parcel in)

Command

protected Command()

Method Detail

getCommand

public Command.CommandType getCommand()

hasAction

public boolean hasAction()

getAction

public java.lang.String getAction()

getDiagnosticRequest

public DiagnosticRequest getDiagnosticRequest()

getBus

public int getBus()

setBus

public void setBus(int mBus)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

isBypass

public boolean isBypass()

setBypass

public void setBypass(boolean bypass)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String Format)

getUnixTime

public long getUnixTime()

setUnixTime

public void setUnixTime(long unixTime)

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)

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

protected void readFromParcel(android.os.Parcel in)

Overrides:

readFromParcel in class VehicleMessage