brevity

type AlphaCheckRequest struct {
	// Callsign of the friendly aircraft requesting the ALPHA CHECK.
	Callsign string
}

type AlphaCheckResponse struct {
	// Callsign of the friendly aircraft requesting the ALPHA CHECK.
	Callsign string
	// Status is true if the ALPHA CHECK was correlated to an aircraft on frequency, otherwise false.
	Status bool
	// Location of the friendly aircraft. If Status is false, this may be nil.
	Location Bullseye
}

type Aspect string

type BRA interface {
	// Bearing is the heading from the fighter to the contact, rounded to the nearest degree.
	Bearing() unit.Angle
	// Range is the distance from the fighter to the contact, rounded to the nearest nautical mile.
	Range() unit.Length
	// Altitude of the contact above sea level, rounded to the nearest thousands of feet.
	Altitude() unit.Length
}

type BRAA interface {
	BRA
	// Aspect of the contact.
	Aspect() Aspect
}

type BogeyDopeRequest struct {
	// Callsign of the friendly aircraft requesting the BOGEY DOPE.
	Callsign string
	// Filter for the type of aircraft to include in the BOGEY DOPE.
	Filter ContactCategory
}

type BogeyDopeResponse struct {
	// Callsign of the friendly aircraft requesting the BOGEY DOPE.
	Callsign string
	// Group which is closest to the fighter. If there are no eligible groups, this may be nil.
	Group Group
}

type Bullseye struct {
	// contains filtered or unexported fields
}

type ContactCategory int

type Declaration string

type DeclareRequest struct {
	// Callsign of the friendly aircraft requesting DECLARE.
	Callsign string
	// Location of the contact.
	Location Bullseye
	// Altitude of the contact above sea level, rounded to the nearest thousands of feet.
	Altitude unit.Length
	// Track direction. Optional, used to discriminate between multiple contacts at the same location.
	Track Track
}

type DeclareResponse struct {
	// Callsign of the friendly aircraft requesting DECLARE.
	Callsign string
	// Declaration of the contact.
	Declaration Declaration
	// Group that was identified, if a specific one was identifiable.
	// This may be nil if Declaration is Furball, Unable, or Clean.
	Group Group
}

type FadedCall struct {
	// Group which has faded.
	Group Group
}

type Group interface {
	// Threat indicates if the THREAT criteria is met.
	Threat() bool
	// Contacts is the number of contacts in the group.
	Contacts() int
	// Bullseye is the location of the group. This may be nil for BOGEY DOPE, SNAPLOCK, and THREAT calls.
	Bullseye() *Bullseye
	// Altitude is the group's altitude above sea level. This may be nil for BOGEY DOPE, SNAPLOCK, and THREAT calls.
	Altitude() unit.Length
	// Track is the group's track direction. This may be UnknownDirection for BOGEY DOPE, SNAPLOCK, and THREAT calls.
	Track() Track
	// Aspect is the group's aspect angle. This may be nil for BOGEY DOPE, SNAPLOCK, and some THREAT calls.
	Aspect() Aspect
	// BRAA is an alternate format for the group's location. This is nil except for BOGEY DOPE, SNAPLOCK, and some THREAT calls.
	BRAA() BRAA
	// Declaration of the group's friend or foe status.
	Declaration() Declaration
	// Heavy is true if the group contacts 3 or more contacts.
	Heavy() bool
	// Platform is the NATO reporting name of the group's aircraft platform (for Soviet/Russian/Chinese aircraft) or
	// an alternative name for other aircraft.
	Platform() string
	// High is true if the aircraft altitude is above 40,000 feet.
	High() bool
	// Fast is true if the group's speed is 600-900kts ground speed or 1.0-1.5 Mach.
	Fast() bool
	// VeryFast is true is the group's speed is above 900kts ground speed or 1.5 Mach.
	VeryFast() bool
}

type NegativeRadarContactResponse struct {
	Callsign string
}

type PictureRequest struct {
	// Callsign of the friendly aircraft requesting the PICTURE.
	Callsign string
	// Radius is the distance from the friendly aircraft to search for groups.
	// This is present to allow server admins to cap the scale of a PICTURE call, since some DCS servers are quite dense.
	Radius unit.Length
}

type PictureResponse struct {
	// Groups included in the PICTURE.
	Groups []Group
}

type RadioCheckRequest struct {
	// Callsign of the friendly aircraft requesting the RADIO CHECK.
	Callsign string
}

type RadioCheckResponse struct {
	// Callsign of the friendly aircraft requesting the RADIO CHECK.
	// If the callsign was misheard, this may not be the actual callsign of any actual aircraft.
	Callsign string
	// Status is true if the RADIO CHECK was correlated to an aircraft on frequency, otherwise false.
	// If this is false, the RADIO CHECK was received but not fully understood.
	Status bool
}

type SnaplockRequest struct {
	// Callsign of the friendly aircraft requesting the SNAPLOCK.
	Callsign string
	// BRA is the location of the contact.
	BRA BRA
}

type SnaplockResponse struct {
	// Callsign of the friendly aircraft requesting the SNAPLOCK.
	Callsign string
	// Status is true if the SNAPLOCK was correlated to a group, otherwise false.
	Status bool
	// Group that was identified. If Status is false, this may be nil.
	Group Group
}

type SpikedRequest struct {
	// Callsign of the friendly aircraft calling SPIKED.
	Callsign string
	// Bearing to the radar spike.
	Bearing unit.Angle
}

type SpikedResponse struct {
	// Callsign of the friendly aircraft calling SPIKED.
	Callsign string
	// True if the spike was correlated to a contact. False otherwise.
	Status bool
	// Range to the correlated contact. If Status is false, this may be nil.
	Range *unit.Length
	// Altitude of the correlated contact. If Status is false, this may be nil.
	Altitude *unit.Length
	// Aspect of the correlated contact. If Status is false, this may be UnknownAspect.
	Aspect Aspect
	// Declaration of the correlated contact. If Status is false, this may be Clean.
	Declaration Declaration
	// Number of contacts in the correlated group. If Status is false, this may be zero.
	Contacts int
	// Reported spike bearing. This is used if the response did not correlate to a group.
	Bearing unit.Angle
}

type SunriseCall struct {
	// Frequency which the GCI is listening on.
	Frequency unit.Frequency
}

type ThreatCall struct {
	// Callsign of the friendly aircraft under threat.
	Callsign string
	// Group that is threatening the friendly aircraft.
	Group Group
}

type Track string