Documentation
¶
Index ¶
- Constants
- Variables
- func CheckVideoMapManifest(filename string, e *util.ErrorLogger)
- func IsValidACID(acid string) bool
- func PlausibleFinalAltitude(fp av.FlightPlan, perf av.AircraftPerformance, nmPerLongitude float32, ...) int
- func PrintVideoMaps(path string, e *util.ErrorLogger)
- type ACID
- type Aircraft
- func (ac *Aircraft) ATPAVolume() *av.ATPAVolume
- func (ac *Aircraft) AircraftPerformance() av.AircraftPerformance
- func (ac *Aircraft) Altitude() float32
- func (ac *Aircraft) AltitudeOurDiscretion() *av.RadioTransmission
- func (ac *Aircraft) ArrivalAirportElevation() float32
- func (ac *Aircraft) ArrivalAirportLocation() math.Point2LL
- func (ac *Aircraft) AssignAltitude(altitude int, afterSpeed bool) *av.RadioTransmission
- func (ac *Aircraft) AssignHeading(heading int, turn nav.TurnMethod) *av.RadioTransmission
- func (ac *Aircraft) AssignSpeed(speed int, afterAltitude bool) *av.RadioTransmission
- func (ac *Aircraft) AssociateFlightPlan(fp *NASFlightPlan)
- func (ac *Aircraft) AtFixCleared(fix, approach string) *av.RadioTransmission
- func (ac *Aircraft) CWT() string
- func (ac *Aircraft) CancelApproachClearance() *av.RadioTransmission
- func (ac *Aircraft) Check(lg *log.Logger)
- func (ac *Aircraft) ClearedApproach(id string, lg *log.Logger) (*av.RadioTransmission, error)
- func (ac *Aircraft) ClearedStraightInApproach(id string, lg *log.Logger) (*av.RadioTransmission, error)
- func (ac *Aircraft) ClimbViaSID() *av.RadioTransmission
- func (ac *Aircraft) ContactMessage(reportingPoints []av.ReportingPoint) *av.RadioTransmission
- func (ac *Aircraft) ContactTower(lg *log.Logger) *av.RadioTransmission
- func (ac *Aircraft) CrossFixAt(fix string, ar *av.AltitudeRestriction, speed int) *av.RadioTransmission
- func (ac *Aircraft) DepartFixDirect(fixa, fixb string) *av.RadioTransmission
- func (ac *Aircraft) DepartFixHeading(fix string, hdg int) *av.RadioTransmission
- func (ac *Aircraft) DepartOnCourse(lg *log.Logger)
- func (ac *Aircraft) DepartureAirportElevation() float32
- func (ac *Aircraft) DepartureAirportLocation() math.Point2LL
- func (ac *Aircraft) DescendViaSTAR() *av.RadioTransmission
- func (ac *Aircraft) DirectFix(fix string) *av.RadioTransmission
- func (ac *Aircraft) DisassociateFlightPlan() *NASFlightPlan
- func (ac *Aircraft) DistanceAlongRoute(fix string) (float32, error)
- func (ac *Aircraft) DistanceToEndOfApproach() (float32, error)
- func (ac *Aircraft) DivertToAirport(ap string)
- func (ac *Aircraft) ExpectApproach(id string, ap *av.Airport, lg *log.Logger) *av.RadioTransmission
- func (ac *Aircraft) ExpediteClimb() *av.RadioTransmission
- func (ac *Aircraft) ExpediteDescent() *av.RadioTransmission
- func (ac *Aircraft) FlyPresentHeading() *av.RadioTransmission
- func (ac *Aircraft) GS() float32
- func (ac *Aircraft) GetRadarTrack(now time.Time) av.RadarTrack
- func (ac *Aircraft) GoAround() *av.RadioTransmission
- func (ac *Aircraft) Heading() float32
- func (ac *Aircraft) HoldAtFix(fix string, hold *av.Hold) *av.RadioTransmission
- func (ac *Aircraft) IAS() float32
- func (ac *Aircraft) Ident(now time.Time) *av.RadioTransmission
- func (ac *Aircraft) InitializeArrival(ap *av.Airport, arr *av.Arrival, nmPerLongitude float32, ...) error
- func (ac *Aircraft) InitializeDeparture(ap *av.Airport, departureAirport string, dep *av.Departure, runway string, ...) error
- func (ac *Aircraft) InitializeFlightPlan(r av.FlightRules, acType, dep, arr string)
- func (ac *Aircraft) InitializeOverflight(of *av.Overflight, nmPerLongitude float32, magneticVariation float32, ...) error
- func (ac *Aircraft) InitializeVFRDeparture(ap *av.Airport, wps av.WaypointArray, randomizeAltitudeRange bool, ...) error
- func (ac *Aircraft) InterceptApproach(lg *log.Logger) *av.RadioTransmission
- func (ac *Aircraft) IsAirborne() bool
- func (ac *Aircraft) IsArrival() bool
- func (ac *Aircraft) IsAssociated() bool
- func (ac *Aircraft) IsDeparture() bool
- func (ac *Aircraft) IsOverflight() bool
- func (ac *Aircraft) IsUnassociated() bool
- func (ac *Aircraft) MVAsApply() bool
- func (ac *Aircraft) MagneticVariation() float32
- func (ac *Aircraft) MaintainMaximumForward() *av.RadioTransmission
- func (ac *Aircraft) MaintainSlowestPractical() *av.RadioTransmission
- func (ac *Aircraft) NavSummary(model *wx.Model, simTime time.Time, lg *log.Logger) string
- func (ac *Aircraft) NmPerLongitude() float32
- func (ac *Aircraft) OnApproach(checkAltitude bool) bool
- func (ac *Aircraft) OnExtendedCenterline(maxNmDeviation float32) bool
- func (ac *Aircraft) PilotMixUp() *av.RadioTransmission
- func (ac *Aircraft) Position() math.Point2LL
- func (ac *Aircraft) ResumeOwnNavigation() *av.RadioTransmission
- func (ac *Aircraft) RouteIncludesFix(fix string) bool
- func (ac *Aircraft) SayAltitude() *av.RadioTransmission
- func (ac *Aircraft) SayHeading() *av.RadioTransmission
- func (ac *Aircraft) SaySpeed() *av.RadioTransmission
- func (ac *Aircraft) TAS() float32
- func (ac *Aircraft) TurnLeft(deg int) *av.RadioTransmission
- func (ac *Aircraft) TurnRight(deg int) *av.RadioTransmission
- func (ac *Aircraft) Update(model *wx.Model, simTime time.Time, bravo *av.AirspaceGrid, lg *log.Logger) *av.Waypoint
- func (ac *Aircraft) Waypoints() []av.Waypoint
- func (ac *Aircraft) WillDoAirwork() bool
- type AircraftDisplayState
- type AirspaceAwareness
- type ArrivalRunway
- type CIDAllocator
- type ControlCommandsResult
- type CoordinationList
- type DepartureAircraft
- type DepartureRunway
- type ERAMComputer
- type ERAMMap
- type ERAMMapGroup
- type ERAMMapGroups
- type Emergency
- type EmergencyApplicability
- type EmergencyStage
- type EmergencyState
- type Event
- type EventStream
- type EventSubscriberId
- type EventType
- type EventsSubscription
- type FacilityAdaptation
- type FilterRegion
- type FilterRegions
- type FlightPlanSpecifier
- type FutureChangeSquawk
- type FutureControllerContact
- type FutureEmergencyUpdate
- type FutureOnCourse
- type GlobalMessage
- type Handoff
- type HeadingArgs
- type LaunchConfig
- func (lc *LaunchConfig) CheckRateLimits(limit float32) bool
- func (lc *LaunchConfig) ClampRates(limit float32)
- func (lc *LaunchConfig) TotalArrivalRate() float32
- func (lc *LaunchConfig) TotalDepartureRate() float32
- func (lc *LaunchConfig) TotalInboundFlowRate() float32
- func (lc *LaunchConfig) TotalOverflightRate() float32
- type NASFlightPlan
- type NASFlightPlanType
- type NewSimConfiguration
- type PilotSpeech
- type PointOut
- type RedirectedHandoff
- type ReleaseDeparture
- type RunwayLaunchState
- type STARSComputer
- func (sc *STARSComputer) AddHeldDeparture(ac *Aircraft)
- func (sc *STARSComputer) CreateFlightPlan(fp NASFlightPlan) (NASFlightPlan, error)
- func (sc *STARSComputer) GetReleaseDepartures() []*Aircraft
- func (sc *STARSComputer) ReleaseDeparture(callsign av.ADSBCallsign) error
- func (sc *STARSComputer) Update(s *Sim)
- type STARSControllerConfig
- type SignificantPoint
- type Sim
- func (s *Sim) AcceptHandoff(tcp string, acid ACID) error
- func (s *Sim) AcceptRedirectedHandoff(tcp string, acid ACID) error
- func (s *Sim) AcknowledgePointOut(tcp string, acid ACID) error
- func (s *Sim) Activate(lg *log.Logger, ttsProvider TTSProvider, provider wx.Provider)
- func (s *Sim) ActivateFlightPlan(tcp string, callsign av.ADSBCallsign, acid ACID, spec *FlightPlanSpecifier) error
- func (s *Sim) ActiveControllers() []string
- func (s *Sim) AltitudeOurDiscretion(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) AssignAltitude(tcp string, callsign av.ADSBCallsign, altitude int, afterSpeed bool) error
- func (s *Sim) AssignHeading(hdg *HeadingArgs) error
- func (s *Sim) AssignSpeed(tcp string, callsign av.ADSBCallsign, speed int, afterAltitude bool) error
- func (s *Sim) AssociateFlightPlan(callsign av.ADSBCallsign, spec FlightPlanSpecifier) error
- func (s *Sim) AtFixCleared(tcp string, callsign av.ADSBCallsign, fix, approach string) error
- func (s *Sim) CallsignForACID(acid ACID) (av.ADSBCallsign, bool)
- func (s *Sim) CancelApproachClearance(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) CancelHandoff(tcp string, acid ACID) error
- func (s *Sim) ChangeControlPosition(fromTCP, toTCP string, keepTracks bool) error
- func (s *Sim) ChangeSquawk(tcp string, callsign av.ADSBCallsign, sq av.Squawk) error
- func (s *Sim) ChangeTransponderMode(tcp string, callsign av.ADSBCallsign, mode av.TransponderMode) error
- func (s *Sim) CheckLeaks()
- func (s *Sim) ClearedApproach(tcp string, callsign av.ADSBCallsign, approach string, straightIn bool) error
- func (s *Sim) ClimbViaSID(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) ContactController(tcp string, acid ACID, toTCP string) error
- func (s *Sim) ContactTower(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) ContactTrackingController(tcp string, acid ACID) error
- func (s *Sim) CreateArrival(arrivalGroup string, arrivalAirport string) (*Aircraft, error)
- func (s *Sim) CreateFlightPlan(tcp string, spec FlightPlanSpecifier) error
- func (s *Sim) CreateIFRDeparture(departureAirport, runway, category string) (*Aircraft, error)
- func (s *Sim) CreateOverflight(group string) (*Aircraft, error)
- func (s *Sim) CreateRestrictionArea(ra av.RestrictionArea) (int, error)
- func (s *Sim) CreateVFRDeparture(departureAirport string) (*Aircraft, error)
- func (s *Sim) CrossFixAt(tcp string, callsign av.ADSBCallsign, fix string, ar *av.AltitudeRestriction, ...) error
- func (s *Sim) DeleteAircraft(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) DeleteAircraftSlice(tcp string, aircraft []Aircraft) error
- func (s *Sim) DeleteAllAircraft(tcp string) error
- func (s *Sim) DeleteFlightPlan(tcp string, acid ACID) error
- func (s *Sim) DeleteRestrictionArea(idx int) error
- func (s *Sim) DepartFixDirect(tcp string, callsign av.ADSBCallsign, fixa string, fixb string) error
- func (s *Sim) DepartFixHeading(tcp string, callsign av.ADSBCallsign, fix string, heading int) error
- func (s *Sim) DescendViaSTAR(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) Destroy()
- func (s *Sim) DirectFix(tcp string, callsign av.ADSBCallsign, fix string) error
- func (s *Sim) ExpectApproach(tcp string, callsign av.ADSBCallsign, approach string) error
- func (s *Sim) ExpediteClimb(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) ExpediteDescent(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) FastForward(tcp string) error
- func (s *Sim) FlightPlanDirect(tcp, fix string, acid ACID) error
- func (s *Sim) ForceQL(tcp string, acid ACID, controller string) error
- func (s *Sim) GetAircraftDisplayState(callsign av.ADSBCallsign) (AircraftDisplayState, error)
- func (s *Sim) GetAvailableCoveredPositions() (map[string]av.Controller, map[string]av.Controller)
- func (s *Sim) GetControllerSpeech(tcp string) []PilotSpeech
- func (s *Sim) GetFlightPlanForACID(acid ACID) (*NASFlightPlan, *Aircraft, bool)
- func (s *Sim) GetSerializeSim() Sim
- func (s *Sim) GetStateUpdate(tcp string, update *StateUpdate)
- func (s *Sim) GlobalMessage(tcp, message string) error
- func (s *Sim) GoAround(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) HandoffTrack(tcp string, acid ACID, toTCP string) error
- func (s *Sim) HoldAtFix(tcp string, callsign av.ADSBCallsign, fix string, hold *av.Hold) error
- func (s *Sim) Ident(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) IdleTime() time.Duration
- func (s *Sim) InterceptLocalizer(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) LaunchAircraft(ac Aircraft, departureRunway string)
- func (s *Sim) LogValue() slog.Value
- func (s *Sim) MaintainMaximumForward(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) MaintainSlowestPractical(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) ModifyFlightPlan(tcp string, acid ACID, spec FlightPlanSpecifier) error
- func (s *Sim) PilotMixUp(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) PointOut(fromTCP string, acid ACID, toTCP string) error
- func (s *Sim) PostEvent(e Event)
- func (s *Sim) Prespawn()
- func (s *Sim) RadarServicesTerminated(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) RecallPointOut(tcp string, acid ACID) error
- func (s *Sim) RedirectHandoff(tcp string, acid ACID, controller string) error
- func (s *Sim) RejectPointOut(tcp string, acid ACID) error
- func (s *Sim) ReleaseDeparture(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) ReplayScenario(waypointCommands string, durationSpec string, lg *log.Logger) error
- func (s *Sim) RepositionTrack(tcp string, acid ACID, callsign av.ADSBCallsign, p math.Point2LL) error
- func (s *Sim) RequestFlightFollowing() error
- func (s *Sim) ResumeOwnNavigation(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) RunAircraftControlCommands(tcp string, callsign av.ADSBCallsign, commandStr string) ControlCommandsResult
- func (s *Sim) SayAltitude(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) SayHeading(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) SaySpeed(tcp string, callsign av.ADSBCallsign) error
- func (s *Sim) SendRouteCoordinates(tcp string, acid ACID) error
- func (s *Sim) SetLaunchConfig(tcp string, lc LaunchConfig) error
- func (s *Sim) SetSimRate(tcp string, rate float32) error
- func (s *Sim) SetWaypointCommands(tcp, commands string) error
- func (s *Sim) ShouldTriggerPilotMixUp(callsign av.ADSBCallsign) bool
- func (s *Sim) SignOff(tcp string) error
- func (s *Sim) SignOn(tcp string, instructor bool, disableTextToSpeech bool) (*State, error)
- func (s *Sim) Step(elapsed time.Duration) bool
- func (s *Sim) TakeOrReturnLaunchControl(tcp string) error
- func (s *Sim) TogglePause(tcp string) error
- func (s *Sim) TriggerEmergency(name string)
- func (s *Sim) Update()
- func (s *Sim) UpdateRestrictionArea(idx int, ra av.RestrictionArea) error
- type State
- func (ss *State) AreInstructorOrRPO(tcp string) bool
- func (ss *State) BeaconCodeInUse(sq av.Squawk) bool
- func (ss *State) FacilityFromController(callsign string) (string, bool)
- func (ss *State) FindMatchingFlightPlan(s string) *NASFlightPlan
- func (ss *State) GetAllReleaseDepartures() []ReleaseDeparture
- func (ss *State) GetConsolidatedPositions(id string) []string
- func (ss *State) GetFlightPlanForACID(acid ACID) *NASFlightPlan
- func (ss *State) GetInitialCenter() math.Point2LL
- func (ss *State) GetInitialRange() float32
- func (ss *State) GetOurTrackByACID(acid ACID) (*Track, bool)
- func (ss *State) GetOurTrackByCallsign(callsign av.ADSBCallsign) (*Track, bool)
- func (ss *State) GetRegularReleaseDepartures() []ReleaseDeparture
- func (ss *State) GetSTARSReleaseDepartures() []ReleaseDeparture
- func (ss *State) GetStateForController(tcp string) *State
- func (ss *State) GetTrackByACID(acid ACID) (*Track, bool)
- func (ss *State) GetTrackByCallsign(callsign av.ADSBCallsign) (*Track, bool)
- func (ss *State) GetTrackByFLID(flid string) (*Track, bool)
- func (ss *State) IsExternalController(tcp string) bool
- func (ss *State) IsLocalController(tcp string) bool
- func (ss *State) Locate(s string) (math.Point2LL, bool)
- func (ss *State) ResolveController(tcp string) string
- type StateUpdate
- type TTSProvider
- type TTSSpeechFuture
- type TTSVoicesFuture
- type Track
- type VideoMap
- type VideoMapLibrary
- type VideoMapManifest
- type Voice
Constants ¶
const ( LaunchAutomatic int32 = iota LaunchManual )
const UnsetSTARSListIndex = 0
Variables ¶
var ( ErrAircraftAlreadyReleased = errors.New("Aircraft already released") ErrBeaconMismatch = errors.New("Beacon code mismatch") ErrControllerAlreadySignedIn = errors.New("Controller with that callsign already signed in") ErrDuplicateACID = errors.New("Duplicate ACID") ErrDuplicateBeacon = errors.New("Duplicate beacon code") ErrIllegalACID = errors.New("Illegal ACID") ErrIllegalACType = errors.New("Illegal aircraft type") ErrIllegalBeaconCode = errors.New("Illegal beacon code") ErrIllegalFunction = errors.New("Illegal function") ErrIllegalScratchpad = errors.New("Illegal scratchpad") ErrInvalidAbbreviatedFP = errors.New("Invalid abbreviated flight plan") ErrInvalidDepartureController = errors.New("Invalid departure controller") ErrInvalidRestrictionAreaIndex = errors.New("Invalid restriction area index") ErrNoMatchingFlight = errors.New("No matching flight") ErrNoMatchingFlightPlan = errors.New("No matching flight plan") ErrNoVFRAircraftForFlightFollowing = errors.New("No VFR aircraft available for flight following") ErrNotLaunchController = errors.New("Not signed in as the launch controller") ErrTooManyRestrictionAreas = errors.New("Too many restriction areas specified") ErrTrackIsActive = errors.New("Track is already active") ErrTrackIsBeingHandedOff = errors.New("Track is currently being handed off") ErrTrackIsNotActive = errors.New("Track is not active") ErrUnknownAircraftType = errors.New("Unknown aircraft type") ErrUnknownController = errors.New("Unknown controller") ErrUnknownControllerFacility = errors.New("Unknown controller facility") ErrVFRSimTookTooLong = errors.New("VFR simulation took too long") ErrViolatedAirspace = errors.New("Violated B/C airspace") )
var ErrInvalidCommandSyntax = fmt.Errorf("invalid command syntax")
Functions ¶
func CheckVideoMapManifest ¶
func CheckVideoMapManifest(filename string, e *util.ErrorLogger)
func IsValidACID ¶
func PlausibleFinalAltitude ¶
func PlausibleFinalAltitude(fp av.FlightPlan, perf av.AircraftPerformance, nmPerLongitude float32, magneticVariation float32, r *rand.Rand) int
func PrintVideoMaps ¶
func PrintVideoMaps(path string, e *util.ErrorLogger)
Types ¶
type Aircraft ¶
type Aircraft struct {
// This is ADS-B callsign of the aircraft. Just because different the
// callsign in the flight plan can be different across multiple STARS
// facilities, so two different facilities can show different
// callsigns; however, the ADS-B callsign is transmitted from the
// aircraft and would be the same to all facilities.
ADSBCallsign av.ADSBCallsign
Squawk av.Squawk
Mode av.TransponderMode
IdentStartTime, IdentEndTime time.Time
FlightPlan av.FlightPlan
TypeOfFlight av.TypeOfFlight
// For departures, after we first see them in the departure acquisition
// volume, we set a time a bit in the future for the flight plan to
// actually acquire to simulate the delay in that.
DepartureFPAcquisitionTime time.Time
Strip av.FlightStrip
Nav nav.Nav
// Arrival-related state
STAR string
STARRunwayWaypoints map[string]av.WaypointArray
GotContactTower bool
NASFlightPlan *NASFlightPlan
HoldForRelease bool
Released bool // only used for hold for release
ReleaseTime time.Time
WaitingForLaunch bool // for departures
MissingFlightPlan bool
GoAroundDistance *float32
// Departure related state
DepartureContactAltitude float32
// The controller who gave approach clearance
ApproachController string
// Who had control when the fp disassociated due to an arrival filter.
PreArrivalDropController string
FirstSeen time.Time
RequestedFlightFollowing bool
Voice Voice
EmergencyState *EmergencyState
LastRadioTransmission time.Time
}
func (*Aircraft) ATPAVolume ¶
func (ac *Aircraft) ATPAVolume() *av.ATPAVolume
func (*Aircraft) AircraftPerformance ¶
func (ac *Aircraft) AircraftPerformance() av.AircraftPerformance
func (*Aircraft) AltitudeOurDiscretion ¶
func (ac *Aircraft) AltitudeOurDiscretion() *av.RadioTransmission
func (*Aircraft) ArrivalAirportElevation ¶
func (*Aircraft) ArrivalAirportLocation ¶
func (*Aircraft) AssignAltitude ¶
func (ac *Aircraft) AssignAltitude(altitude int, afterSpeed bool) *av.RadioTransmission
func (*Aircraft) AssignHeading ¶
func (ac *Aircraft) AssignHeading(heading int, turn nav.TurnMethod) *av.RadioTransmission
func (*Aircraft) AssignSpeed ¶
func (ac *Aircraft) AssignSpeed(speed int, afterAltitude bool) *av.RadioTransmission
func (*Aircraft) AssociateFlightPlan ¶
func (ac *Aircraft) AssociateFlightPlan(fp *NASFlightPlan)
func (*Aircraft) AtFixCleared ¶
func (ac *Aircraft) AtFixCleared(fix, approach string) *av.RadioTransmission
func (*Aircraft) CancelApproachClearance ¶
func (ac *Aircraft) CancelApproachClearance() *av.RadioTransmission
func (*Aircraft) ClearedApproach ¶
func (*Aircraft) ClearedStraightInApproach ¶
func (*Aircraft) ClimbViaSID ¶
func (ac *Aircraft) ClimbViaSID() *av.RadioTransmission
func (*Aircraft) ContactMessage ¶
func (ac *Aircraft) ContactMessage(reportingPoints []av.ReportingPoint) *av.RadioTransmission
func (*Aircraft) ContactTower ¶
func (ac *Aircraft) ContactTower(lg *log.Logger) *av.RadioTransmission
func (*Aircraft) CrossFixAt ¶
func (ac *Aircraft) CrossFixAt(fix string, ar *av.AltitudeRestriction, speed int) *av.RadioTransmission
func (*Aircraft) DepartFixDirect ¶
func (ac *Aircraft) DepartFixDirect(fixa, fixb string) *av.RadioTransmission
func (*Aircraft) DepartFixHeading ¶
func (ac *Aircraft) DepartFixHeading(fix string, hdg int) *av.RadioTransmission
func (*Aircraft) DepartOnCourse ¶
func (*Aircraft) DepartureAirportElevation ¶
func (*Aircraft) DepartureAirportLocation ¶
func (*Aircraft) DescendViaSTAR ¶
func (ac *Aircraft) DescendViaSTAR() *av.RadioTransmission
func (*Aircraft) DisassociateFlightPlan ¶
func (ac *Aircraft) DisassociateFlightPlan() *NASFlightPlan
func (*Aircraft) DistanceAlongRoute ¶
func (*Aircraft) DistanceToEndOfApproach ¶
func (*Aircraft) DivertToAirport ¶ added in v0.13.2
func (*Aircraft) ExpectApproach ¶
func (*Aircraft) ExpediteClimb ¶
func (ac *Aircraft) ExpediteClimb() *av.RadioTransmission
func (*Aircraft) ExpediteDescent ¶
func (ac *Aircraft) ExpediteDescent() *av.RadioTransmission
func (*Aircraft) FlyPresentHeading ¶
func (ac *Aircraft) FlyPresentHeading() *av.RadioTransmission
func (*Aircraft) GetRadarTrack ¶
func (ac *Aircraft) GetRadarTrack(now time.Time) av.RadarTrack
func (*Aircraft) GoAround ¶
func (ac *Aircraft) GoAround() *av.RadioTransmission
func (*Aircraft) InitializeArrival ¶
func (*Aircraft) InitializeDeparture ¶
func (*Aircraft) InitializeFlightPlan ¶
func (ac *Aircraft) InitializeFlightPlan(r av.FlightRules, acType, dep, arr string)
func (*Aircraft) InitializeOverflight ¶
func (*Aircraft) InitializeVFRDeparture ¶
func (*Aircraft) InterceptApproach ¶
func (ac *Aircraft) InterceptApproach(lg *log.Logger) *av.RadioTransmission
func (*Aircraft) IsAirborne ¶
func (*Aircraft) IsAssociated ¶
func (*Aircraft) IsDeparture ¶
func (*Aircraft) IsOverflight ¶
func (*Aircraft) IsUnassociated ¶
func (*Aircraft) MagneticVariation ¶
func (*Aircraft) MaintainMaximumForward ¶
func (ac *Aircraft) MaintainMaximumForward() *av.RadioTransmission
func (*Aircraft) MaintainSlowestPractical ¶
func (ac *Aircraft) MaintainSlowestPractical() *av.RadioTransmission
func (*Aircraft) NavSummary ¶
func (*Aircraft) NmPerLongitude ¶
func (*Aircraft) OnApproach ¶
func (*Aircraft) OnExtendedCenterline ¶
func (*Aircraft) PilotMixUp ¶ added in v0.13.2
func (ac *Aircraft) PilotMixUp() *av.RadioTransmission
func (*Aircraft) ResumeOwnNavigation ¶
func (ac *Aircraft) ResumeOwnNavigation() *av.RadioTransmission
func (*Aircraft) RouteIncludesFix ¶
func (*Aircraft) SayAltitude ¶
func (ac *Aircraft) SayAltitude() *av.RadioTransmission
func (*Aircraft) SayHeading ¶
func (ac *Aircraft) SayHeading() *av.RadioTransmission
func (*Aircraft) SaySpeed ¶
func (ac *Aircraft) SaySpeed() *av.RadioTransmission
func (*Aircraft) WillDoAirwork ¶
type AircraftDisplayState ¶
type AirspaceAwareness ¶
type ArrivalRunway ¶
type CIDAllocator ¶ added in v0.13.0
type CIDAllocator struct {
List [7]map[string]interface{}
}
CIDAllocator manages allocation of unique three-character CIDs.
func NewCIDAllocator ¶ added in v0.13.0
func NewCIDAllocator() *CIDAllocator
func (*CIDAllocator) Allocate ¶ added in v0.13.0
func (c *CIDAllocator) Allocate() (string, error)
Allocate returns the next Available CID.
func (*CIDAllocator) Release ¶ added in v0.13.0
func (c *CIDAllocator) Release(cid string)
Release frees a CID so it can be reused.
type ControlCommandsResult ¶ added in v0.13.0
type CoordinationList ¶
type DepartureAircraft ¶
type DepartureAircraft struct {
ADSBCallsign av.ADSBCallsign
MinSeparation time.Duration // How long after takeoff it will be at ~6000' and airborne
SpawnTime time.Time // when it was first spawned
LaunchTime time.Time // when it was actually launched; used for wake turbulence separation, etc.
// When they're ready to leave the gate
ReadyDepartGateTime time.Time
// HFR-only.
ReleaseRequested bool
ReleaseDelay time.Duration // minimum wait after release before the takeoff roll
RequestReleaseTime time.Time
}
DepartureAircraft represents a departing aircraft, either still on the ground or recently-launched.
type DepartureRunway ¶
type ERAMComputer ¶
type ERAMComputer struct {
SquawkCodePool *av.EnrouteSquawkCodePool
Identifier string
Adaptation av.ERAMAdaptation
}
func (*ERAMComputer) CreateSquawk ¶
func (ec *ERAMComputer) CreateSquawk() (av.Squawk, error)
func (*ERAMComputer) ReturnSquawk ¶
func (ec *ERAMComputer) ReturnSquawk(code av.Squawk) error
func (*ERAMComputer) Update ¶
func (ec *ERAMComputer) Update(s *Sim)
type ERAMMapGroup ¶ added in v0.13.0
type ERAMMapGroups ¶ added in v0.13.0
type ERAMMapGroups map[string]ERAMMapGroup
type Emergency ¶ added in v0.13.2
type Emergency struct {
Name string `json:"name"`
ApplicableToString string `json:"applicable_to"`
ApplicableTo EmergencyApplicability
Weight float32 `json:"weight"`
Stages []EmergencyStage `json:"stages"`
}
func LoadEmergencies ¶ added in v0.13.2
func LoadEmergencies(e *util.ErrorLogger) []Emergency
LoadEmergencies loads all emergency types from the emergencies.json resource file. Any errors encountered during loading are reported via the ErrorLogger.
type EmergencyApplicability ¶ added in v0.13.2
type EmergencyApplicability int
const ( EmergencyApplicabilityDeparture EmergencyApplicability = 1 << iota EmergencyApplicabilityArrival EmergencyApplicabilityExternal EmergencyApplicabilityApproach )
func (EmergencyApplicability) Applies ¶ added in v0.13.2
func (ea EmergencyApplicability) Applies(ac *Aircraft, humanController bool) bool
Returns weight for this emergency type given the aircraft. Returns 0 if not applicable.
func (EmergencyApplicability) String ¶ added in v0.13.2
func (ea EmergencyApplicability) String() string
type EmergencyStage ¶ added in v0.13.2
type EmergencyStage struct {
Transmission string `json:"transmission"`
DurationMinutes [2]int `json:"duration_minutes"`
RequestReturn bool `json:"request_return"`
StopClimb bool `json:"stop_climb"`
RequestDelayVectors bool `json:"request_delay_vectors"`
DeclareEmergency bool `json:"declare_emergency"`
}
EmergencyStage represents a stage in an emergency's progression.
type EmergencyState ¶ added in v0.13.2
EmergencyState tracks the current state of an aircraft's emergency.
type Event ¶
type Event struct {
Type EventType
ADSBCallsign av.ADSBCallsign
ACID ACID
FromController string
ToController string // For radio transmissions, the controlling controller.
WrittenText string
SpokenText string
RadioTransmissionType av.RadioTransmissionType // For radio transmissions only
LeaderLineDirection *math.CardinalOrdinalDirection // SetGlobalLeaderLineEvent
WaypointInfo []math.Point2LL
}
type EventStream ¶
type EventStream struct {
// contains filtered or unexported fields
}
EventStream provides a basic pub/sub event interface that allows any part of the system to post an event to the stream and other parts to subscribe and receive messages from the stream. It is the backbone for communicating events, world updates, and user actions across the various parts of the system.
func NewEventStream ¶
func NewEventStream(lg *log.Logger) *EventStream
func (*EventStream) Destroy ¶
func (e *EventStream) Destroy()
func (*EventStream) LogValue ¶
func (e *EventStream) LogValue() slog.Value
implements slog.LogValuer
func (*EventStream) Post ¶
func (e *EventStream) Post(event Event)
Post adds an event to the event stream. The type used to encode the event is arbitrary; it's up to the EventStream users to establish conventions.
func (*EventStream) Subscribe ¶
func (e *EventStream) Subscribe() *EventsSubscription
Subscribe registers a new subscriber to the stream and returns an EventSubscriberId for the subscriber that can then be passed to other EventStream methods.
type EventSubscriberId ¶
type EventSubscriberId int
type EventType ¶
type EventType int
const ( PushedFlightStripEvent EventType = iota PointOutEvent OfferedHandoffEvent AcceptedHandoffEvent AcceptedRedirectedHandoffEvent CanceledHandoffEvent RejectedHandoffEvent RadioTransmissionEvent StatusMessageEvent ServerBroadcastMessageEvent GlobalMessageEvent AcknowledgedPointOutEvent RejectedPointOutEvent HandoffControlEvent SetGlobalLeaderLineEvent ForceQLEvent TransferAcceptedEvent TransferRejectedEvent RecalledPointOutEvent FlightPlanAssociatedEvent FixCoordinatesEvent NumEventTypes )
type EventsSubscription ¶
type EventsSubscription struct {
// contains filtered or unexported fields
}
func (*EventsSubscription) Get ¶
func (e *EventsSubscription) Get() []Event
Get returns all of the events from the stream since the last time Get was called with the given id. Note that events before an id was created with Subscribe are never reported for that id.
func (*EventsSubscription) LogValue ¶
func (e *EventsSubscription) LogValue() slog.Value
func (*EventsSubscription) PostEvent ¶
func (e *EventsSubscription) PostEvent(event Event)
func (*EventsSubscription) Unsubscribe ¶
func (e *EventsSubscription) Unsubscribe()
Unsubscribe removes a subscriber from the subscriber list
type FacilityAdaptation ¶ added in v0.13.0
type FacilityAdaptation struct {
AirspaceAwareness []AirspaceAwareness `json:"airspace_awareness" scope:"stars"`
ForceQLToSelf bool `json:"force_ql_self" scope:"stars"`
AllowLongScratchpad bool `json:"allow_long_scratchpad" scope:"stars"`
VideoMapNames []string `json:"stars_maps" scope:"stars"`
ERAMMapNames map[string][]string `json:"eram_maps" scope:"eram"`
VideoMapLabels map[string]string `json:"map_labels"`
ControllerConfigs map[string]*STARSControllerConfig `json:"controller_configs"`
RadarSites map[string]*av.RadarSite `json:"radar_sites" scope:"stars"`
Center math.Point2LL `json:"-"`
CenterString string `json:"center"`
Range float32 `json:"range"`
Scratchpads map[string]string `json:"scratchpads" scope:"stars"`
SignificantPoints map[string]SignificantPoint `json:"significant_points" scope:"stars"`
Altimeters []string `json:"altimeters"`
// Airpsace filters
Filters struct {
AutoAcquisition FilterRegions `json:"auto_acquisition"`
ArrivalDrop FilterRegions `json:"arrival_drop"`
Departure FilterRegions `json:"departure"`
InhibitCA FilterRegions `json:"inhibit_ca"`
InhibitMSAW FilterRegions `json:"inhibit_msaw"`
Quicklook FilterRegions `json:"quicklook"`
SecondaryDrop FilterRegions `json:"secondary_drop"`
SurfaceTracking FilterRegions `json:"surface_tracking"`
VFRInhibit FilterRegions `json:"vfr_inhibit"`
} `json:"filters" scope:"stars"` //Should this be STARS or justy parts of it?
MonitoredBeaconCodeBlocksString *string
MonitoredBeaconCodeBlocks []av.Squawk
UntrackedPositionSymbolOverrides struct {
CodeRangesString string `json:"beacon_codes"`
CodeRanges [][2]av.Squawk // inclusive
Symbol string `json:"symbol"`
} `json:"untracked_position_symbol_overrides" scope:"stars"`
VideoMapFile string `json:"video_map_file"`
CoordinationFixes map[string]av.AdaptationFixes `json:"coordination_fixes" scope:"stars"`
SingleCharAIDs map[string]string `json:"single_char_aids" scope:"stars"` // Char to airport. TODO: Check if this is for ERAM as well.
KeepLDB bool `json:"keep_ldb" scope:"stars"`
FullLDBSeconds int `json:"full_ldb_seconds" scope:"stars"`
SSRCodes av.LocalSquawkCodePoolSpecifier `json:"ssr_codes" scope:"stars"`
HandoffAcceptFlashDuration int `json:"handoff_acceptance_flash_duration" scope:"stars"`
DisplayHOFacilityOnly bool `json:"display_handoff_facility_only" scope:"stars"`
HOSectorDisplayDuration int `json:"handoff_sector_display_duration" scope:"stars"`
AirportCodes map[string]string `json:"airport_codes" scope:"eram"`
FlightPlan struct {
QuickACID string `json:"quick_acid"`
ACIDExpansions map[string]string `json:"acid_expansions"`
ModifyAfterDisplay bool `json:"modify_after_display"`
} `json:"flight_plan" scope:"stars"`
PDB struct {
ShowScratchpad2 bool `json:"show_scratchpad2"`
HideGroundspeed bool `json:"hide_gs"`
ShowAircraftType bool `json:"show_aircraft_type"`
SplitGSAndCWT bool `json:"split_gs_and_cwt"`
DisplayCustomSPCs bool `json:"display_custom_spcs"`
} `json:"pdb" scope:"stars"`
FDB struct {
DisplayRequestedAltitude bool `json:"display_requested_altitude"`
Scratchpad2OnLine3 bool `json:"scratchpad2_on_line3"`
} `json:"fdb" scope:"stars"`
Scratchpad1 struct {
DisplayExitFix bool `json:"display_exit_fix"`
DisplayExitFix1 bool `json:"display_exit_fix_1"`
DisplayExitGate bool `json:"display_exit_gate"`
DisplayAltExitGate bool `json:"display_alternate_exit_gate"`
} `json:"scratchpad1" scope:"stars"`
CustomSPCs []string `json:"custom_spcs"`
CoordinationLists []CoordinationList `json:"coordination_lists" scope:"stars"`
VFRList struct {
Format string `json:"format"`
} `json:"vfr_list" scope:"stars"`
TABList struct {
Format string `json:"format"`
} `json:"tab_list" scope:"stars"`
CoastSuspendList struct {
Format string `json:"format"`
} `json:"coast_suspend_list" scope:"stars"`
MCISuppressionList struct {
Format string `json:"format"`
} `json:"mci_suppression_list" scope:"stars"`
TowerList struct {
Format string `json:"format"`
} `json:"tower_list" scope:"stars"`
RestrictionAreas []av.RestrictionArea `json:"restriction_areas" scope:"stars"`
UseLegacyFont bool `json:"use_legacy_font" scope:"stars"`
}
func (FacilityAdaptation) CheckScratchpad ¶ added in v0.13.0
func (fa FacilityAdaptation) CheckScratchpad(sp string) bool
func (*FacilityAdaptation) PostDeserialize ¶ added in v0.13.0
func (fa *FacilityAdaptation) PostDeserialize(loc av.Locator, controlledAirports []string, allAirports []string, e *util.ErrorLogger)
type FilterRegion ¶
type FilterRegion struct {
av.AirspaceVolume
InvertTest bool
}
type FilterRegions ¶
type FilterRegions []FilterRegion
func (FilterRegions) HaveId ¶
func (r FilterRegions) HaveId(s string) bool
type FlightPlanSpecifier ¶ added in v0.13.0
type FlightPlanSpecifier struct {
ACID util.Optional[ACID]
EntryFix util.Optional[string]
ExitFix util.Optional[string]
ExitFixIsIntermediate util.Optional[bool]
Rules util.Optional[av.FlightRules]
CoordinationTime util.Optional[time.Time]
PlanType util.Optional[NASFlightPlanType]
SquawkAssignment util.Optional[string]
ImplicitSquawkAssignment util.Optional[av.Squawk] // only used when taking the track's current code
TrackingController util.Optional[string]
AircraftCount util.Optional[int]
AircraftType util.Optional[string]
EquipmentSuffix util.Optional[string]
TypeOfFlight util.Optional[av.TypeOfFlight]
AssignedAltitude util.Optional[int]
InterimAlt util.Optional[int]
InterimType util.Optional[string]
AltitudeBlock util.Optional[[2]int]
ControllerReportedAlt util.Optional[int]
VFROTP util.Optional[bool]
RequestedAltitude util.Optional[int]
PilotReportedAltitude util.Optional[int]
Scratchpad util.Optional[string]
SecondaryScratchpad util.Optional[string]
RNAV util.Optional[bool]
RNAVToggle util.Optional[bool]
Location util.Optional[math.Point2LL]
PointOutHistory util.Optional[[]string]
InhibitModeCAltitudeDisplay util.Optional[bool]
SPCOverride util.Optional[string]
DisableMSAW util.Optional[bool]
DisableCA util.Optional[bool]
MCISuppressedCode util.Optional[av.Squawk]
GlobalLeaderLineDirection util.Optional[*math.CardinalOrdinalDirection]
QuickFlightPlan util.Optional[bool]
HoldState util.Optional[bool]
Suspended util.Optional[bool]
CoastSuspendIndex util.Optional[int]
InhibitACTypeDisplay util.Optional[bool]
ForceACTypeDisplayEndTime util.Optional[time.Time]
}
func (FlightPlanSpecifier) GetFlightPlan ¶ added in v0.13.0
func (s FlightPlanSpecifier) GetFlightPlan(localPool *av.LocalSquawkCodePool, nasPool *av.EnrouteSquawkCodePool) (NASFlightPlan, error)
type FutureChangeSquawk ¶
type FutureChangeSquawk struct {
ADSBCallsign av.ADSBCallsign
Code av.Squawk
Mode av.TransponderMode
Time time.Time
}
type FutureControllerContact ¶
type FutureControllerContact struct {
ADSBCallsign av.ADSBCallsign
TCP string
Time time.Time
}
type FutureEmergencyUpdate ¶ added in v0.13.2
type FutureEmergencyUpdate struct {
ADSBCallsign av.ADSBCallsign
Time time.Time
}
FutureEmergencyUpdate represents a scheduled emergency progression update.
type FutureOnCourse ¶
type FutureOnCourse struct {
ADSBCallsign av.ADSBCallsign
Time time.Time
}
type GlobalMessage ¶
type HeadingArgs ¶
type HeadingArgs struct {
TCP string
ADSBCallsign av.ADSBCallsign
Heading int
Present bool
LeftDegrees int
RightDegrees int
Turn nav.TurnMethod
}
type LaunchConfig ¶
type LaunchConfig struct {
// Controller is the controller in charge of the launch settings; if empty then
// launch control may be taken by any signed in controller.
Controller string
// LaunchManual or LaunchAutomatic
Mode int32
GoAroundRate float32
// airport -> runway -> category -> rate
DepartureRates map[string]map[string]map[string]float32
DepartureRateScale float32
VFRDepartureRateScale float32
VFRAirportRates map[string]int // name -> VFRRateSum()
VFFRequestRate int32
HaveVFRReportingRegions bool
// inbound flow -> airport / "overflights" -> rate
InboundFlowRates map[string]map[string]float32
InboundFlowRateScale float32
ArrivalPushes bool
ArrivalPushFrequencyMinutes int
ArrivalPushLengthMinutes int
EmergencyAircraftRate float32 // Aircraft per hour
}
LaunchConfig collects settings related to launching aircraft in the sim; it's passed back and forth between client and server: server provides them so client can draw the UI for what's available, then client returns one back when launching.
func MakeLaunchConfig ¶
func MakeLaunchConfig(dep []DepartureRunway, vfrRateScale float32, vfrAirports map[string]*av.Airport, inbound map[string]map[string]int, haveVFRReportingRegions bool) LaunchConfig
func (*LaunchConfig) CheckRateLimits ¶
func (lc *LaunchConfig) CheckRateLimits(limit float32) bool
CheckRateLimits returns true if both total departure rates and total inbound flow rates sum to less than the provided limit (aircraft per hour)
func (*LaunchConfig) ClampRates ¶
func (lc *LaunchConfig) ClampRates(limit float32)
ClampRates adjusts the rate scale variables to ensure the total launch rate does not exceed the given limit (aircraft per hour)
func (*LaunchConfig) TotalArrivalRate ¶
func (lc *LaunchConfig) TotalArrivalRate() float32
TotalArrivalRate returns the total arrival rate (aircraft per hour) excluding overflights
func (*LaunchConfig) TotalDepartureRate ¶
func (lc *LaunchConfig) TotalDepartureRate() float32
TotalDepartureRate returns the total departure rate (aircraft per hour) for all airports and runways
func (*LaunchConfig) TotalInboundFlowRate ¶
func (lc *LaunchConfig) TotalInboundFlowRate() float32
TotalInboundFlowRate returns the total inbound flow rate (aircraft per hour) for all flows
func (*LaunchConfig) TotalOverflightRate ¶
func (lc *LaunchConfig) TotalOverflightRate() float32
TotalOverflightRate returns the total overflight rate (aircraft per hour)
type NASFlightPlan ¶ added in v0.13.0
type NASFlightPlan struct {
ACID ACID
CID string
EntryFix string
ExitFix string
ArrivalAirport string // Technically not a string, but until the NAS system is fully integrated, we'll need this.
ExitFixIsIntermediate bool
Rules av.FlightRules
CoordinationTime time.Time
PlanType NASFlightPlanType
AssignedSquawk av.Squawk
TrackingController string // Who has the radar track
ControllingController string // Who has control; not necessarily the same as TrackingController
HandoffTrackController string // Handoff offered but not yet accepted
LastLocalController string // (May be the current controller.)
AircraftCount int
AircraftType string
EquipmentSuffix string
TypeOfFlight av.TypeOfFlight
AssignedAltitude int
PerceivedAssigned int // what the previous controller would put into the hard alt, even though the aircraft is descending via a STAR.
InterimAlt int
InterimType int
AltitudeBlock [2]int
ControllerReportedAlt int
VFROTP bool
RequestedAltitude int
PilotReportedAltitude int
Scratchpad string
SecondaryScratchpad string
PriorScratchpad string
PriorSecondaryScratchpad string
RNAV bool
Location math.Point2LL
Route string
PointOutHistory []string
InhibitModeCAltitudeDisplay bool
SPCOverride string
DisableMSAW bool
DisableCA bool
MCISuppressedCode av.Squawk
GlobalLeaderLineDirection *math.CardinalOrdinalDirection
QuickFlightPlan bool
HoldState bool
Suspended bool
CoastSuspendIndex int
// FIXME: the following are all used internally by NAS code. It's
// convenient to have them here but this stuff should just be managed
// internally there.
ListIndex int
// First controller in the local facility to get the track: used both
// for /ho and for departures
InboundHandoffController string
CoordinationFix string
ContainedFacilities []string
RedirectedHandoff RedirectedHandoff
InhibitACTypeDisplay bool
ForceACTypeDisplayEndTime time.Time
CWTCategory string
// After fps are dropped, we hold on to them for a bit before they're
// actually deleted.
DeleteTime time.Time
// Used so that such FPs can associate regardless of acquisition filters.
ManuallyCreated bool
}
func (*NASFlightPlan) Update ¶ added in v0.13.0
func (fp *NASFlightPlan) Update(spec FlightPlanSpecifier, localPool *av.LocalSquawkCodePool, nasPool *av.EnrouteSquawkCodePool) (err error)
type NASFlightPlanType ¶ added in v0.13.0
type NASFlightPlanType int
const ( UnknownFlightPlanType NASFlightPlanType = iota // Flight plan received from a NAS ARTCC. This is a flight plan that // has been sent over by an overlying ERAM facility. RemoteEnroute // Flight plan received from an adjacent terminal facility This is a // flight plan that has been sent over by another STARS facility. RemoteNonEnroute // VFR interfacility flight plan entered locally for which the NAS // ARTCC has not returned a flight plan This is a flight plan that is // made by a STARS facility that gets a NAS code. LocalEnroute // Flight plan entered by TCW or flight plan from an adjacent terminal // that has been handed off to this STARS facility This is a flight // plan that is made at a STARS facility and gets a local code. LocalNonEnroute )
Flight plan types (STARS)
type NewSimConfiguration ¶
type NewSimConfiguration struct {
TRACON string
Description string
Airports map[string]*av.Airport
PrimaryAirport string
DepartureRunways []DepartureRunway
ArrivalRunways []ArrivalRunway
InboundFlows map[string]*av.InboundFlow
LaunchConfig LaunchConfig
Fixes map[string]math.Point2LL
VFRReportingPoints []av.VFRReportingPoint
ControlPositions map[string]*av.Controller
PrimaryController string
ControllerAirspace map[string][]string
VirtualControllers []string
MultiControllers av.SplitConfiguration
SignOnPositions map[string]*av.Controller
TFRs []av.TFR
FacilityAdaptation FacilityAdaptation
IsLocal bool
EnforceUniqueCallsignSuffix bool
ReportingPoints []av.ReportingPoint
MagneticVariation float32
NmPerLongitude float32
StartTime time.Time
WindSpecifier *wx.WindSpecifier
Center math.Point2LL
Range float32
DefaultMaps []string
DefaultMapGroup string
Airspace av.Airspace
PilotErrorInterval float32
TTSProvider TTSProvider
WXProvider wx.Provider
Emergencies []Emergency
}
NewSimConfiguration collects all of the information required to create a new Sim
type PilotSpeech ¶
type PilotSpeech struct {
Callsign av.ADSBCallsign
Type av.RadioTransmissionType
Text string
MP3 []byte
}
type RedirectedHandoff ¶
type RedirectedHandoff struct {
OriginalOwner string // Controller callsign
Redirector []string // Controller callsign
RedirectedTo string // Controller callsign
}
func (*RedirectedHandoff) AddRedirector ¶
func (rd *RedirectedHandoff) AddRedirector(ctrl *av.Controller)
func (*RedirectedHandoff) GetLastRedirector ¶
func (rd *RedirectedHandoff) GetLastRedirector() string
func (*RedirectedHandoff) ShouldFallbackToHandoff ¶
func (rd *RedirectedHandoff) ShouldFallbackToHandoff(ctrl, octrl string) bool
func (*RedirectedHandoff) ShowRDIndicator ¶
func (rd *RedirectedHandoff) ShowRDIndicator(callsign string, RDIndicatorEnd time.Time) bool
type ReleaseDeparture ¶
type RunwayLaunchState ¶
type RunwayLaunchState struct {
IFRSpawnRate float32
VFRSpawnRate float32
// For each runway, when to create the next departing aircraft, based
// on the runway departure rate. The actual time an aircraft is
// launched may be later, e.g. if we need longer for wake turbulence
// separation, etc.
NextIFRSpawn time.Time
NextVFRSpawn time.Time
// At the gate, flight plan filed (if IFR), not yet ready to go
Gate []DepartureAircraft
// Ready to go, in hold for release purgatory.
Held []DepartureAircraft
// Ready to go.
ReleasedIFR []DepartureAircraft
ReleasedVFR []DepartureAircraft
// Sequenced departures, pulled from Released. These are launched in-order.
Sequenced []DepartureAircraft
LastDeparture *DepartureAircraft
LastArrivalLandingTime time.Time // when the last arrival landed on this runway
LastArrivalFlightRules av.FlightRules // flight rules of the last arrival that landed
VFRAttempts int
VFRSuccesses int
}
type STARSComputer ¶
type STARSComputer struct {
Identifier string
FlightPlans []*NASFlightPlan
HoldForRelease []*Aircraft
AvailableIndices []int
}
func (*STARSComputer) AddHeldDeparture ¶
func (sc *STARSComputer) AddHeldDeparture(ac *Aircraft)
func (*STARSComputer) CreateFlightPlan ¶
func (sc *STARSComputer) CreateFlightPlan(fp NASFlightPlan) (NASFlightPlan, error)
func (*STARSComputer) GetReleaseDepartures ¶
func (sc *STARSComputer) GetReleaseDepartures() []*Aircraft
func (*STARSComputer) ReleaseDeparture ¶
func (sc *STARSComputer) ReleaseDeparture(callsign av.ADSBCallsign) error
func (*STARSComputer) Update ¶
func (sc *STARSComputer) Update(s *Sim)
type STARSControllerConfig ¶
type STARSControllerConfig struct {
VideoMapNames []string `json:"video_maps"`
DefaultMaps []string `json:"default_maps"`
Center math.Point2LL `json:"-"`
CenterString string `json:"center"`
Range float32 `json:"range"`
MonitoredBeaconCodeBlocksString *string `json:"beacon_code_blocks"`
MonitoredBeaconCodeBlocks []av.Squawk
FlightFollowingAirspace []av.AirspaceVolume `json:"flight_following_airspace"`
}
type SignificantPoint ¶
type Sim ¶
type Sim struct {
State *State
Aircraft map[av.ADSBCallsign]*Aircraft
SignOnPositions map[string]*av.Controller
STARSComputer *STARSComputer
ERAMComputer *ERAMComputer
LocalCodePool *av.LocalSquawkCodePool
CIDAllocator *CIDAllocator
GenerationIndex int // for sequencing StateUpdates
VFRReportingPoints []av.VFRReportingPoint
METAR map[string][]wx.METAR
// Airport -> runway -> state
DepartureState map[string]map[string]*RunwayLaunchState
// Key is inbound flow group name
NextInboundSpawn map[string]time.Time
NextVFFRequest time.Time
Handoffs map[ACID]Handoff
PointOuts map[ACID]PointOut
ReportingPoints []av.ReportingPoint
EnforceUniqueCallsignSuffix bool
FutureControllerContacts []FutureControllerContact
FutureOnCourse []FutureOnCourse
FutureSquawkChanges []FutureChangeSquawk
FutureEmergencyUpdates []FutureEmergencyUpdate
NextEmergencyTime time.Time
PilotErrorInterval time.Duration
LastPilotError time.Time
NextPushStart time.Time // both w.r.t. sim time
PushEnd time.Time
Instructors map[string]bool
Rand *rand.Rand
SquawkWarnedACIDs map[ACID]interface{} // Warn once in CheckLeaks(); don't spam the logs
// contains filtered or unexported fields
}
func NewSim ¶
func NewSim(config NewSimConfiguration, manifest *VideoMapManifest, lg *log.Logger) *Sim
func (*Sim) AcceptRedirectedHandoff ¶
func (*Sim) ActivateFlightPlan ¶
func (s *Sim) ActivateFlightPlan(tcp string, callsign av.ADSBCallsign, acid ACID, spec *FlightPlanSpecifier) error
Flight plan for acid must already exist; spec gives optional amendments.
func (*Sim) ActiveControllers ¶
func (*Sim) AltitudeOurDiscretion ¶
func (s *Sim) AltitudeOurDiscretion(tcp string, callsign av.ADSBCallsign) error
func (*Sim) AssignAltitude ¶
func (*Sim) AssignHeading ¶
func (s *Sim) AssignHeading(hdg *HeadingArgs) error
func (*Sim) AssignSpeed ¶
func (*Sim) AssociateFlightPlan ¶
func (s *Sim) AssociateFlightPlan(callsign av.ADSBCallsign, spec FlightPlanSpecifier) error
Associate the specified flight plan with the track. Flight plan for ACID must not already exist.
func (*Sim) AtFixCleared ¶
func (*Sim) CallsignForACID ¶
func (s *Sim) CallsignForACID(acid ACID) (av.ADSBCallsign, bool)
func (*Sim) CancelApproachClearance ¶
func (s *Sim) CancelApproachClearance(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ChangeControlPosition ¶
func (*Sim) ChangeSquawk ¶
func (*Sim) ChangeTransponderMode ¶
func (s *Sim) ChangeTransponderMode(tcp string, callsign av.ADSBCallsign, mode av.TransponderMode) error
func (*Sim) CheckLeaks ¶
func (s *Sim) CheckLeaks()
Make sure we're not leaking beacon codes or list indices.
func (*Sim) ClearedApproach ¶
func (*Sim) ClimbViaSID ¶
func (s *Sim) ClimbViaSID(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ContactController ¶
func (*Sim) ContactTower ¶
func (s *Sim) ContactTower(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ContactTrackingController ¶
func (*Sim) CreateArrival ¶
func (*Sim) CreateFlightPlan ¶
func (s *Sim) CreateFlightPlan(tcp string, spec FlightPlanSpecifier) error
func (*Sim) CreateIFRDeparture ¶
func (*Sim) CreateRestrictionArea ¶
func (s *Sim) CreateRestrictionArea(ra av.RestrictionArea) (int, error)
func (*Sim) CreateVFRDeparture ¶
Note that this may fail without an error if it's having trouble finding a route.
func (*Sim) CrossFixAt ¶
func (s *Sim) CrossFixAt(tcp string, callsign av.ADSBCallsign, fix string, ar *av.AltitudeRestriction, speed int) error
func (*Sim) DeleteAircraft ¶
func (s *Sim) DeleteAircraft(tcp string, callsign av.ADSBCallsign) error
func (*Sim) DeleteAircraftSlice ¶
func (*Sim) DeleteAllAircraft ¶
func (*Sim) DeleteRestrictionArea ¶
func (*Sim) DepartFixDirect ¶
func (*Sim) DepartFixHeading ¶
func (*Sim) DescendViaSTAR ¶
func (s *Sim) DescendViaSTAR(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ExpectApproach ¶
func (*Sim) ExpediteClimb ¶
func (s *Sim) ExpediteClimb(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ExpediteDescent ¶
func (s *Sim) ExpediteDescent(tcp string, callsign av.ADSBCallsign) error
func (*Sim) FastForward ¶
func (*Sim) FlightPlanDirect ¶ added in v0.13.0
TODO: Migrate to ERAM computer.
func (*Sim) GetAircraftDisplayState ¶
func (s *Sim) GetAircraftDisplayState(callsign av.ADSBCallsign) (AircraftDisplayState, error)
func (*Sim) GetAvailableCoveredPositions ¶
func (s *Sim) GetAvailableCoveredPositions() (map[string]av.Controller, map[string]av.Controller)
func (*Sim) GetControllerSpeech ¶
func (s *Sim) GetControllerSpeech(tcp string) []PilotSpeech
func (*Sim) GetFlightPlanForACID ¶
func (s *Sim) GetFlightPlanForACID(acid ACID) (*NASFlightPlan, *Aircraft, bool)
*Aircraft may be nil. bool indicates whether the flight plan is active.
func (*Sim) GetSerializeSim ¶
func (*Sim) GetStateUpdate ¶
func (s *Sim) GetStateUpdate(tcp string, update *StateUpdate)
func (*Sim) GlobalMessage ¶
func (*Sim) InterceptLocalizer ¶
func (s *Sim) InterceptLocalizer(tcp string, callsign av.ADSBCallsign) error
func (*Sim) LaunchAircraft ¶
func (*Sim) MaintainMaximumForward ¶
func (s *Sim) MaintainMaximumForward(tcp string, callsign av.ADSBCallsign) error
func (*Sim) MaintainSlowestPractical ¶
func (s *Sim) MaintainSlowestPractical(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ModifyFlightPlan ¶
func (s *Sim) ModifyFlightPlan(tcp string, acid ACID, spec FlightPlanSpecifier) error
func (*Sim) PilotMixUp ¶ added in v0.13.2
func (s *Sim) PilotMixUp(tcp string, callsign av.ADSBCallsign) error
func (*Sim) RadarServicesTerminated ¶
func (s *Sim) RadarServicesTerminated(tcp string, callsign av.ADSBCallsign) error
func (*Sim) RedirectHandoff ¶
func (*Sim) ReleaseDeparture ¶
func (s *Sim) ReleaseDeparture(tcp string, callsign av.ADSBCallsign) error
func (*Sim) ReplayScenario ¶ added in v0.13.0
func (*Sim) RepositionTrack ¶
func (*Sim) RequestFlightFollowing ¶
func (*Sim) ResumeOwnNavigation ¶
func (s *Sim) ResumeOwnNavigation(tcp string, callsign av.ADSBCallsign) error
func (*Sim) RunAircraftControlCommands ¶ added in v0.13.0
func (s *Sim) RunAircraftControlCommands(tcp string, callsign av.ADSBCallsign, commandStr string) ControlCommandsResult
RunAircraftControlCommands executes a space-separated string of control commands for an aircraft. Returns the remaining unparsed input and any error that occurred. This is the core command execution logic shared by the dispatcher and automated test code.
func (*Sim) SayAltitude ¶
func (s *Sim) SayAltitude(tcp string, callsign av.ADSBCallsign) error
func (*Sim) SayHeading ¶
func (s *Sim) SayHeading(tcp string, callsign av.ADSBCallsign) error
func (*Sim) SendRouteCoordinates ¶ added in v0.13.0
TODO: Migrate to ERAM computer.
func (*Sim) SetLaunchConfig ¶
func (s *Sim) SetLaunchConfig(tcp string, lc LaunchConfig) error
func (*Sim) SetWaypointCommands ¶ added in v0.13.0
func (*Sim) ShouldTriggerPilotMixUp ¶ added in v0.13.2
func (s *Sim) ShouldTriggerPilotMixUp(callsign av.ADSBCallsign) bool
func (*Sim) Step ¶
Step advances the simulation by the given elapsed time duration. This method encapsulates the core simulation stepping logic that was previously inline in Update().
func (*Sim) TakeOrReturnLaunchControl ¶
func (*Sim) TogglePause ¶
func (*Sim) TriggerEmergency ¶ added in v0.13.2
func (*Sim) UpdateRestrictionArea ¶
func (s *Sim) UpdateRestrictionArea(idx int, ra av.RestrictionArea) error
type State ¶
type State struct {
Tracks map[av.ADSBCallsign]*Track
// Unassociated ones, including unsupported DBs
UnassociatedFlightPlans []*NASFlightPlan
ACFlightPlans map[av.ADSBCallsign]av.FlightPlan // needed for flight strips...
Airports map[string]*av.Airport
DepartureAirports map[string]interface{}
ArrivalAirports map[string]interface{}
Fixes map[string]math.Point2LL
VFRRunways map[string]av.Runway // assume just one runway per airport
ReleaseDepartures []ReleaseDeparture
// Signed in human controllers + virtual controllers
Controllers map[string]*av.Controller
HumanControllers []string
PrimaryController string
MultiControllers av.SplitConfiguration
UserTCP string
Airspace map[string]map[string][]av.ControllerAirspaceVolume // ctrl id -> vol name -> definition
GenerationIndex int
DepartureRunways []DepartureRunway
ArrivalRunways []ArrivalRunway
InboundFlows map[string]*av.InboundFlow
LaunchConfig LaunchConfig
Emergencies []Emergency
Center math.Point2LL
Range float32
ScenarioDefaultVideoMaps []string
ScenarioDefaultVideoGroup string
UserRestrictionAreas []av.RestrictionArea
FacilityAdaptation FacilityAdaptation
TRACON string
MagneticVariation float32
NmPerLongitude float32
PrimaryAirport string
METAR map[string]wx.METAR
TotalIFR, TotalVFR int
Paused bool
SimRate float32
SimDescription string
SimTime time.Time // this is our fake time--accounting for pauses & simRate..
QuickFlightPlanIndex int // for auto ACIDs for quick ACID flight plan 5-145
Instructors map[string]bool
VideoMapLibraryHash []byte
// Set in State returned by GetStateForController
ControllerVideoMaps []string
ControllerDefaultVideoMaps []string
ControllerMonitoredBeaconCodeBlocks []av.Squawk
RadioTransmissions [][]byte
}
State serves two purposes: first, the Sim object holds one to organize assorted information about the world state that it updates as part of the simulation. Second, an instance of it is given to clients when they join a sim. As the sim runs, the client's State is updated roughly once a second. Clients can then use the State as a read-only reference for assorted information they may need (the state of aircraft in the sim, etc.)
func (*State) AreInstructorOrRPO ¶
func (*State) FacilityFromController ¶
func (*State) FindMatchingFlightPlan ¶
func (ss *State) FindMatchingFlightPlan(s string) *NASFlightPlan
func (*State) GetAllReleaseDepartures ¶
func (ss *State) GetAllReleaseDepartures() []ReleaseDeparture
func (*State) GetConsolidatedPositions ¶
func (*State) GetFlightPlanForACID ¶
func (ss *State) GetFlightPlanForACID(acid ACID) *NASFlightPlan
FOOTGUN: this should not be called from server-side code, since Tracks isn't initialized there. FIXME FIXME FIXME
func (*State) GetInitialCenter ¶
func (*State) GetInitialRange ¶
func (*State) GetOurTrackByCallsign ¶
func (ss *State) GetOurTrackByCallsign(callsign av.ADSBCallsign) (*Track, bool)
func (*State) GetRegularReleaseDepartures ¶
func (ss *State) GetRegularReleaseDepartures() []ReleaseDeparture
func (*State) GetSTARSReleaseDepartures ¶
func (ss *State) GetSTARSReleaseDepartures() []ReleaseDeparture
func (*State) GetStateForController ¶
func (*State) GetTrackByCallsign ¶
func (ss *State) GetTrackByCallsign(callsign av.ADSBCallsign) (*Track, bool)
func (*State) GetTrackByFLID ¶ added in v0.13.0
func (*State) IsExternalController ¶
func (*State) IsLocalController ¶
func (*State) ResolveController ¶
type StateUpdate ¶
type StateUpdate struct {
GenerationIndex int
Tracks map[av.ADSBCallsign]*Track
UnassociatedFlightPlans []*NASFlightPlan
ACFlightPlans map[av.ADSBCallsign]av.FlightPlan
ReleaseDepartures []ReleaseDeparture
Controllers map[string]*av.Controller
HumanControllers []string
Time time.Time
METAR map[string]wx.METAR
LaunchConfig LaunchConfig
UserRestrictionAreas []av.RestrictionArea
SimIsPaused bool
SimRate float32
TotalIFR, TotalVFR int
Events []Event
QuickFlightPlanIndex int
}
func (*StateUpdate) Apply ¶
func (su *StateUpdate) Apply(state *State, eventStream *EventStream)
type TTSProvider ¶
type TTSProvider interface {
GetAllVoices() TTSVoicesFuture
TextToSpeech(voice Voice, text string) TTSSpeechFuture
}
type TTSSpeechFuture ¶
type TTSVoicesFuture ¶
type Track ¶
type Track struct {
av.RadarTrack
FlightPlan *NASFlightPlan
// Sort of hacky to carry these along here but it's convenient...
DepartureAirport string
DepartureAirportElevation float32
DepartureAirportLocation math.Point2LL
ArrivalAirport string
ArrivalAirportElevation float32
ArrivalAirportLocation math.Point2LL
OnExtendedCenterline bool
OnApproach bool
ATPAVolume *av.ATPAVolume
MVAsApply bool
HoldForRelease bool
MissingFlightPlan bool
Route []math.Point2LL
IsTentative bool // first 5 seconds after first contact
}
func (*Track) HandingOffTo ¶
func (*Track) IsAssociated ¶
func (*Track) IsDeparture ¶
func (*Track) IsOverflight ¶
func (*Track) IsUnassociated ¶
func (*Track) IsUnsupportedDB ¶
type VideoMap ¶
type VideoMap struct {
Label string // for DCB
Group int // 0 -> A, 1 -> B
Name string // For maps system list
Id int
Category int
Restriction struct {
Id int
Text [2]string
TextBlink bool
HideText bool
}
Color int
Lines [][]math.Point2LL
}
Note: this should match ViceMapSpec/VideoMap in crc2vice/dat2vice. (crc2vice doesn't support all of these, though.)
type VideoMapLibrary ¶
type VideoMapLibrary struct {
Maps []VideoMap
ERAMMapGroups ERAMMapGroups
}
This should match VideoMapLibrary in dat2vice
func HashCheckLoadVideoMap ¶
func HashCheckLoadVideoMap(path string, wantHash []byte) (*VideoMapLibrary, error)
Loads the specified video map file, though only if its hash matches the provided hash. Returns an error otherwise.
func LoadVideoMapLibrary ¶
func LoadVideoMapLibrary(path string) (*VideoMapLibrary, error)
type VideoMapManifest ¶
type VideoMapManifest struct {
// contains filtered or unexported fields
}
VideoMapManifest stores which maps are available in a video map file and is also able to provide the video map file's hash.
func LoadVideoMapManifest ¶
func LoadVideoMapManifest(filename string) (*VideoMapManifest, error)
func (VideoMapManifest) HasMap ¶
func (v VideoMapManifest) HasMap(s string) bool
func (VideoMapManifest) HasMapGroup ¶ added in v0.13.0
func (v VideoMapManifest) HasMapGroup(s string) bool
func (VideoMapManifest) Hash ¶
func (v VideoMapManifest) Hash() ([]byte, error)
Hash returns a hash of the underlying video map file (i.e., not the manifest!)