1 // bfi.hxx - Big Flat Interface
3 // Written by David Megginson, started February, 2000.
5 // Copyright (C) 2000 David Megginson - david@megginson.com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <simgear/compiler.h>
28 FG_USING_NAMESPACE(std);
34 * This class implements the Facade design pattern (GOF p.185) to provide
35 * a single, (deceptively) simple flat interface for the FlightGear
38 * To help cut down on interdependence, subsystems should
39 * use the BFI whenever possible for inter-system communication.
42 * - add selectors to switch the current plane, throttle, brake, etc.
43 * - add more autopilot settings
49 // Initialize before first use.
52 // Reinit if necessary.
53 static void update ();
56 static int getFlightModel ();
57 static const string getAircraft ();
58 static const string getAircraftDir ();
59 static time_t getTimeGMT ();
60 static const string &getGMTString ();
61 static bool getHUDVisible ();
62 static bool getPanelVisible ();
64 static void setFlightModel (int flightModel);
65 static void setAircraft (const string &aircraft);
66 static void setAircraftDir (const string &aircraftDir);
67 static void setTimeGMT (time_t time);
68 static void setHUDVisible (bool hudVisible);
69 static void setPanelVisible (bool panelVisible);
73 static double getLatitude ();
74 static double getLongitude ();
75 static double getAltitude ();
76 static double getAGL ();
78 static void setLatitude (double latitude);
79 static void setLongitude (double longitude);
80 static void setAltitude (double altitude);
84 static double getHeading (); // true heading
85 static double getHeadingMag (); // exact magnetic heading
86 static double getPitch ();
87 static double getRoll ();
89 static void setHeading (double heading);
90 static void setPitch (double pitch);
91 static void setRoll (double roll);
94 static double getRPM ();
95 static void setRPM ( double rpm );
98 static double getAirspeed ();
99 static double getSideSlip ();
100 static double getVerticalSpeed ();
101 static double getSpeedNorth ();
102 static double getSpeedEast ();
103 static double getSpeedDown ();
105 static void setSpeedNorth (double speed);
106 static void setSpeedEast (double speed);
107 static void setSpeedDown (double speed);
111 static double getThrottle ();
112 static double getFlaps ();
113 static double getAileron ();
114 static double getRudder ();
115 static double getElevator ();
116 static double getElevatorTrim ();
117 static double getBrakes ();
118 static double getLeftBrake ();
119 static double getRightBrake ();
120 static double getCenterBrake ();
122 static void setThrottle (double throttle);
123 static void setFlaps (double flaps);
124 static void setAileron (double aileron);
125 static void setRudder (double rudder);
126 static void setElevator (double elevator);
127 static void setElevatorTrim (double trim);
128 static void setBrakes (double brake);
129 static void setLeftBrake (double brake);
130 static void setRightBrake (double brake);
131 static void setCenterBrake (double brake);
135 static bool getAPAltitudeLock ();
136 static double getAPAltitude ();
137 static bool getAPHeadingLock ();
138 static double getAPHeading ();
139 static double getAPHeadingMag ();
141 static void setAPAltitudeLock (bool lock);
142 static void setAPAltitude (double altitude);
143 static void setAPHeadingLock (bool lock);
144 static void setAPHeading (double heading);
145 static void setAPHeadingMag (double heading);
147 static bool getAPNAV1Lock ();
148 static void setAPNAV1Lock (bool lock);
151 static double getNAV1Freq ();
152 static double getNAV1AltFreq ();
153 static double getNAV1Radial ();
154 static double getNAV1SelRadial ();
155 static double getNAV1DistDME ();
156 static bool getNAV1TO ();
157 static bool getNAV1FROM ();
158 static bool getNAV1InRange ();
159 static bool getNAV1DMEInRange ();
161 static double getNAV2Freq ();
162 static double getNAV2AltFreq ();
163 static double getNAV2Radial ();
164 static double getNAV2SelRadial ();
165 static double getNAV2DistDME ();
166 static bool getNAV2TO ();
167 static bool getNAV2FROM ();
168 static bool getNAV2InRange ();
169 static bool getNAV2DMEInRange ();
171 static double getADFFreq ();
172 static double getADFAltFreq ();
173 static double getADFRotation ();
175 static void setNAV1Freq (double freq);
176 static void setNAV1AltFreq (double freq);
177 static void setNAV1SelRadial (double radial);
179 static void setNAV2Freq (double freq);
180 static void setNAV2AltFreq (double freq);
181 static void setNAV2SelRadial (double radial);
183 static void setADFFreq (double freq);
184 static void setADFAltFreq (double freq);
185 static void setADFRotation (double rot);
188 static const string getTargetAirport ();
189 static bool getGPSLock ();
190 static double getGPSTargetLatitude ();
191 static double getGPSTargetLongitude ();
193 static void setTargetAirport (const string &targetAirport);
194 static void setGPSLock (bool lock);
195 static void setGPSTargetLatitude (double latitude);
196 static void setGPSTargetLongitude (double longitude);
200 static double getVisibility ();
201 static bool getClouds ();
202 static double getCloudsASL ();
204 static void setVisibility (double visiblity);
205 static void setClouds (bool clouds);
206 static void setCloudsASL (double cloudsASL);
209 // Time (this varies with time) huh, huh
210 static double getMagVar ();
211 static double getMagDip ();
215 // Will cause a linking error if invoked.
218 static void reinit ();
219 static void needReinit () { _needReinit = true; }
220 static bool _needReinit;