HazardElement

class HazardElement(val id: Int, val pathId: Int, val startOffset: Distance, val endOffset: Distance, val hazard: Hazard) : HorizonElement

Horizon element that contains data about a hazard.

Important: This is a Public Preview API. It may be changed or removed at any time.

To receive such elements in the horizon snapshot, specify HazardElementType in the horizon options that you register with the horizon engine:

val horizonOptions = HorizonOptions(
elementTypes = listOf(HazardElementType, ...),
...
)

Constructors

Link copied to clipboard
constructor(id: Int, pathId: Int, startOffset: Distance, endOffset: Distance, hazard: Hazard)

Properties

Link copied to clipboard
open override val endOffset: Distance

End offset on the horizon path.

Link copied to clipboard

Hazard entry containing the id, type, category, severity, detailedInformation, location, version.

Link copied to clipboard
open override val id: Int

Identifier of this element.

Link copied to clipboard
open override val pathId: Int

Identifier of the horizon path to which this element belongs.

Link copied to clipboard
open override val startOffset: Distance

Start offset on the horizon path.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String