Static Public Member Functions | Properties

FSUIPCConnection Class Reference

A class that handles communication and data transfer to and from Pete Dowson's FSUIPC or WideFS. More...

Collaboration diagram for FSUIPCConnection:

List of all members.

Static Public Member Functions

static void Open ()
 Opens a connection to FSUIPC or WideFS. Call this once when your application starts.
static void Open (FlightSim RequiredFlightSimVersion)
 Opens communication to FSUIPC or WideFS. Call this once when your application starts.
static void Open (byte ClassInstance, FlightSim RequiredFlightSimVersion)
 Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with.
static void DisconnectGroup (string groupName)
 Use DeleteGroup() instead. Does the same thing but is a better name.
static void DeleteGroup (string groupName)
 Deletes an entire group of Offsets from the FSUIPCConnection class. Process() can no longer be called on for this group. Only use this method if you will never need to use the offsets in the group again.
static void Close ()
 Closes all open connections with FSUIPC or WideFS and cleans up the memory used.Please call this when your application quits. The FSUIPC interface uses unmanaged memory for communication. The .NET garbage collection cannot clean this up for you.
static void Close (byte ClassInstance)
 Closes the connections to a specific class instance of WideClient.exe and cleans up the memory used.Please call this when your application quits. The FSUIPC interface uses unmanaged memory for communication. The .NET garbage collection cannot clean this up for you.
static void Process ()
 Processes all the Offsets in the default group. To process a specific group of Offsets pass the name of the Group as a parameter.All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.
static void Process (string GroupName)
 Processes all the Offsets in the specified group. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.
static void Process (IEnumerable< string > GroupNames)
 Processes all the Offsets in the groups passed in. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.
static void Process (byte ClassInstance)
 Processes all the Offsets in the default group on the open connection to the specified class instance of WidwClient.exe. To process a specific group of Offsets pass the name of the Group as a parameter.All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.
Parameters:
ClassInstanceThe number of the Class Instance of WideClient you want to talk to.

static void Process (byte ClassInstance, string GroupName)
 Processes all the Offsets in the specified groupon the open connection to the specified class instance of WidwClient.exe. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.
static void Process (byte ClassInstance, IEnumerable< string > GroupNames)
 Processes all the Offsets in the groups passed inon the open connection to the specified class instance of WidwClient.exe. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Properties

static bool OptimiseIPCFile [get, set]
 Turns the IPC file optimisations on or off. If set to true, adjacent offsets requests will be joined to form a single read request in the IPC data exchange file. By default this is set to False.
static Version DLLVersion [get]
 Returns the version of the FSUIPC Client DLL.
static AITrafficServices AITrafficServices [get]
 The active AI Traffic Services object. Use this object to access data about AI aircraft.
static FlightSim FlightSimVersionConnected [get]
 The version of Flight Simulator that FSUIPC is running in, or that WideFS is connected to.

Detailed Description

A class that handles communication and data transfer to and from Pete Dowson's FSUIPC or WideFS.


Member Function Documentation

static void Close (  ) [static]

Closes all open connections with FSUIPC or WideFS and cleans up the memory used.Please call this when your application quits. The FSUIPC interface uses unmanaged memory for communication. The .NET garbage collection cannot clean this up for you.

static void Close ( byte  ClassInstance ) [static]

Closes the connections to a specific class instance of WideClient.exe and cleans up the memory used.Please call this when your application quits. The FSUIPC interface uses unmanaged memory for communication. The .NET garbage collection cannot clean this up for you.

static void DeleteGroup ( string  groupName ) [static]

Deletes an entire group of Offsets from the FSUIPCConnection class. Process() can no longer be called on for this group. Only use this method if you will never need to use the offsets in the group again.

Parameters:
groupNameThe name of the Group you want to delete.
static void DisconnectGroup ( string  groupName ) [static]

Use DeleteGroup() instead. Does the same thing but is a better name.

Parameters:
groupName
static void Open ( FlightSim  RequiredFlightSimVersion ) [static]

Opens communication to FSUIPC or WideFS. Call this once when your application starts.

Parameters:
RequiredFlightSimVersionSpecify a version of Flight Sim if you want to limit your application to run only on that version.
static void Open (  ) [static]

Opens a connection to FSUIPC or WideFS. Call this once when your application starts.

static void Open ( byte  ClassInstance,
FlightSim  RequiredFlightSimVersion 
) [static]

Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with.

Parameters:
ClassInstanceSpecify a specific class instance of wideclient to connect to. (See WideFS documentation for details)
RequiredFlightSimVersionSpecify a version of Flight Sim if you want to limit your application to run only on that version.
static void Process ( byte  ClassInstance,
IEnumerable< string >  GroupNames 
) [static]

Processes all the Offsets in the groups passed inon the open connection to the specified class instance of WidwClient.exe. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters:
ClassInstanceThe number of the Class Instance of WideClient you want to talk to.
GroupNamesThe names of the groups to process.
static void Process ( byte  ClassInstance,
string  GroupName 
) [static]

Processes all the Offsets in the specified groupon the open connection to the specified class instance of WidwClient.exe. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters:
ClassInstanceThe number of the Class Instance of WideClient you want to talk to.
GroupNameThe name of the group to process.
static void Process ( IEnumerable< string >  GroupNames ) [static]

Processes all the Offsets in the groups passed in. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters:
GroupNamesThe names of the groups to process.
static void Process ( byte  ClassInstance ) [static]

Processes all the Offsets in the default group on the open connection to the specified class instance of WidwClient.exe. To process a specific group of Offsets pass the name of the Group as a parameter.All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters:
ClassInstanceThe number of the Class Instance of WideClient you want to talk to.

static void Process (  ) [static]

Processes all the Offsets in the default group. To process a specific group of Offsets pass the name of the Group as a parameter.All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

static void Process ( string  GroupName ) [static]

Processes all the Offsets in the specified group. All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters:
GroupNameThe name of the group to process.

Property Documentation

The active AI Traffic Services object. Use this object to access data about AI aircraft.

Version DLLVersion [static, get]

Returns the version of the FSUIPC Client DLL.

FlightSim FlightSimVersionConnected [static, get]

The version of Flight Simulator that FSUIPC is running in, or that WideFS is connected to.

bool OptimiseIPCFile [static, get, set]

Turns the IPC file optimisations on or off. If set to true, adjacent offsets requests will be joined to form a single read request in the IPC data exchange file. By default this is set to False.