fly/flightgear
1
0
Fork 0
Code Activity

If it's a struct, it's not a class

Browse source
This commit is contained in:
fredb 2006-04-18 21:24:38 +00:00
parent e354b810fa
commit 47de74a10b
1 changed files with 233 additions and 233 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

466
src/ATC/AILocalTraffic.hxx
View file

@ -1,233 +1,233 @@
// FGAILocalTraffic - AIEntity derived class with enough logic to // FGAILocalTraffic - AIEntity derived class with enough logic to
// fly and interact with the traffic pattern. // fly and interact with the traffic pattern.
// //
// Written by David Luff, started March 2002. // Written by David Luff, started March 2002.
// //
// Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk // Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk
// //
// This program is free software; you can redistribute it and/or // This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as // modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the // published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version. // License, or (at your option) any later version.
// //
// This program is distributed in the hope that it will be useful, but // This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of // WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details. // General Public License for more details.
// //
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software // along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef _FG_AILocalTraffic_HXX #ifndef _FG_AILocalTraffic_HXX
#define _FG_AILocalTraffic_HXX #define _FG_AILocalTraffic_HXX
#include <simgear/math/point3d.hxx> #include <simgear/math/point3d.hxx>
#include <Main/fg_props.hxx> #include <Main/fg_props.hxx>
#include "AIPlane.hxx" #include "AIPlane.hxx"
#include "ATCProjection.hxx" #include "ATCProjection.hxx"
#include "ground.hxx" #include "ground.hxx"
class FGGround; class FGGround;
class FGTower; class FGTower;
class Gate; struct Gate;
#include <string> #include <string>
SG_USING_STD(string); SG_USING_STD(string);
enum TaxiState { enum TaxiState {
TD_INBOUND, TD_INBOUND,
TD_OUTBOUND, TD_OUTBOUND,
TD_NONE, TD_NONE,
TD_LINING_UP TD_LINING_UP
}; };
enum OperatingState { enum OperatingState {
IN_PATTERN, IN_PATTERN,
TAXIING, TAXIING,
PARKED, PARKED,
EN_ROUTE EN_ROUTE
}; };
struct StartOfDescent { struct StartOfDescent {
PatternLeg leg; PatternLeg leg;
double x; // Runway aligned orthopos double x; // Runway aligned orthopos
double y; // ditto double y; // ditto
}; };
class FGAILocalTraffic : public FGAIPlane { class FGAILocalTraffic : public FGAIPlane {
public: public:
// At the moment we expect the expanded short form callsign - eventually we will just want the reg + type. // At the moment we expect the expanded short form callsign - eventually we will just want the reg + type.
FGAILocalTraffic(); FGAILocalTraffic();
~FGAILocalTraffic(); ~FGAILocalTraffic();
// Initialise // Initialise
bool Init(const string& callsign, const string& ICAO, OperatingState initialState = PARKED, PatternLeg initialLeg = DOWNWIND); bool Init(const string& callsign, const string& ICAO, OperatingState initialState = PARKED, PatternLeg initialLeg = DOWNWIND);
// Run the internal calculations // Run the internal calculations
void Update(double dt); void Update(double dt);
// Go out and practice circuits // Go out and practice circuits
void FlyCircuits(int numCircuits, bool tag); void FlyCircuits(int numCircuits, bool tag);
// Return what type of landing we're doing on this circuit // Return what type of landing we're doing on this circuit
LandingType GetLandingOption(); LandingType GetLandingOption();
// TODO - this will get more complex and moved into the main class // TODO - this will get more complex and moved into the main class
// body eventually since the position approved to taxi to will have // body eventually since the position approved to taxi to will have
// to be passed. // to be passed.
inline void ApproveTaxiRequest() {taxiRequestCleared = true;} inline void ApproveTaxiRequest() {taxiRequestCleared = true;}
inline void DenyTaxiRequest() {taxiRequestCleared = false;} inline void DenyTaxiRequest() {taxiRequestCleared = false;}
void RegisterTransmission(int code); void RegisterTransmission(int code);
// Process callbacks sent by base class // Process callbacks sent by base class
// (These codes are not related to the codes above) // (These codes are not related to the codes above)
void ProcessCallback(int code); void ProcessCallback(int code);
// This is a hack and will probably go eventually // This is a hack and will probably go eventually
inline bool AtHoldShort() {return holdingShort;} inline bool AtHoldShort() {return holdingShort;}
protected: protected:
// Attempt to enter the traffic pattern in a reasonably intelligent manner // Attempt to enter the traffic pattern in a reasonably intelligent manner
void EnterTrafficPattern(double dt); void EnterTrafficPattern(double dt);
// Set up the internal state to be consistent for a downwind entry. // Set up the internal state to be consistent for a downwind entry.
void DownwindEntry(); void DownwindEntry();
// Ditto for straight-in // Ditto for straight-in
void StraightInEntry(bool des = false); void StraightInEntry(bool des = false);
// Do what is necessary to land and parkup at home airport // Do what is necessary to land and parkup at home airport
void ReturnToBase(double dt); void ReturnToBase(double dt);
// Airport/runway/pattern details // Airport/runway/pattern details
string airportID; // The ICAO code of the airport that we're operating around string airportID; // The ICAO code of the airport that we're operating around
double aptElev; // Airport elevation double aptElev; // Airport elevation
FGGround* ground; // A pointer to the ground control. FGGround* ground; // A pointer to the ground control.
FGTower* tower; // A pointer to the tower control. FGTower* tower; // A pointer to the tower control.
bool _controlled; // Set true if we find tower control working for the airport, false otherwise. bool _controlled; // Set true if we find tower control working for the airport, false otherwise.
RunwayDetails rwy; RunwayDetails rwy;
double patternDirection; // 1 for right, -1 for left (This is double because we multiply/divide turn rates double patternDirection; // 1 for right, -1 for left (This is double because we multiply/divide turn rates
// with it to get RH/LH turns - DON'T convert it to int under ANY circumstances!! // with it to get RH/LH turns - DON'T convert it to int under ANY circumstances!!
double glideAngle; // Assumed to be visual glidepath angle for FGAILocalTraffic - can be found at www.airnav.com double glideAngle; // Assumed to be visual glidepath angle for FGAILocalTraffic - can be found at www.airnav.com
// Its conceivable that patternDirection and glidePath could be moved into the RunwayDetails structure. // Its conceivable that patternDirection and glidePath could be moved into the RunwayDetails structure.
// Its possible that this might be moved out to the ground/airport class at some point. // Its possible that this might be moved out to the ground/airport class at some point.
FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the threshold at the origin FGATCAlignedProjection ortho; // Orthogonal mapping of the local area with the threshold at the origin
// and the runway aligned with the y axis. // and the runway aligned with the y axis.
void GetAirportDetails(const string& id); void GetAirportDetails(const string& id);
void GetRwyDetails(const string& id); void GetRwyDetails(const string& id);
double responseCounter; // timer in seconds to allow response to requests to be a little while after them double responseCounter; // timer in seconds to allow response to requests to be a little while after them
// Will almost certainly get moved to FGAIPlane. // Will almost certainly get moved to FGAIPlane.
private: private:
FGATCMgr* ATC; FGATCMgr* ATC;
// This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code! // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
// High-level stuff // High-level stuff
OperatingState operatingState; OperatingState operatingState;
int circuitsToFly; //Number of circuits still to do in this session NOT INCLUDING THE CURRENT ONE int circuitsToFly; //Number of circuits still to do in this session NOT INCLUDING THE CURRENT ONE
bool touchAndGo; //True if circuits should be flown touch and go, false for full stop bool touchAndGo; //True if circuits should be flown touch and go, false for full stop
bool transmitted; // Set true when a position report for the current leg has been transmitted. bool transmitted; // Set true when a position report for the current leg has been transmitted.
// Performance characteristics of the plane in knots and ft/min - some of this might get moved out into FGAIPlane // Performance characteristics of the plane in knots and ft/min - some of this might get moved out into FGAIPlane
double Vr; double Vr;
double best_rate_of_climb_speed; double best_rate_of_climb_speed;
double best_rate_of_climb; double best_rate_of_climb;
double nominal_climb_speed; double nominal_climb_speed;
double nominal_climb_rate; double nominal_climb_rate;
double nominal_circuit_speed; double nominal_circuit_speed;
double min_circuit_speed; double min_circuit_speed;
double max_circuit_speed; double max_circuit_speed;
double nominal_descent_rate; double nominal_descent_rate;
double nominal_approach_speed; double nominal_approach_speed;
double nominal_final_speed; double nominal_final_speed;
double stall_speed_landing_config; double stall_speed_landing_config;
double nominal_taxi_speed; double nominal_taxi_speed;
// Physical/rendering stuff // Physical/rendering stuff
double wheelOffset; // Height above ground at which we need to render the plane whilst taxiing double wheelOffset; // Height above ground at which we need to render the plane whilst taxiing
bool elevInitGood; // We have had at least one good elev reading bool elevInitGood; // We have had at least one good elev reading
bool inAir; // True when off the ground bool inAir; // True when off the ground
// environment - some of this might get moved into FGAIPlane // environment - some of this might get moved into FGAIPlane
SGPropertyNode* wind_from_hdg; //degrees SGPropertyNode* wind_from_hdg; //degrees
SGPropertyNode* wind_speed_knots; //knots SGPropertyNode* wind_speed_knots; //knots
// Pattern details that (may) change // Pattern details that (may) change
int numInPattern; // Number of planes in the pattern (this might get more complicated if high performance GA aircraft fly a higher pattern eventually) int numInPattern; // Number of planes in the pattern (this might get more complicated if high performance GA aircraft fly a higher pattern eventually)
int numAhead; // More importantly - how many of them are ahead of us? int numAhead; // More importantly - how many of them are ahead of us?
double distToNext; // And even more importantly, how near are we getting to the one immediately ahead? double distToNext; // And even more importantly, how near are we getting to the one immediately ahead?
//PatternLeg leg; // Our current position in the pattern - now moved to FGAIPlane //PatternLeg leg; // Our current position in the pattern - now moved to FGAIPlane
StartOfDescent SoD; // Start of descent calculated wrt wind, pattern size & altitude, glideslope etc StartOfDescent SoD; // Start of descent calculated wrt wind, pattern size & altitude, glideslope etc
bool descending; // We're in the coming down phase of the pattern bool descending; // We're in the coming down phase of the pattern
double targetDescentRate; // m/s double targetDescentRate; // m/s
// Taxiing details // Taxiing details
// At the moment this assumes that all taxiing in is to gates (a loose term that includes // At the moment this assumes that all taxiing in is to gates (a loose term that includes
// any permitted parking spot) and that all taxiing out is to runways. // any permitted parking spot) and that all taxiing out is to runways.
bool parked; bool parked;
bool taxiing; bool taxiing;
bool taxiRequestPending; bool taxiRequestPending;
bool taxiRequestCleared; bool taxiRequestCleared;
TaxiState taxiState; TaxiState taxiState;
double desiredTaxiHeading; double desiredTaxiHeading;
double taxiTurnRadius; double taxiTurnRadius;
double nominalTaxiSpeed; double nominalTaxiSpeed;
Gate* ourGate; Gate* ourGate;
ground_network_path_type path; // a path through the ground network for the plane to taxi ground_network_path_type path; // a path through the ground network for the plane to taxi
unsigned int taxiPathPos; // position of iterator in taxi path when applicable unsigned int taxiPathPos; // position of iterator in taxi path when applicable
node* nextTaxiNode; // next node in taxi path node* nextTaxiNode; // next node in taxi path
node* holdShortNode; node* holdShortNode;
//Runway out_dest; //FIXME - implement this //Runway out_dest; //FIXME - implement this
bool holdingShort; bool holdingShort;
bool reportReadyForDeparture; // set true when ATC has requested that the plane report when ready for departure bool reportReadyForDeparture; // set true when ATC has requested that the plane report when ready for departure
bool clearedToLineUp; bool clearedToLineUp;
bool clearedToTakeOff; bool clearedToTakeOff;
bool _clearedToLand; // also implies cleared for the option. bool _clearedToLand; // also implies cleared for the option.
bool liningUp; // Set true when the turn onto the runway heading is commenced when taxiing out bool liningUp; // Set true when the turn onto the runway heading is commenced when taxiing out
bool goAround; // Set true if need to go-around bool goAround; // Set true if need to go-around
bool goAroundCalled; // Set true during go-around only after we have called our go-around on the radio bool goAroundCalled; // Set true during go-around only after we have called our go-around on the radio
bool contactTower; // we have been told to contact tower bool contactTower; // we have been told to contact tower
bool contactGround; // we have been told to contact ground bool contactGround; // we have been told to contact ground
bool changeFreq; // true when we need to change frequency bool changeFreq; // true when we need to change frequency
bool _taxiToGA; // Temporary mega-hack indicating we are to taxi to the GA parking and disconnect from tower control. bool _taxiToGA; // Temporary mega-hack indicating we are to taxi to the GA parking and disconnect from tower control.
bool _removeSelf; // Indicates that we wish to remove this instance. The use of a variable is a hack to allow time for messages to purge before removal, due to the fagility of the current dialog system. bool _removeSelf; // Indicates that we wish to remove this instance. The use of a variable is a hack to allow time for messages to purge before removal, due to the fagility of the current dialog system.
atc_type changeFreqType; // the service we need to change to atc_type changeFreqType; // the service we need to change to
bool freeTaxi; // False if the airport has a facilities file with a logical taxi network defined, true if we need to calculate our own taxiing points. bool freeTaxi; // False if the airport has a facilities file with a logical taxi network defined, true if we need to calculate our own taxiing points.
// Hack for getting close to the runway when atan can go pear-shaped // Hack for getting close to the runway when atan can go pear-shaped
double _savedSlope; double _savedSlope;
void FlyTrafficPattern(double dt); void FlyTrafficPattern(double dt);
// TODO - need to add something to define what option we are flying - Touch and go / Stop and go / Landing properly / others? // TODO - need to add something to define what option we are flying - Touch and go / Stop and go / Landing properly / others?
void TransmitPatternPositionReport(); void TransmitPatternPositionReport();
void CalculateSoD(double base_leg_pos, double downwind_leg_pos, bool pattern_direction); void CalculateSoD(double base_leg_pos, double downwind_leg_pos, bool pattern_direction);
void ExitRunway(const Point3D& orthopos); void ExitRunway(const Point3D& orthopos);
void StartTaxi(); void StartTaxi();
void Taxi(double dt); void Taxi(double dt);
void GetNextTaxiNode(); void GetNextTaxiNode();
void DoGroundElev(); void DoGroundElev();
// Set when the plane should be invisible *regardless of distance from user*. // Set when the plane should be invisible *regardless of distance from user*.
bool _invisible; bool _invisible;
}; };
#endif // _FG_AILocalTraffic_HXX #endif // _FG_AILocalTraffic_HXX