com.openxc.measurements

Class BaseMeasurement<TheUnit extends Unit>

java.lang.Object

com.openxc.measurements.BaseMeasurement<TheUnit>

All Implemented Interfaces:

Measurement

Direct Known Subclasses:

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

public abstract class BaseMeasurement<TheUnit extends Unit>
extends java.lang.Object
implements Measurement

The BaseMeasurement is the base implementation of the Measurement, and wraps an instance of a Unit, and the value it returns is always in terms of this Unit. The Unit wrapper might seem annoying at first, but it is critical to avoid misinterpreting the unit and crashing your lander into Mars (http://en.wikipedia.org/wiki/Mars_Climate_Orbiter). Most applications will not use this class directly, but will import specific child classes that correspond to specific types of measurements - i.e. the parameterized instances of this class with a Unit. That may seem like a "pseudo-typedef" but we're using it to enforce the binding between the measurement and its unit type. This unfortunately means we have to add constructors to every child class because they aren't inherited from Measurement. If you know of a better way, please say so.

Nested Class Summary

Nested classes/interfaces inherited from interface com.openxc.measurements.Measurement

Measurement.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected AgingData<TheUnit>	mValue

Constructor Summary

Constructors

Constructor and Description
BaseMeasurement(TheUnit value) Construct a new Measurement with the given value.
BaseMeasurement(TheUnit value, Range<TheUnit> range) Construct an new Measurement with the given value and valid Range.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long	getAge() Retrieve the age of this measurement.
long	getBirthtime() Return the creation time of this measurement;
static java.lang.Class<? extends Measurement>	getClassForId(java.lang.String measurementId)
abstract java.lang.String	getGenericName()
static MessageKey	getKeyForMeasurement(java.lang.Class<? extends Measurement> measurementType)
static Measurement	getMeasurementFromMessage(java.lang.Class<? extends Measurement> measurementType, SimpleVehicleMessage message)
static Measurement	getMeasurementFromMessage(SimpleVehicleMessage message)
java.lang.String	getName(android.content.Context context)
Range<TheUnit>	getRange() Retrieve the valid range of the measurement.
java.lang.Object	getSerializedValue() Return the value of this measurement as a type good for serialization.
TheUnit	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.
java.lang.String	toString()
SimpleVehicleMessage	toVehicleMessage()

Methods inherited from class java.lang.Object

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

Field Detail

mValue

protected AgingData<TheUnit extends Unit> mValue

Constructor Detail

BaseMeasurement

public BaseMeasurement(TheUnit value)

Construct a new Measurement with the given value.

Parameters:

value - the TheUnit this measurement represents.

BaseMeasurement

public BaseMeasurement(TheUnit value,
                       Range<TheUnit> range)

Construct an new Measurement with the given value and valid Range. There is not currently any automated verification that the value is within the range - this is up to the application programmer.

Parameters:

value - the TheUnit this measurement represents.

range - the valid Range of values for this measurement.

Method Detail

getGenericName

public abstract java.lang.String getGenericName()

Specified by:

getGenericName in interface Measurement

setTimestamp

public void setTimestamp(long timestamp)

Description copied from interface: Measurement

Set the birth timestamp for this measurement.

Specified by:

setTimestamp in interface Measurement

Parameters:

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

getAge

public long getAge()

Description copied from interface: Measurement

Retrieve the age of this measurement.

Specified by:

getAge in interface Measurement

Returns:

the age of the data in milliseconds.

getBirthtime

public long getBirthtime()

Description copied from interface: Measurement

Return the creation time of this measurement;

Specified by:

getBirthtime in interface Measurement

Returns:

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

hasRange

public boolean hasRange()

Description copied from interface: Measurement

Determine if this measurement has a valid range.

Specified by:

hasRange in interface Measurement

Returns:

true if the measurement has a non-null range.

getRange

public Range<TheUnit> getRange()

Description copied from interface: Measurement

Retrieve the valid range of the measurement.

Specified by:

getRange in interface Measurement

Returns:

the Range of the measurement or null if none.

getValue

public TheUnit getValue()

Description copied from interface: Measurement

Return the value of this measurement.

Specified by:

getValue in interface Measurement

Returns:

The wrapped value (an instance of TheUnit)

getSerializedValue

public java.lang.Object getSerializedValue()

Description copied from interface: Measurement

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

Specified by:

getSerializedValue in interface Measurement

Returns:

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

toVehicleMessage

public SimpleVehicleMessage toVehicleMessage()

Specified by:

toVehicleMessage in interface Measurement

getName

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

Specified by:

getName in interface Measurement

getKeyForMeasurement

public static MessageKey getKeyForMeasurement(java.lang.Class<? extends Measurement> measurementType)
                                       throws UnrecognizedMeasurementTypeException

Throws:

UnrecognizedMeasurementTypeException

getClassForId

public static java.lang.Class<? extends Measurement> getClassForId(java.lang.String measurementId)
                                                            throws UnrecognizedMeasurementTypeException

Throws:

UnrecognizedMeasurementTypeException

getMeasurementFromMessage

public static Measurement getMeasurementFromMessage(SimpleVehicleMessage message)
                                             throws UnrecognizedMeasurementTypeException,
                                                    NoValueException

Throws:

UnrecognizedMeasurementTypeException

NoValueException

getMeasurementFromMessage

public static Measurement getMeasurementFromMessage(java.lang.Class<? extends Measurement> measurementType,
                                                    SimpleVehicleMessage message)
                                             throws UnrecognizedMeasurementTypeException,
                                                    NoValueException

Throws:

UnrecognizedMeasurementTypeException

NoValueException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object