commonMain.com.divpundir.mavlink.api.MavEnum.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-jvm Show documentation

A modern MAVLink library for the JVM written in Kotlin.

There is a newer version: 1.2.8

package com.divpundir.mavlink.api

/**
 * A high-level representation of a MAVLink enum.
 */
public interface MavEnum {

    /**
     * The value of the enum entry according to the XML schema.
     */
    public val value: UInt

    /**
     * The companion object for a [MavEnum].
     */
    public interface MavCompanion {

        /**
         * Returns the entry corresponding to the given value if it exists in the enum, null otherwise.
         */
        public fun getEntryFromValueOrNull(v: UInt): T?
    }
}