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
,Filterable
public class Floor extends Resource implements BuildingResource, android.os.Parcelable
Floor of a building. Instances are immutable.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Floor.Builder
Builder to create aFloor
instance
-
Field Summary
Fields Modifier and Type Field Description static android.os.Parcelable.Creator<Floor>
CREATOR
-
Fields inherited from class es.situm.sdk.model.Resource
EMPTY_IDENTIFIER, EMPTY_IDENTIFIER_BACKWARDS
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
describeContents()
boolean
equals(Object o)
double
getAltitude()
Returns altitude of the floor above ground level, in metersString
getBuildingIdentifier()
Returns the identifier of building which this floor belongs.int
getFloor()
Retrieves the number of the floorint
getLevel()
Deprecated.usegetFloor()
insteadURL
getMapUrl()
Return the floor map image urlString
getName()
Return the name of the floor limited to 5 characters.double
getScale()
Returns the scale of the floor image, in px/metersint
hashCode()
String
toString()
void
writeToParcel(android.os.Parcel dest, int flags)
-
Methods inherited from class es.situm.sdk.model.Resource
getCreatedAt, getCustomFields, getIdentifier, getUpdatedAt
-
-
-
-
Field Detail
-
CREATOR
public static final android.os.Parcelable.Creator<Floor> CREATOR
-
-
Method Detail
-
getBuildingIdentifier
@NonNull public String getBuildingIdentifier()
Returns the identifier of building which this floor belongs.- Specified by:
getBuildingIdentifier
in interfaceBuildingResource
-
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.usegetFloor()
insteadReturns 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
-
describeContents
public int describeContents()
- Specified by:
describeContents
in interfaceandroid.os.Parcelable
-
writeToParcel
public void writeToParcel(android.os.Parcel dest, int flags)
- Specified by:
writeToParcel
in interfaceandroid.os.Parcelable
-
-