commonMain.com.divpundir.mavlink.api.MavDialect.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

public interface MavDialect {

    /**
     * The dialects that this dialect depends on.
     */
    public val dependencies: Set

    /**
     * The messages that are defined in this dialect. This does not include the messages of the dependencies.
     */
    public val messages: Map>>

    /**
     * Searches the dialect and its dependencies for the [MavMessage.MavCompanion] of the given [messageId]. Returns the
     * object if found, null otherwise.
     */
    public fun resolveCompanionOrNull(messageId: UInt): MavMessage.MavCompanion>?

    /**
     * Checks whether this dialect supports the message of the specified [messageId].
     */
    public fun supports(messageId: UInt): Boolean
}