dcs-0.1

---

Description:

Content:

Namespaces:

• Dcs

Interfaces:

• Application
• ApplicationView
• Buildable - A common interface for buildable objects.
• CldAdapter - Interface to define how Dcs classes attach to Cld objects.
• Configuration - Interface for handling Dcs configuration.
• Container - A common interface inherited by any object that has its own list of sub objects.
• DBusInterface
• Factory
• Object
• Extension - XXX I think this is probably completely unnecessary and should be removed

Classes:

• AbstractConfig
• ApplicationConfig - Configuration data that loads XML configuration and is used to retrieve user defined settings.
• ApplicationController - The application controller in a MVC design is responsible for responding to events from the view and updating the model.
• ApplicationFactory - Class use to build objects from configuration data.
• ApplicationModel - Main application class responsible for interfacing with data and different interface types.
• DataSeries - A buffer that stores data from a Cld.Channel
• SysLog
• MetaConfig
• ModuleLoader - Recursively walk a folder looking for shared libraries.
• PluginInformation - This file is a modified version taken from Rygel.
• PluginLoader - This class is responsible for plugin loading.
• PluginExtension
• PluginManager
• Plugin - This represents a Dcs plugin.
• Point

Structs:

• SimplePoint
• TriplePoint

Enums:

• ConfigFormat
• ConfigEntry
• LogLevel
• PluginCapabilities - DcsPluginCapabilities is a set of flags that represent various capabilities of plugins.

Error domains:

• ConfigError
• FactoryError
• PluginError - Errors related to plugin types.
• CLI

Classes:

• Application
• Factory
• DAQ

Interfaces:

• Channel

Classes:

• Device
• DeviceManager
• Factory
• Log

Interfaces:

• Backend - Interface for plugins that are to be used as a backend for logging data.

Classes:

• BackendManager
• BackendProxy - Proxy for the plugin that can be used to connect any data or signals from a class that wants to load logging backends.
• Factory
• Net

Classes:

• Factory
• RestService
• ZmqClient
• ZmqService

Structs:

• RouteEntry

Enums:

• ZmqTransport - Transport types that are available to ZeroMQ.
• RouteArg

Error domains:

• ZmqError
• UI - Helper utilities for the UI namespace, mainly an extension of others in the core or application areas.

Interfaces:

• Drawable - An object that can be drawn in a Cairo context
• PluginControl
• Settable - Implementations of this interface will provide a relevant settings menu and connect to it
• SettingsWidget - A graphical interface e,ement that is used to set the properties of another element.
• Widget - Interface for all widgets.

Classes:

• AIControl
• AOControl
• Box - Box class used to act as a layout for other interface classes.
• ChannelMatrixElement
• ChannelMatrix - Contains a group of Cld.Channels such that the values can be accessed as a 2darray to be used in a heat map, for example.
• ChannelTreeEntry
• ChannelTreeCategory
• ChannelTreeView
• ChannelVectorElement
• ChannelVector - Contains a group of Cld.Channels such that the values can be accessed as a vector to be used in a multi-channel chart trace.
• Axis
• ColorMap
• Trace - A graphical representation of ordered pair data XXX TBD This only works for increasing values of x. A more general approach would be to interpolate both x and y to a third vatiable, t, the plot x versus y.
• ChartCanvas
• Chart
• ChartWidget
• StripChartWidget
• XAxisArea
• YAxisArea
• ChartArea
• DigitalControl - Digital channel user interface control
• PolarChartGrid
• ExecControl
• Factory - Class use to build objects from configuration data.
• Grid - Connect any signals including the notifications from the model.
• HeatMap
• LogControl
• Page - Page data model class that is configurable using the application builder.
• PidControl
• Plugin
• PluginManager
• PnidElement - Might need/want to convert this to a base class and create a PnidTransducerElement, PnidTextElement, PnidVesselElement, etc. to interact with the SVG in different ways.
• Pnid
• PolarAxis
• PolarChartCanvas
• PolarChart
• PolarHeatMap
• RichContent
• RTTrace - A chart trace that accesses a dataseries
• RTChart - A chart that refreshes its traces periodically
• RTChartSettings
• RTMultiChannelTrace - A chart trace that accesses a channel_vector
• StripChartTrace
• StripChart
• VideoProcessor
• WebKitWidget
• WidgetInformation - Empty class just for testing right now.
• Canvas - Simple canvas class to use for packable widgets.
• WindowBase - Window base class to use with buildable child windows.
• SimpleWidget
• CustomWidget
• CompositeWidget
• Window

Enums:

• AxisFlag
• TraceFlag
• TraceDrawType
• ChartFlag
• GridFlag
• Orientation - Orientation options for the axis.
• PositionType - PositionType options for the axis.
• PolarAxisType
• ColorGradientType
• WindowState

Methods:

• public Type? type_from_name (string name)
  Type of the object to test for.
• public int signum (double x)
  A sign or signum function.
• public double degrees_to_radians (double t)
  Convert angle from degrees to radians
• public double degrees_to_positive (double t)
  Convert angle in radians to an equivalent positive value < 360
• public List<double?> hex_to_rgb (string hex)
  Convert a hexidecimal string into the corresponding RGB values.
• public RGBA get_color (string desc)
  Get the Gdk color value for a given descriptive value, eg. `blue'.