VirtualRadar.Interface.Settings Namespace

The namespace for all of the interfaces and objects that deal with reading and writing configuration information.

Classes

	Class	Description
	Access	A class that holds access lists to Internet resources.
	AudioSettings	Holds the configuration of the speech-to-audio features that the website can access.
	BaseStationSettings	An object that describes the source of data we should connect to.
	Configuration	An object that carries all of the configuration settings for the application.
	ConfigurationListenerEventArgs	Carries information in events from IConfigurationListener.
	ConflictingUpdateException	Thrown when an update conflicts with a previous update.
	DataSource	A collection of strings describing the UniqueId values for the receiver formats that ship with VRS.
	FlightRouteSettings	Holds the configuration pertaining to the handling of flight routes.
	GoogleMapSettings	The web site configuration options (originally these were just Google Map settings but they expanded over time - unfortunately I can't change the class name without breaking backwards compatibility).
	Hash	Describes a hashed password in the configuration.
	InstallerSettings	The object for configuration settings that are created or overwritten by the installer.
	InternetClientSettings	Settings that control how browsers on the Internet interact with the server.
	MergedFeed	The configuration settings for a merged feed.
	MergedFeedReceiver	Describes a receiver in a merged feed.
	MonoSettings	Carries settings that are only used when VRS is loaded under Mono.
	PluginManifest	A class that represents the content of a plugin manifest file.
	PluginSettings	The class that holds the settings for the plugins. These are loaded and saved via IPluginSettingsStorage.
	RawDecodingSettings	The data-transfer object that carries the configuration of the raw message decoder.
	RebroadcastFormat	A collection of strings describing the UniqueId values for the rebroadcast server formats that ship with VRS.
	RebroadcastSettings	The settings for the rebroadcast server.
	Receiver	A settings object that carries information about a receiever.
	ReceiverLocation	A class describing the location of a receiver.
	SavedPolarPlot	Carries the details for an individual receiver's polar plot.
	VersionCheckSettings	The configuration settings controlling the checking for new versions of the server.
	WebServerSettings	A class that holds the configuration of the web server.

Interfaces

	Interface	Description
	IConfigurationListener	The interface for a class that can listen to a Configuration object and raise a single event when one of its properties (or the properties of a child object) are changed.
	IConfigurationStorage	The interface for objects that can load and save Configuration objects.
	IConfigurationStorageProvider	The interface for the objects that abstract away the environment for tests on IConfigurationStorage.
	IInstallerSettingsStorage	The interface for the object that can load installer settings.
	IInstallerSettingsStorageProvider	The interface for objects that abstract away the environment for IInstallerSettingsStorage.
	IPluginManifestStorage	The interface for objects that can read the content of a plugin's manifest file.
	IPluginManifestStorageProvider	The interface for objects that can abstract away the environment for IPluginManifestStorage implementations.
	IPluginSettingsStorage	The interface for objects that load and save PluginSettings objects.
	IPluginSettingsStorageProvider	The interface for objects that abstract away the environment for IPluginSettingsStorage implementations.
	ISavedPolarPlotStorage	Manages the loading and saving of polar plots.
	ISharedConfiguration	Exposes the current configuration.
	ISiteSettingsParser	The interface for objects that can parse the site's exported settings.
	IUser	The interface that describes a user.
	IUserManager	The interface for the object that manages lists of users.

Enumerations

	Enumeration	Description
	ConfigurationListenerGroup	An enumeration of the different groups that can appear in a ConfigurationListenerEventArgs.
	ConnectionType	An enumeration of the different types of connection supported by VRS.
	DefaultAccess	An enumeration of the default access allowed to an Internet resource.
	ProxyType	An enumeration of the type of proxies that the server is sitting behind.
	ReceiverUsage	An enumeration of the different ways that a receiver can be used by the system.

Remarks

The application's configuration information is stored in Configuration, which is read and written by the singleton object IConfigurationStorage. This object raises an event when a new configuration is saved which the application can hook to automatically pick up changes to the configuration. To avoid repeatedly loading the configuration you can also use ISharedConfiguration, which caches the most recent configuration.

The program's installer writes a configuration file that contains settings that cannot be changed without stopping the program and re-running the installer. The settings are in InstallerSettings and are loaded by IInstallerSettingsStorage. Unlike IConfigurationStorage this interface is not a singleton, with it being read-only there is no need to notify the application when the values change and therefore no need to have a single object whose events can be hooked.

Finally we have PluginSettings, which is loaded and saved by IPluginSettingsStorage. This is likely to be of the most interest to plugin developers.