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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of definitions-jvm 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

/**
 *
 *         Actions for reading and writing plan information (mission, rally points, geofence)
 * between persistent and volatile storage when using MAV_CMD_PREFLIGHT_STORAGE.
 *         (Commonly missions are loaded from persistent storage (flash/EEPROM) into volatile
 * storage (RAM) on startup and written back when they are changed.)
 *       
 */
@GeneratedMavEnum
public enum class PreflightStorageMissionAction(
  override val `value`: UInt,
) : MavEnum {
  /**
   * Read current mission data from persistent storage
   */
  @GeneratedMavEnumEntry
  MISSION_READ_PERSISTENT(0u),
  /**
   * Write current mission data to persistent storage
   */
  @GeneratedMavEnumEntry
  MISSION_WRITE_PERSISTENT(1u),
  /**
   * Erase all mission data stored on the vehicle (both persistent and volatile storage)
   */
  @GeneratedMavEnumEntry
  MISSION_RESET_DEFAULT(2u),
  ;

  public companion object : MavEnum.MavCompanion {
    override fun getEntryFromValueOrNull(v: UInt): PreflightStorageMissionAction? = when (v) {
      0u -> MISSION_READ_PERSISTENT
      1u -> MISSION_WRITE_PERSISTENT
      2u -> MISSION_RESET_DEFAULT
      else -> null
    }
  }
}