com.openxc.measurements

Interface Measurement

All Known Implementing Classes:

AcceleratorPedalPosition, BaseMeasurement, BrakePedalStatus, EngineSpeed, EventedMeasurement, FuelConsumed, FuelLevel, HeadlampStatus, HighBeamStatus, IgnitionStatus, Latitude, Longitude, Odometer, ParkingBrakeStatus, SteeringWheelAngle, TorqueAtTransmission, TransmissionGearPosition, TurnSignalStatus, VehicleButtonEvent, VehicleDoorStatus, VehicleSpeed, WindshieldWiperStatus

public interface Measurement

The Measurement is the base for all OpenXC measurements. A Measurement has at least a value and an age, and optionally a range of valid values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Measurement.Listener

Method Summary

Modifier and Type	Method and Description
long	getAge() Retrieve the age of this measurement.
long	getBirthtime() Return the creation time of this measurement;
java.lang.String	getGenericName()
java.lang.String	getName(android.content.Context context)
Range<? extends Unit>	getRange() Retrieve the valid range of the measurement.
java.lang.Object	getSerializedValue() Return the value of this measurement as a type good for serialization.
Unit	getValue() Return the value of this measurement.
boolean	hasRange() Determine if this measurement has a valid range.
void	setTimestamp(long timestamp) Set the birth timestamp for this measurement.
SimpleVehicleMessage	toVehicleMessage()

Method Detail

getAge

long getAge()

Retrieve the age of this measurement.

Returns:

the age of the data in milliseconds.

setTimestamp

void setTimestamp(long timestamp)

Set the birth timestamp for this measurement.

Parameters:

timestamp - the new timestamp, in milliseconds since the epoch.

hasRange

boolean hasRange()

Determine if this measurement has a valid range.

Returns:

true if the measurement has a non-null range.

getRange

Range<? extends Unit> getRange()

Retrieve the valid range of the measurement.

Returns:

the Range of the measurement or null if none.

getValue

Unit getValue()

Return the value of this measurement.

Returns:

The wrapped value (an instance of TheUnit)

toVehicleMessage

SimpleVehicleMessage toVehicleMessage()

getBirthtime

long getBirthtime()

Return the creation time of this measurement;

Returns:

the creation time in milliseconds since the epoch of this measurement.

getName

java.lang.String getName(android.content.Context context)

getGenericName

java.lang.String getGenericName()

getSerializedValue

java.lang.Object getSerializedValue()

Return the value of this measurement as a type good for serialization.

Returns:

something easily serializable - e.g. String, Double, Boolean.