xplane v0.5.0 XPlane.DataRef

Represent an X-Plane Data Reference (DataRef) and provide helper methods to load the closest available set of DataRefs for a given X-Plane version

Link to this section Summary

Functions

Load the closest list of DataRefs we have available for the specified X-Plane version.

Link to this section Types

Link to this type

t()
t() :: %XPlane.DataRef{
  code: integer(),
  description: String.t(),
  id: atom(),
  name: String.t(),
  type: XPlane.DataRef.xtype(),
  units: String.t(),
  writable: boolean()
}

Link to this type

xtype()
xtype() ::
  {:byte | :float | :int | :uint | :short | :ushort, [integer()]} | :void

Link to this section Functions

Link to this function

describe(data_refs, pattern)

Link to this function

load_version(version_number)
load_version(integer()) :: %{atom: XPlane.DataRef.t()}

Load the closest list of DataRefs we have available for the specified X-Plane version.

Parameters

Link to this function

withCode(data_refs, code_to_match)