VirtualRadar.Interface Namespace

The root namespace for the application interfaces.

Classes

	Class	Description
	AircraftComparerColumn	A list of column names that can be used with the IAircraftComparer. These names are sent to the server from Javascript on the browser, if you change these then you must also change the Javascript.
	AircraftDetail	The DTO returned by IAircraftDetailFetcher.
	AircraftFetcherTKey, TDetail	A base class for fetcher implementations that register an aircraft and then periodically fetch records related to that aircraft.
	AircraftFetcherTKey, TDetailFetchedDetail	The fetched detail for an aircraft.
	AircraftOnlineLookupDetail	Holds the detail for an aircraft whose details were fetched by IAircraftOnlineLookup.
	AircraftOnlineLookupEventArgs	The event args used by IAircraftOnlineLookup.
	AircraftOnlineLookupLogEntry	Describes an entry in the IAircraftOnlineLookupLog.
	AirportDataThumbnailJson	The JSON object that carries the thumbnail data for an aircraft from www.airport-data.com
	AirportDataThumbnailsJson	The DTO carrying the result of a JSON request for multiple thumbnails from www.airport-data.com.
	AirPressure	An air pressure reading, as downloaded from the SDM site.
	BackgroundThreadQueueT	A class that wraps a queue of objects that one thread pushes onto while a background thread pops and processes them.
	ByteArrayComparable	An implementation of IComparable that returns the comparative order of a byte array.
	Cidr	Represents a Classless Inter-Domain Routing value.
	CidrComparer	Compares Cidr objects for their relative order.
	CollectionHelper	A static class with methods that can help when dealing with collections.
	Coordinate	An immutable object that describes a point where an aircraft was seen and the time at which its position was recorded.
	Crc16	A utility class that calculates CRC16 checksums.
	Crc16Ccitt	A utility class that calculates CCITT-16 CRC values.
	Crc32ModeS	A class that can calculate CRC32 parity bits that are applied to Mode-S messages.
	Crc64	A class that can calculate CRC64 checksums on a set of arbitrary bytes.
	CultureSwitcher	A class that switches the current thread to a particular culture when it is created and then restores the original culture when it's disposed.
	CustomConvert	Performs simple custom conversions.
	Describe	A static class that can produce descriptions of objects that implement common interfaces.
	EventArgsT	An EventArgs that exposes a single value as a property.
	EventHandlerUtils	A static class that makes it easier to use weak event handlers.
	EventHelper	Methods that help when handling events.
	EventHelperException	Thrown when an event handler throws an exception in EventHelper.
	ExpiringCollectionTItem	Manages a self-expiring collection of items.
	ExpiringCollectionTItemCollectionItemT	An instance of a collection item and its associated timestamp.
	ExpiringDictionaryTKey, TValue	Manages a self-expiring dictionary of items.
	ExpiringListT	Manages a self-expiring list of items.
	Filter	Describes a filter.
	FilterBool	An object that carries a bool filter.
	FilterEnumT	Describes a filter against an enum value.
	FilterRangeT	Describes a range filter to apply to a value.
	FilterString	A string filter to apply to a value.
	GreatCircleMaths	A collection of Great Circle math functions, mostly cribbed from http://www.movable-type.co.uk/scripts/latlong.html.
	Hierarchy	Static methods for dealing with hierarchies.
	IListExtensions	Extensions to IList<T> that add some functionality present on List<T> but missing on the interface.
	IPAddressComparer	A class that can compare two IPAddresses for relative order.
	IPAddressHelper	A static class of methods that can help when dealing with IPAddress objects.
	IPEndPointHelper	A static helper class that can make life easier when dealing with IPEndPoint objects.
	JavascriptHelper	A collection of assorted methods that help make dealing with Javascript a bit easier.
	JsonSerialiser	An object that can serialise to JSON.
	OnlineHelpAddress	A class exposing the addresses of online help pages.
	PairT	An immutable generic class that holds a pair of values of the same type. Can be used as a key in a hashtable / dictionary.
	PictureDetail	A class that describes a picture.
	PluginEventArgs	An EventArgs for events that need to refer to an instance of an IPlugin.
	PluginStartupParameters	The class that passes parameters to Startup(PluginStartupParameters).
	PropertyHelper	Utility methods for working with properties.
	QueueRepository	Exposes a collection of every queue running within the program.
	RebroadcastServerConnection	Describes a connection to a rebroadcast server.
	Round	A helper class that can round numbers quickly, but only if they are within certain ranges.
	SpinLock	A class that implements a simple lock that avoids the overhead imposed by using lock().
	SpinLockAcquire	A wrapper class that calls Lock in its constructor and Unlock in its Dispose.
	StreamHelper	A collection of methods that can help when dealing with streams.
	StringDeduplicator	A utility class that can be used to remove duplicates of strings.
	StringWriterWithEncoding	A string writer that lets you set the encoding.
	TimestampedException	Records an exception and the time (at UTC) when it was thrown.
	WaitState	A base class for simple state objects that carry information in BeginXXXXX calls. Holds a wait handle that can be manually signalled in the EndXXXXXX call and waited on in calling thread.
	WeakEventHandlerT, E	The default implementation of IWeakEventHandler.
	WebRequestHelper	A static class that helps with some common tasks when dealing with web requests.
	WebRequestResultT	Describes the request of a request to an Internet-based API.

Interfaces

	Interface	Description
	IAccessFilter	The interface for classes that can take an Access list from Settings and use that to decide whether to allow or disallow an incoming connection or request.
	IAircraft	Describes everything that is known about an aircraft that is being tracked.
	IAircraftComparer	The interface for objects that can compare two IAircraft for relative sort order.
	IAircraftDetailFetcher	The interface for a singleton class that periodically fetches all aircraft details from the database.
	IAircraftList	The interface for objects that can collect together information from the messages transmitted by aircraft, and lookups in various data sources, to maintain a list of aircraft and their current state.
	IAircraftOnlineLookup	The interface for an object that can batch up lookups of aircraft details from an online source.
	IAircraftOnlineLookupCache	Caches the results of online aircraft detail lookups.
	IAircraftOnlineLookupLog	Records the online aircraft detail lookup requests and responses over the past so-many minutes.
	IAircraftOnlineLookupManager	Brings together the online lookup and the online lookup cache. If you want something from the online aircraft lookup then talk to this object.
	IAircraftOnlineLookupProvider	The interface that online lookup provider can implement to change where IAircraftOnlineLookup goes to fetch aircraft details.
	IAircraftPictureManager	The interface for an object that can deal with finding pictures of aircraft.
	IAircraftSanityChecker	The interface for objects that test the sanity of position reports and altitudes received for aircraft.
	IAirportDataDotCom	The interface that objects that expose access to the www.airport-data.com API must implement.
	IAirPressureDownloader	The interface that objects that download air pressure readings has to implement.
	IAirPressureLookup	The interface for objects that can take a list of air pressures and from that give you the closest air pressure reading for a point on the surface of the earth.
	IAirPressureManager	The interface that objects that manage the downloading of air pressure readings has to implement.
	IApplicationInformation	The interface for objects that can expose information about the application.
	IAudio	The interface for objects that can generate audio.
	IAutoConfigPictureFolderCache	The interface for a singleton object that can automatically apply the picture folder name from the configuration to an IDirectoryCache.
	IBackgroundThreadExceptionCatcher	An interface for objects that may be utilising background threads and want to allow exceptions on those threads to bubble up to the GUI thread.
	IBackgroundWorker	The interface for an object that does some work on a background thread and then quits the thread. The intention is that it is used once and then discarded, it cannot be used twice.
	IBitStream	The interface for classes that can take an array of bytes and stream bits from that byte array.
	ICallsignParser	The interface for an object that can parse a callsign.
	IClock	The interface for an object that abstracts away the clock.
	IConnectionLogger	The interface for objects that listen to a web server, track connections to it and periodically record details of those connections in a local database.
	IDirectoryCache	The interface for objects that can cache the filenames in a folder.
	IDirectoryCacheProvider	The interface for the object that abstracts away the environment for IDirectoryCache implementations.
	IDirectoryCacheProviderFileInfo	The interface for an object that exposes information about a file.
	IExceptionReporter	The interface for objects that can report exceptions.
	IExternalIPAddressService	The interface for objects that find out the external IP address of the user.
	IExternalIPAddressServiceProvider	The object that abstracts away the environment for tests on IExternalIPAddressService.
	IHeartbeatService	A service that raises an event on a background thread every so-many minutes.
	IImageDimensionsFetcher	The interface for an object that can determine the dimensions of an image stored in an image file.
	IImageFileManager	Manages access to images stored on disk.
	ILog	The interface for objects that can manage log files for us.
	ILogProvider	The interface for objects that abstract away the environment for ILog implementations.
	IMessageBox	The interface for an object that can show a modal message to the user.
	INewVersionChecker	The interface for objects that can check with the VirtualRadarServer website to see whether a new version is available for download.
	INewVersionCheckerProvider	The interface for providers that abstract away parts of the environment for testing.
	IPlugin	Describes the interface for a class that plugin DLLs must implement in order to be loaded by Virtual Radar Server.
	IPluginManager	The interface for the object that manages plugins on behalf of the program.
	IPluginManagerProvider	The interface for objects that abstract away the environment for IPluginManager implementations.
	IQueue	The interface for queues that can be interrogated to find out how many items they are holding.
	IRuntimeEnvironment	The interface for singleton objects that can tell the program about the environment it's running under.
	ISimpleAircraftList	The interface for implementations of IAircraftList that can have aircraft created and added to the list by the program rather than from an external source like an instance of BaseStation.
	ISingletonT	Declares that the interface this is implemented by is intended to be used as a singleton.
	ISpeechSynthesizerWrapper	The interface for a wrapper around the .NET SpeechSynthesizer class.
	IStandaloneAircraftOnlineLookupCache	The interface for the standalone aircraft online lookup cache. This is the fallback that is used when no other cache is available. It is registered with a priority of zero.
	IStatistics	A class that records various statistics.
	ITimer	The interface for objects that periodically raise an event.
	IWeakEventHandlerE	The interface for event handlers that can hold a weak reference to a target.
	IXmlSerialiser	The interface for objects that can serialise objects to XML and deserialise objects from XML.

Delegates

	Delegate	Description
	UnregisterCallbackE	The delegate for a method that will automatically unregister an event handler when the owning object is garbage collected.

Enumerations

	Enumeration	Description
	AircraftListSource	An enumeration of the different sources that aircraft lists can come from.
	AltitudeType	The different types of altitude and vertical rate decoded by VRS.
	BackgroundThreadQueueMechanism	An enumeration of the different mechanisms that the BackgroundThreadQueue can use.
	Certainty	An enumeration of the different desgrees of certainty the program has regarding the sanity of a value.
	DistanceUnit	An enumeration of the different distance units that the website can display.
	FilterCondition	An enumeration of the different conditions that a value can be filtered on.
	HeightUnit	An enumeration of the different heights that the web site knows about.
	SpeedType	An enumeration of the different types of speed transmitted by a vehicle. This enumeration is duplicated within the Javascript, hence the explicit declarations. Any changes here need copying there.
	SpeedUnit	An enumeration of the different speed units that the web site can deal with.
	TransponderType	An enumeration of the different types of transponder that VRS can decode messages from.

Remarks

The interfaces, enumerations and classes in this namespace are held in VirtualRadar.Interface.dll. Virtual Radar Server is loosely coupled (see the remarks against the InterfaceFactory namespace) and almost all of the classes used by the program are private to the library that they live in. They all implement interfaces and the program uses a singleton class factory in InterfaceFactory to resolve references to interfaces when the need arises.

These interfaces are all declared in this library, VirtualRadar.Interface.dll. The library does not contain any of the implementations. It has almost no references to other projects within Virtual Radar Server, aside from InterfaceFactory. Along with the interfaces for the program it also contains the enumerations, custom EventArgs, Exception and Attribute classes that the interfaces refer to. It also contains one or two public helper classes, usually static classes, that the implementations of the interfaces may find useful.