AxelSemrau.Chronos.Plugin.IDevice Interface Reference

To be implemented by the "device driver" part of a Chronos plugin. More...

Inheritance diagram for AxelSemrau.Chronos.Plugin.IDevice:

Public Member Functions
void	Connect ()
	You may have connected to the device before this, but make sure you are connected after this.
void	Disconnect ()
	You may disconnect now.

Properties
string	DisplayedTypeName [get]
	Text which is displayed in the instruments settings "Autosampler Type" column and in many other places.
string	DeviceTypeDescription [get]
	Text which is displayed to make clear which kind of device a named sampler is.
string	Name [get, set]
	User-selected name for the device instance.

Events
Action< ConnectionState >	ConnectionStateChanged
	Raise this event when your connection state has changed.

Detailed Description

To be implemented by the "device driver" part of a Chronos plugin.

A device in this context is something that controls a piece of hardware. It provides a basic infrastructure for Chronos that allows Chronos to let the user add any number of devices of this type to the configuration and to use them from tasks. Any device specific operation is beyond the scope of this interface. You should encapsulate your device's operations in the class implementing this interface and access them from device specific ITaskForDevice implementing classes and maybe from a class implementing IToolbox<DeviceType>.

Definition at line 55 of file DeviceInterfaces.cs.

Member Function Documentation

Connect()

void AxelSemrau.Chronos.Plugin.IDevice.Connect

(

)

You may have connected to the device before this, but make sure you are connected after this.

Implemented in MockPlugin.Device.MockDevice, MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Disconnect()

void AxelSemrau.Chronos.Plugin.IDevice.Disconnect

(

)

You may disconnect now.

Implemented in MockPlugin.Device.MockDevice, MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Property Documentation

DeviceTypeDescription

string AxelSemrau.Chronos.Plugin.IDevice.DeviceTypeDescription

get

Text which is displayed to make clear which kind of device a named sampler is.

Implemented in MockPlugin.Device.MockDevice, MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Definition at line 68 of file DeviceInterfaces.cs.

        {
            get;
        }

DisplayedTypeName

string AxelSemrau.Chronos.Plugin.IDevice.DisplayedTypeName

get

Text which is displayed in the instruments settings "Autosampler Type" column and in many other places.

Implemented in MockPlugin.Device.MockDevice, MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Definition at line 60 of file DeviceInterfaces.cs.

        {
            get;
        }

Name

string AxelSemrau.Chronos.Plugin.IDevice.Name

getset

User-selected name for the device instance.

Please return what you are given. Note: Before Chronos 5.1.8, this was set to "Uninitialized Device" for temporary device instances. With later versions, the name should only be set for a "real" instance.

Implemented in MockPlugin.Device.MockDevice, MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Definition at line 80 of file DeviceInterfaces.cs.

        {
            get;
            set;
        }

Referenced by MockPlugin.Tasks.MockUseMultipleDevicesTask.NameOrNotSet().

Event Documentation

ConnectionStateChanged

Action<ConnectionState> AxelSemrau.Chronos.Plugin.IDevice.ConnectionStateChanged

Raise this event when your connection state has changed.

Implemented in MockPlugin.Device.Train, and MockPlugin.Device.TrainPart.

Definition at line 99 of file DeviceInterfaces.cs.

---

The documentation for this interface was generated from the following file:

• DeviceInterfaces.cs