1

/* $Id$ */

     2

     3

/** @file airport.h Various declarations for airports */

     4

     5

#ifndef AIRPORT_H

     6

#define AIRPORT_H

     7

     8

#include "fsmport.h"

     9

#include <list>

    10

    11

typedef FSMCommand AirportFTA;

    12

typedef FSMPortMovingData AirportMovingData;

    13

    14

enum {MAX_TERMINALS =  36};

    15

enum {MAX_HELIPADS  =  24};

    16

enum {MAX_ELEMENTS  = 255};

    17

enum {MAX_HEADINGS  =  30};

    18

    19

// Airport types

    20

enum {

    21

	AT_SMALL         =  0,

    22

	AT_LARGE         =  1,

    23

	AT_HELIPORT      =  2,

    24

	AT_METROPOLITAN  =  3,

    25

	AT_INTERNATIONAL =  4,

    26

	AT_COMMUTER      =  5,

    27

	AT_HELIDEPOT     =  6,

    28

	AT_INTERCON      =  7,

    29

	AT_HELISTATION   =  8,

    30

	AT_OILRIG        = 15,

    31

	AT_DUMMY         = 255

    32

};

    33

    34

/* Airport movements & speeds */

    35

enum {

    36

	AMED_EXACTPOS   = 1 << 0,

    37

	AMED_NOSPDCLAMP = 1 << 4,

    38

	AMED_SLOWTURN   = 1 << 5,

    39

	AMED_BRAKE      = 1 << 6,

    40

	AMED_HOLD       = 1 << 7,

    41

	AMED_LAND       = 1 << 8,

    42

	AMED_HELI_RAISE = 1 << 8,

    43

	AMED_TAKEOFF    = 1 << 8,

    44

	AMED_HELI_LOWER = 1 << 8,

    45

};

    46

    47

/* Movement States on Airports (headings target) */

    48

enum {

    49

	TO_ALL         = 0x00,

    50

	FIRST_TERMINAL = 0x01,

    51

	LAST_TERMINAL  = 0x24,

    52

	FIRST_HELIPAD  = 0x25,

    53

	LAST_HELIPAD   = 0x3C,

    54

	HANGAR         = 0x40,

    55

	TAKEOFF        = 0x41,

    56

	STARTTAKEOFF   = 0x42,

    57

	ENDTAKEOFF     = 0x43,

    58

	LANDING        = 0x44,

    59

	ENDLANDING     = 0x45,

    62

						   * This is best placed on the TAKEOFF line at the start of the runway. The aircraft will make the acceleration noise,

    63

						   * and then you give the instruction of where to go to for the SHORTTAKEOFF instruction sequence. eg.:

    64

						   * { 40, TAKEOFF, RUNWAY_OUT_block, 0 }, { 40, SHORTTAKEOFF, RUNWAY_OUT_block2, 42 }, { 40, 0, RUNWAY_OUT_block2, 41 },

    65

						   */

    70

	HELITAKEOFF    = 0x51,

    71

	HELIENDTAKEOFF = 0x53,

    72

	HELILANDING    = 0x54,

    73

	HELIENDLANDING = 0x55,

    74

	CHOOSEHELIPAD  = 0x7D,

    75

	CHOOSETERMINAL = 0x7E,

    76

	FLYING         = 0x7F,

    77

};

    78

    79

// Finite sTate mAchine --> FTA

    80

struct AirportFTAClass : FSMPortClass {

    81

public:

    82

	static AirportFTAClass *oil_rig; ///< "Special" holding pattern used for oil rigs.

    83

	static AirportFTAClass *dummy;   ///< A dummy holding pattern to be used when an airport has been removed, but the order to go to the airport has not been removed.

    84

    85

	enum Flags {

    86

		AIRPLANES   = 0x1,

    87

		HELICOPTERS = 0x2,

    88

		ALL         = AIRPLANES | HELICOPTERS,

    89

		SHORT_STRIP = 0x4,

    90

		SEAPLANES   = 0x8

    91

	};

    92

    93

	AirportFTAClass(FSMportsSpec *spec) : FSMPortClass(spec), terminals(NULL), helipads(NULL), flags((Flags)0), entry_points(NULL) {}

    94

    95

	~AirportFTAClass();

    96

    97

	byte *terminals;

    98

	byte *helipads;

    99

	Flags flags;

   100

	byte *entry_points;             ///< when an airplane arrives at this airport, enter it at position entry_point, index depends on direction

   101

};

   102

   103

DECLARE_ENUM_AS_BIT_SET(AirportFTAClass::Flags)

   104

   105

/**

   106

 * Get a list of currently available airports.

   107

 * @return the list with available airports.

   108

 * @note return is "class index" << 8 | "index within class"

   109

 */

   110

std::list<uint16> GetAvailableAirports();

   111

   112

#endif /* AIRPORT_H */