commonMain.com.divpundir.mavlink.definitions.common.MavVtolState.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of definitions Show documentation

A modern MAVLink library for the JVM written in Kotlin.

The newest version!

package com.divpundir.mavlink.definitions.common

import com.divpundir.mavlink.api.GeneratedMavEnum
import com.divpundir.mavlink.api.GeneratedMavEnumEntry
import com.divpundir.mavlink.api.MavEnum
import kotlin.UInt

/**
 * Enumeration of VTOL states
 */
@GeneratedMavEnum
public enum class MavVtolState(
  override val `value`: UInt,
) : MavEnum {
  /**
   * MAV is not configured as VTOL
   */
  @GeneratedMavEnumEntry
  UNDEFINED(0u),
  /**
   * VTOL is in transition from multicopter to fixed-wing
   */
  @GeneratedMavEnumEntry
  TRANSITION_TO_FW(1u),
  /**
   * VTOL is in transition from fixed-wing to multicopter
   */
  @GeneratedMavEnumEntry
  TRANSITION_TO_MC(2u),
  /**
   * VTOL is in multicopter state
   */
  @GeneratedMavEnumEntry
  MC(3u),
  /**
   * VTOL is in fixed-wing state
   */
  @GeneratedMavEnumEntry
  FW(4u),
  ;

  public companion object : MavEnum.MavCompanion {
    override fun getEntryFromValueOrNull(v: UInt): MavVtolState? = when (v) {
      0u -> UNDEFINED
      1u -> TRANSITION_TO_FW
      2u -> TRANSITION_TO_MC
      3u -> MC
      4u -> FW
      else -> null
    }
  }
}