encyclopedia

Documentation

Overview

Package encyclopedia is a database of aircraft data.

Index

• Variables
• type Aircraft
  • func GetAircraftData(name string) (Aircraft, bool)
  • func (a Aircraft) Category() brevity.ContactCategory
  • func (a Aircraft) HasAnyTag(tags ...AircraftTag) bool
  • func (a Aircraft) HasTag(tag AircraftTag) bool
  • func (a Aircraft) Tags() []AircraftTag
  • func (a Aircraft) ThreatRadius() unit.Length
• type AircraftTag

Variables

var (
	// SAR1IRThreat is the threat radius for aircraft with older SARH missiles or any generation of IR missiles.
	SAR1IRThreat = 15 * unit.NauticalMile
	// SAR2AR1Threat is the threat radius for aircraft with newer SARH missiles or any generation of ARH missiles.
	SAR2AR1Threat = 25 * unit.NauticalMile
	// ExtendedThreat is the threat radius for fast fighters and interceptors with newer SARH or ARH missiles.
	ExtendedThreat = 35 * unit.NauticalMile
)

Types

type Aircraft

type Aircraft struct {
	// ACMIShortName is the Name proeprty used in ACMI telemetry.
	ACMIShortName string

	// e.g. F-15, Su-27
	PlatformDesignation string
	// TypeDesignation is the official type designation of the aircraft.
	// e.g. F-15C, F-15E, Su-27
	TypeDesignation string
	// NATOReportingName is the NATO reporting name of the aircraft. Not all aircraft have a NATO reporting name.
	// e.g. Flanker, Bear
	NATOReportingName string
	// OfficialName is the official name of the aircraft. Not all aircraft have an official name.
	// e.g. Thunderbolt, Falcon, Eagle
	OfficialName string
	// Nickname is a common nickname for the aircraft. Not all aircraft have a nickname.
	// e.g. Warthog, Viper, Mudhen
	Nickname string
	// contains filtered or unexported fields
}

Aircraft describes a specific aircraft type.

func GetAircraftData

func GetAircraftData(name string) (Aircraft, bool)

GetAircraftData returns the aircraft data for the given name, if it exists. The name should be the Name property of an ACMI object. The second return value is false if the data does not exist.

func (Aircraft) Category

func (a Aircraft) Category() brevity.ContactCategory

Category returns the ContactCategory of the aircraft based on its tags.

func (Aircraft) HasAnyTag

func (a Aircraft) HasAnyTag(tags ...AircraftTag) bool

HasAnyTag returns true if the aircraft has any of the specified tags.

func (Aircraft) HasTag

func (a Aircraft) HasTag(tag AircraftTag) bool

HasTag returns true if the aircraft has the specified tag.

func (Aircraft) Tags

func (a Aircraft) Tags() []AircraftTag

Tags of the aircraft.

func (Aircraft) ThreatRadius

func (a Aircraft) ThreatRadius() unit.Length

ThreatRadius returns the aircraft's threat radius.

type AircraftTag

type AircraftTag int

AircraftTag categorizes aircraft.

const (
	// FixedWing indicates a fixed-wing aircraft.
	FixedWing AircraftTag = iota
	// RotaryWing indicates a rotary-wing aircraft.
	RotaryWing
	// Unarmed indicates an aircraft not armed with ait-to-air missiles.
	Unarmed
	// Fighter indicates a fighter aircraft with air-to-air missiles.
	Fighter
	// Attack indicates an attack aircraft with self-defense air-to-air missiles.
	Attack
)