es.situm.sdk.v1

Class SitumCalibrationManager

java.lang.Object

es.situm.sdk.v1.SitumCalibrationManager

public class SitumCalibrationManager
extends Object

Manage calibrations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SitumCalibrationManager.UploadCalibrationCallback Callback to receive the status of the upload operation

Method Summary

Modifier and Type	Method and Description
boolean	addPoint(SitumFloorPoint fp) Stores a calibration point
void	cancel(android.content.Context context) Cancel the current calibration without saving to the disk.
void	deleteCalibrations(List<SitumCalibration> situmCalibrations) Delete the given list of calibrations from the device internal storage
String	getCalibrationName() Deprecated. use getCurrentCalibration()
SitumCalibration	getCurrentCalibration() Returns the current calibration
static SitumCalibrationManager	getInstance(Building building) Obtain the instance of the Calibration Manager
int	getNumberOfSavedCalibrations(android.content.Context c) Deprecated. use getSavedCalibrations(Context)
List<SitumCalibration>	getSavedCalibrations(android.content.Context context) Return the saved calibrations not uploaded
void	removeLastPoint() Removes last point.
void	startNewCalibrationAt(android.content.Context c, SitumFloorPoint fp, boolean recordwifi, boolean recordble) Starts a new calibration
boolean	stopAndSaveToDisk(android.content.Context c) Stop the calibration and save the data to disk.
void	uploadSavedCalibrations(android.content.Context c, SitumCalibrationManager.UploadCalibrationCallback callback) Upload the saved calibrations to the server and delete then from disk
void	uploadSelectedCalibrations(android.content.Context c, List<SitumCalibration> situmCalibrations, SitumCalibrationManager.UploadCalibrationCallback callback) Upload a list of calibrations previously saved in the disk.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static SitumCalibrationManager getInstance(Building building)

Obtain the instance of the Calibration Manager

Parameters:

building - Building to initialize the calibration manager

startNewCalibrationAt

public void startNewCalibrationAt(android.content.Context c,
                                  SitumFloorPoint fp,
                                  boolean recordwifi,
                                  boolean recordble)

Starts a new calibration

Parameters:

c - Application context

fp - A point inside the map (meters, meters). Origin is at bottom left corner

recordwifi - Record wifi

recordble - Record beacons

addPoint

public boolean addPoint(SitumFloorPoint fp)

Stores a calibration point

Parameters:

fp - A point inside the map (meters, meters). Origin is at bottom left corner

removeLastPoint

public void removeLastPoint()

Removes last point.

WARNING: No more points can be added to this Calibration after calling this method. A new calibration should be created for that pourpose.

getNumberOfSavedCalibrations

@Deprecated
public int getNumberOfSavedCalibrations(android.content.Context c)

Deprecated. use getSavedCalibrations(Context)

Opens an alert dialog if there are calibration files stored in disk that has not been uploaded to Situm Dashboard

Parameters:

c - Context used to access files and uploading them to Situm Dashboard

Returns:

number of saved calibrations in this device

getSavedCalibrations

public List<SitumCalibration> getSavedCalibrations(android.content.Context context)

Return the saved calibrations not uploaded

Parameters:

context - the context

Returns:

list of saved calibrations not uploaded

getCalibrationName

@Deprecated
public String getCalibrationName()

Deprecated. use getCurrentCalibration()

Returns:

The name of the current calibration or unknow if the calibration not exists

getCurrentCalibration

public SitumCalibration getCurrentCalibration()

Returns the current calibration

Returns:

null if no current calibration

stopAndSaveToDisk

public boolean stopAndSaveToDisk(android.content.Context c)

Stop the calibration and save the data to disk. A minimum of 3 points is needed

Parameters:

c - Application context

Returns:

True if the calibration has been saved to the disk and stopped recording, false otherwise

cancel

public void cancel(android.content.Context context)

Cancel the current calibration without saving to the disk. Calling this method result in stop the service

Parameters:

context - application context

uploadSavedCalibrations

public void uploadSavedCalibrations(android.content.Context c,
                                    SitumCalibrationManager.UploadCalibrationCallback callback)

Upload the saved calibrations to the server and delete then from disk

Parameters:

c - Application context

callback - the callback

uploadSelectedCalibrations

public void uploadSelectedCalibrations(android.content.Context c,
                                       List<SitumCalibration> situmCalibrations,
                                       SitumCalibrationManager.UploadCalibrationCallback callback)

Upload a list of calibrations previously saved in the disk. When the upload is successful then delete the calibrations from disk

Parameters:

c - application context

situmCalibrations - list of calibration names to be uploaded to the server

callback - the callback

deleteCalibrations

public void deleteCalibrations(List<SitumCalibration> situmCalibrations)

Delete the given list of calibrations from the device internal storage

Parameters:

situmCalibrations - list of calibrations to be deleted