MPIInstruction

data class MPIInstruction(action: MPIDirections.MPIAction?, instruction: String?, node: MPINavigatable.MPINode?, distance: Double?, atVortex: MPINavigatable.MPIVortex?)

This class represents a singular step or instruction of a MPIDirections

Constructors

MPIInstruction

fun MPIInstruction(action: MPIDirections.MPIAction? = null, instruction: String?, node: MPINavigatable.MPINode? = null, distance: Double?, atVortex: MPINavigatable.MPIVortex? = null)

Functions

component1

operator fun component1(): MPIDirections.MPIAction?

component2

operator fun component2(): String?

component3

operator fun component3(): MPINavigatable.MPINode?

component4

operator fun component4(): Double?

component5

operator fun component5(): MPINavigatable.MPIVortex?

copy

fun copy(action: MPIDirections.MPIAction? = null, instruction: String?, node: MPINavigatable.MPINode? = null, distance: Double?, atVortex: MPINavigatable.MPIVortex? = null): MPIDirections.MPIInstruction

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

action

val action: MPIDirections.MPIAction? = null

An optional action being performed at a node

atVortex

var atVortex: MPINavigatable.MPIVortex? = null

distance

val distance: Double?

instruction

val instruction: String?

An optional string instruction to display to user

Example: "Take elevator up to Upper Level"

node

val node: MPINavigatable.MPINode? = null

An optional node where instruction takes place at