Package es.situm.sdk.model.cartography

Class Floor

java.lang.Object

es.situm.sdk.model.Resource

es.situm.sdk.model.cartography.Floor

All Implemented Interfaces:

android.os.Parcelable, BuildingResource, MapperInterface, Filterable

public class Floor
extends Resource
implements BuildingResource, android.os.Parcelable, MapperInterface

Floor of a building. Instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Floor.Builder	Builder to create a Floor instance

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final android.os.Parcelable.Creator<Floor>	CREATOR

Fields inherited from class es.situm.sdk.model.Resource

EMPTY_IDENTIFIER, EMPTY_IDENTIFIER_BACKWARDS

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, ASSET_TRACKING_OPTIONS_BEACON_FILTERS, ASSET_TRACKING_OPTIONS_ENABLED, ASSET_TRACKING_OPTIONS_ITERATIONS_TO_UPLOAD, ASSET_TRACKING_OPTIONS_SCANNING_INTERVAL, BEACON_FILTER_UUID, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIAGNOSTICS_OPTIONS_UPLOAD_DIAGNOSTICS_DATA, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, DURATION_MINUTES, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, REALTIME_UPDATE_INTERVAL, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	describeContents()
boolean	equals(Object o)
double	getAltitude()	Returns altitude of the floor above ground level, in meters
String	getBuildingIdentifier()	Returns the identifier of building which this floor belongs.
int	getFloor()	Retrieves the number of the floor
int	getLevel()	Deprecated. use getFloor() instead
URL	getMapUrl()	Return the floor map image url
String	getName()	Return the name of the floor limited to 5 characters.
double	getScale()	Returns the scale of the floor image, in px/meters
int	hashCode()
Map<String,Object>	toMap()	Method to transform object into Map<String, Object>
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class es.situm.sdk.model.Resource

getCreatedAt, getCustomFields, getIdentifier, getUpdatedAt

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

CREATOR

public static final android.os.Parcelable.Creator<Floor> CREATOR

Method Details

getBuildingIdentifier

@NonNull
public String getBuildingIdentifier()

Returns the identifier of building which this floor belongs.

Specified by:

getBuildingIdentifier in interface BuildingResource

getName

public String getName()

Return the name of the floor limited to 5 characters. If name is not defined an empty String is returned.

getLevel

@Deprecated
public int getLevel()

Deprecated.

use getFloor() instead

Returns the number of the floor.

getFloor

public int getFloor()

Retrieves the number of the floor

getScale

public double getScale()

Returns the scale of the floor image, in px/meters

getAltitude

public double getAltitude()

Returns altitude of the floor above ground level, in meters

Returns:

the floor altitude. Default value is 0

getMapUrl

@NonNull
public URL getMapUrl()

Return the floor map image url

toMap

public Map<String,Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map<String, Object>

Specified by:

toMap in interface MapperInterface

Returns:

Map<String, Object> with the information of the object mapped

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(Object o)

Overrides:

equals in class Resource

hashCode

public int hashCode()

Overrides:

hashCode in class Resource

toString

public String toString()

Overrides:

toString in class Resource