Skip to content

minisky.types

types

Semantic runtime values used at parser and vectorized-state boundaries.

MiniSky keeps ordinary simulation arrays as typed numerical quantities from minisky.quantities. These wrappers are for cases where multiple values share the same Python carrier but their reference or variant must survive at runtime.

AircraftTypeCode module-attribute

AircraftTypeCode: TypeAlias = str

Aircraft model/type designator used by MiniSky and plugins.

AircraftCallsign module-attribute

AircraftCallsign: TypeAlias = str

Aircraft identifier used as a callsign within a simulation runtime.

AircraftIndex module-attribute

AircraftIndex: TypeAlias = int

Index into the traffic arrays for an aircraft.

RouteWaypointIndex module-attribute

RouteWaypointIndex: TypeAlias = int

Index of a waypoint within an aircraft route.

IcaoAircraftTypeCode module-attribute

IcaoAircraftTypeCode: TypeAlias = AircraftTypeCode

Uppercase ICAO aircraft type designator used by OpenAP, for example A320.

WaypointReference module-attribute

WaypointReference: TypeAlias = str

Stored waypoint source, e.g. EHAM, EHAM/RW18L, or 52.0,4.0.

WaypointIdentifier module-attribute

WaypointIdentifier: TypeAlias = str

Navigation-dataset waypoint identifier, for example SUGOL.

AirportIdentifier module-attribute

AirportIdentifier: TypeAlias = str

Navigation-database airport identifier, commonly a four-letter ICAO code such as EHAM.

RunwayIdentifier module-attribute

RunwayIdentifier: TypeAlias = str

Runway designator without an RW prefix, for example 09 or 25L.

AirwayIdentifier module-attribute

AirwayIdentifier: TypeAlias = str

Published airway identifier, for example UL620.

Ge0 module-attribute

Ge0: TypeAlias = Annotated[_T, Ge(0)]

A value greater than or equal to zero.

Gt0 module-attribute

Gt0: TypeAlias = Annotated[_T, Gt(0)]

A value greater than zero.

RuntimeNewType

Bases: ABC, Generic[_T]

Base class for runtime newtypes.

The generic carrier preserves constraints and container types independently of the semantic wrapper, for example CasMps[IsFinite[Gt0[float]]] or CasMps[np.ndarray].

See: https://doc.rust-lang.org/rust-by-example/generics/new_types.html

__slots__ class-attribute instance-attribute

__slots__ = ()

value instance-attribute

value: _T

AirspeedKind

Bases: IntEnum

Discriminant for required selected airspeed state.

CAS class-attribute instance-attribute

CAS = 0

MACH class-attribute instance-attribute

MACH = 1

Mach.

OptionalAirspeedKind

Bases: IntEnum

Discriminant for optional airspeed state.

NONE class-attribute instance-attribute

NONE = 0

CAS class-attribute instance-attribute

CAS = 1

MACH class-attribute instance-attribute

MACH = 2

Mach.

CasMps dataclass

CasMps(value: CalibratedAirspeedMps[_T])

Bases: RuntimeNewType[_T]

Calibrated airspeed normalized to metres per second.

Note that in minisky, IAS is used interchangeably with CAS, assuming zero instrument and position errors.

value instance-attribute

Mach dataclass

Mach(value: MachNumber[_T])

Bases: RuntimeNewType[_T]

Mach number.

value instance-attribute

value: MachNumber[_T]

StdPressureAltM dataclass

StdPressureAltM(value: PressureAltitudeM[_T])

Bases: RuntimeNewType[_T]

Barometric pressure altitude on the standard-pressure reference.

QNE is the standard altimeter setting and flight levels are the operational designation for the standard-pressure reference (1013.25 hPa).

In ICAO Field 15:

  • F + 3 digits = flight level, digits in hundreds of feet, and
  • S + 4 digits = standard metric level, digits in tens of metres

value instance-attribute

value: PressureAltitudeM[_T]

MslAltM dataclass

MslAltM(value: MslAltitudeM[_T])

Bases: RuntimeNewType[_T]

Altitude above mean sea level.

QNH is the altimeter subscale pressure setting chosen so a correctly calibrated pressure altimeter indicates altitude relative to mean sea level.

In ICAO Field 15:

  • A + 3 digits = altitude in hundreds of feet
  • M + 4 digits = altitude in tens of metres

value instance-attribute

value: MslAltitudeM[_T]

TrueHeadingDeg dataclass

TrueHeadingDeg(value: TrueHeadingDegrees[_T])

Bases: RuntimeNewType[_T]

Heading relative to true north in degrees.

value instance-attribute

value: TrueHeadingDegrees[_T]

MagneticHeadingDeg dataclass

MagneticHeadingDeg(value: MagneticHeadingDegrees[_T])

Bases: RuntimeNewType[_T]

Heading relative to magnetic north in degrees.

value instance-attribute

GroundTrackDeg dataclass

GroundTrackDeg(value: GroundTrackDeg[_T])

Bases: RuntimeNewType[_T]

Ground-track direction relative to true north in degrees.

value instance-attribute

value: GroundTrackDeg[_T]

LatLonDegrees dataclass

LatLonDegrees(lat: LatitudeDeg[_T], lon: LongitudeDeg[_T])

Bases: Generic[_T]

Resolved latitude and longitude in degrees.

lat instance-attribute

lat: LatitudeDeg[_T]

lon instance-attribute

lon: LongitudeDeg[_T]