de.unikassel.android.sdcframework.data.independent
Class ProximitySampleData

Package class diagram package ProximitySampleData
java.lang.Object
  extended by de.unikassel.android.sdcframework.data.independent.AbstractSampleData
      extended by de.unikassel.android.sdcframework.data.independent.ProximitySampleData
All Implemented Interfaces:
SampleData, SerializableData

public final class ProximitySampleData
extends AbstractSampleData

The proximity sensor device specific sample data, which is the proximity sensor distance measured in centimeters.

ATTENTON:
There do exist very simple binary sensor types which do only support near and far state measurement. In such a case, just two values will be set: a large value for the far state and a lower one for the near state.

See Also:
ProximityDevice, ProximityDeviceScanner

Field Summary
private  float proximityDistance
          The proximity sensor distance measured in centimeters, resp.
 
Constructor Summary
ProximitySampleData()
          Constructor
ProximitySampleData(ProximitySampleData sampleData)
          Constructor
 
Method Summary
 SampleData doClone()
          Method to clone sample data
 boolean equals(Object o)
           
 float getProximityDistance()
          Getter for the proximity sensor distance
 void setProximityDistance(float proximityDistance)
          Setter for the proximity sensor distance
 
Methods inherited from class de.unikassel.android.sdcframework.data.independent.AbstractSampleData
clone, getRelatedData, toXML, updateRelatedData
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

proximityDistance

private float proximityDistance
The proximity sensor distance measured in centimeters, resp. the near and far state values.

Constructor Detail

ProximitySampleData

public ProximitySampleData()
Constructor


ProximitySampleData

public ProximitySampleData(ProximitySampleData sampleData)
Constructor

Parameters:
sampleData - the sample data to copy construct from
Method Detail

doClone

public final SampleData doClone()
Description copied from interface: SampleData
Method to clone sample data

Returns:
a copy of the sample data

equals

public final boolean equals(Object o)
Overrides:
equals in class Object

setProximityDistance

public final void setProximityDistance(float proximityDistance)
Setter for the proximity sensor distance

Parameters:
proximityDistance - the proximity sensor distance to set

getProximityDistance

public final float getProximityDistance()
Getter for the proximity sensor distance

Returns:
the proximity sensor distance