WemapCoreSDK/com.getwemap.sdk.core.model.entities/Levels

Levels

sealed class Levels

Represents the level(s) an entity is located on: outdoor, a single level, or a range of levels.

Inheritors

Outdoor

Single

Range

Types

Companion

object Companion

InitializationError

sealed class InitializationError : Throwable

An error raised while creating Levels from an invalid array of level values.

Outdoor

object Outdoor : Levels

The entity is outdoor, not associated with any level.

Range

data class Range(val range: ClosedRange<Float>) : Levels

The entity spans a range of levels.

Single

data class Single(val level: Float) : Levels

The entity is on a single level.

Properties

isOutdoor

val isOutdoor: Boolean

Returns true if the value is Outdoor.

isRange

val isRange: Boolean

Returns true if the value is Range.

isSingle

val isSingle: Boolean

Returns true if the value is Single.

single

val single: Float?

The single level value: the level for Single, the lower bound for Range, null for Outdoor.

Functions

contains

fun contains(other: Levels): Boolean

Returns true if a level is contained in another level.

diff

fun diff(other: Levels): Float?

Returns the level difference between the current level and another level.

intersection

fun intersection(other: Levels): Levels

Returns the level of intersection between the current level and another level.

intersects

fun intersects(other: Levels): Boolean

Returns true if a level intersects another one.

toList

fun toList(): List<Float>

Returns the level(s) as a list: empty for Outdoor, one value for Single, two bounds for Range.

union

fun union(other: Levels): Levels

Returns the union of the current level and another level.