Classes | Enumerations

Package FSUIPC

Classes

struct  FSRunway
 Represents a runway identifier for flight sim. More...
class  AIPlaneInfo
 A class holding information about an AI traffic plane.This class cannot be instantiated. You can only obtain instances of AIPlaneInfo from the active AITrafficServices object. More...
class  AITrafficServices
 A class that provides information about the AI aircraft in Flight Simulator. This reads the TCAS tables from FSUIPC and presents the information in a .NET friendly collection of AIPlaneInfo classes.This class cannot be instantiated, you must obtain a reference to the active instance via the property on the FSUIPCConnection class. More...
struct  FsLatitude
 A structure representing a latitude value in MS Flight Simulator. More...
struct  FsLatitudeSpan
 Represents a span of latitude in MS Flight Simulator. More...
struct  FsLatLonPoint
 A point in the Flight Simulator world represented by a longitude and latitude. More...
struct  FsLatLonQuadrilateral
 Represents an Quadrilateral area in FS bounded by four Latitude/Longitude coordinates. Note that only Convex Quadrilateral shapes will work properly. Concave shapes will not. More...
struct  FsLongitude
 A structure representing a longitude value in MS Flight Simulator. More...
struct  FsLongitudeSpan
 Represents a span of longitude in MS Flight Simulator. More...
class  FSUIPCConnection
 A class that handles communication and data transfer to and from Pete Dowson's FSUIPC or WideFS. More...
class  FSUIPCException
 A exception that gets thrown if an error occurs during an FSUIPC operation. More...
class  Offset
 Represents an item of data that can be read from or written to an FSUIPC offset. More...

Enumerations

enum  FSRunwayDesignator {
  none, left, right, centre,
  water
}
 

Designator for FS Runways (left, right etc)

More...
enum  ATCIdentifier {
  TailNumber, AirlineAndFlightNumber, AircraftType, AircraftTitle,
  AircraftTypePlusLast3DigitsOfTailNumber, Model
}
 

Specifies a format for the ATCIdentifer property on AIPlaneInfo objects.

More...
enum  FlightSim {
  Any, FS98, FS2K, CFS2,
  CFS1, FLY, FS2K2, FS2K4,
  FSX, ESP
}
 

Flight Simulator Version.

More...
enum  FSUIPCError {
  FSUIPC_ERR_OK, FSUIPC_ERR_OPEN, FSUIPC_ERR_NOFS, FSUIPC_ERR_REGMSG,
  FSUIPC_ERR_ATOM, FSUIPC_ERR_MAP, FSUIPC_ERR_VIEW, FSUIPC_ERR_VERSION,
  FSUIPC_ERR_WRONGFS, FSUIPC_ERR_NOTOPEN, FSUIPC_ERR_NODATA, FSUIPC_ERR_TIMEOUT,
  FSUIPC_ERR_SENDMSG, FSUIPC_ERR_DATA, FSUIPC_ERR_RUNNING, FSUIPC_ERR_SIZE,
  FSUIPC_ERR_WRITE_OVERFLOW = 999
}
 

The 'traditional' error codes returned by the C version of the FSUIPC Client SDK. These error codes usually get returned in a variable called 'dwResult'. In this library, these error codes are returned in a .NET exception called FSUIPCClientException.

More...
enum  AITrafficStatus {
  StatusNotAvilable = 0, Initialising = 0x80, Sleeping = 0x81, FilingFlightPlan = 0x82,
  ObtainingClearance = 0x83, PushingBack = 0x84, PushingBackTurn = 0x85, StartingUp = 0x86,
  ReadyForTaxi = 0x87, TaxiingOut = 0x88, ReadyForTakeOff = 0x89, TakingOff = 0x8A,
  Departing = 0x8B, Enroute = 0x8C, InThePattern = 0x8D, Landing = 0x8E,
  RollingOut = 0x8F, GoingAround = 0x90, TaxiingIn = 0x91, ShuttingDown = 0x92
}
 

The state of an AI Traffic object.

More...

Enumeration Type Documentation

The state of an AI Traffic object.

Enumerator:
StatusNotAvilable 

State not avilable. State of AI aircraft is only avilable in FS2004 and above.

Initialising 

Iniialising.

Sleeping 

Sleeping.

FilingFlightPlan 

Filing flight plan.

ObtainingClearance 

Obtaining clearance.

PushingBack 

Pushing back.

PushingBackTurn 

Turning while pushing back.

StartingUp 

Starting engines.

ReadyForTaxi 

Ready for taxi.

TaxiingOut 

Taxing to runway for takeoff.

ReadyForTakeOff 

Ready for takeoff.

TakingOff 

Taking off.

Departing 

Airborne, departing airport.

Enroute 

Enroute.

InThePattern 

In the pattern for landing.

Landing 

Landing (cleared to land)

RollingOut 

Landed, rolling out on runway.

GoingAround 

Going around.

TaxiingIn 

Taxiing in from runway to stand.

ShuttingDown 

Shutting down engines.

Specifies a format for the ATCIdentifer property on AIPlaneInfo objects.

Enumerator:
TailNumber 

The tail number of the aircraft.

AirlineAndFlightNumber 

The airline and flight number (uses tail number for GA planes)

AircraftType 

The type (manufacturer) of the aircraft.

AircraftTitle 

The title of the plane from the config file.

AircraftTypePlusLast3DigitsOfTailNumber 

The type (manufacturer) of the aircraft followed by last three digits of the tail number.

Model 

The model of the aircraft.

enum FlightSim

Flight Simulator Version.

Enumerator:
Any 

Any version of Flight Sim.

FS98 

Microsoft Flight Simulator 98.

FS2K 

Microsoft Flight Simulator 2000.

CFS2 

Microsoft Combat Flight Simulator 2.

CFS1 

Microsoft Combat Flight Simulator 1.

FLY 

Fly! by Terminal Velocity. (I don't think this works).

FS2K2 

Microsoft Flight Simulator 2002.

FS2K4 

Microsoft Flight Simulator 2004 (A Century of Flight)

FSX 

Microsoft Flight Simulator X.

ESP 

Microsoft ESP.

Designator for FS Runways (left, right etc)

Enumerator:
none 

This is the only runway with this number.

left 

Left.

right 

Right.

centre 

Centre.

water 

Water runway.

The 'traditional' error codes returned by the C version of the FSUIPC Client SDK. These error codes usually get returned in a variable called 'dwResult'. In this library, these error codes are returned in a .NET exception called FSUIPCClientException.

Enumerator:
FSUIPC_ERR_OK 

No error.

FSUIPC_ERR_OPEN 

Attempt to Open() when connection is already open.

FSUIPC_ERR_NOFS 

Cannot link to FSUIPC or WideClient.

FSUIPC_ERR_REGMSG 

Failed to Register common message with Windows.

FSUIPC_ERR_ATOM 

Failed to create Atom for mapping filename.

FSUIPC_ERR_MAP 

Failed to create a file mapping object.

FSUIPC_ERR_VIEW 

Failed to open a view to the file map.

FSUIPC_ERR_VERSION 

Incorrect version of FSUIPC, or not FSUIPC.

FSUIPC_ERR_WRONGFS 

Flight Sim is not version requested by this application.

FSUIPC_ERR_NOTOPEN 

Attempted to call Process() but the FSUIPC link has not been opened.

FSUIPC_ERR_NODATA 

Call cannot execute: no requests accumulated.

FSUIPC_ERR_TIMEOUT 

IPC SendMessage timed out (all retries)

FSUIPC_ERR_SENDMSG 

IPC SendMessage failed (all retries)

FSUIPC_ERR_DATA 

IPC request contains bad data.

FSUIPC_ERR_RUNNING 

Wrong version of FSUIPC. Can also occur if running on WideClient but FSUIPC is not running on server.

FSUIPC_ERR_SIZE 

Read or Write request cannot be added to the shared memory file as the file is full.

FSUIPC_ERR_WRITE_OVERFLOW 

Tried to write a string or byte array that was longer than the declared length of this Offset.