AxelSemrau.Chronos.Plugin.IHaveMachineParameters< ParamType > Interface Template Reference

Parameters that are constant for the duration of a schedule. More...

Inheritance diagram for AxelSemrau.Chronos.Plugin.IHaveMachineParameters< ParamType >:

Collaboration diagram for AxelSemrau.Chronos.Plugin.IHaveMachineParameters< ParamType >:

Public Member Functions
Task	ApplyParametersAsync (bool waitUntilSetpointIsReached, CancellationToken cancelToken)
	Set the given parameters on the device. More...
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IDevice
void	Connect ()
	You may have connected to the device before this, but make sure you are connected after this. More...
void	Disconnect ()
	You may disconnect now. More...

Properties
ParamType	Parameters [get, set]
	Your parameter set. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IDevice
string	DisplayedTypeName [get]
	Text which is displayed in the instruments settings "Autosampler Type" column and in many other places. More...
string	DeviceTypeDescription [get]
	Text which is displayed to make clear which kind of device a named sampler is. More...
string	Name [get, set]
	User-selected name for the device instance. More...

Additional Inherited Members
Events inherited from AxelSemrau.Chronos.Plugin.IDevice
Action< ConnectionState >	ConnectionStateChanged
	Raise this event when your connection state has changed. More...

Detailed Description

Parameters that are constant for the duration of a schedule.

Template Parameters

ParamType

Class that represents your parameters. Make sure that .ToString() gives some meaningful output. This class must be serializable. Use standard ComponentModel attributes to provide a custom editor. If the user should be able to just type a new value (for example, a single temperature) make sure there's a TypeConverter for your ParamType that supports converting from strings.

These parameters can be set from instrument configuration or from a method, but all methods within the same schedule have to use the same set of parameters.

Type Constraints

ParamType	:	class
ParamType	:	new()

Definition at line 393 of file DeviceInterfaces.cs.

Member Function Documentation

ApplyParametersAsync()

Task AxelSemrau.Chronos.Plugin.IHaveMachineParameters< ParamType >.ApplyParametersAsync	(	bool	waitUntilSetpointIsReached,
		CancellationToken	cancelToken
	)

Set the given parameters on the device.

Parameters

waitUntilSetpointIsReached	Parameter setting is done in two turns: The first call will ask you to set all controls to the new setpoints, the second call will ask you to wait until they are actually reached. Return as soon as possible from the first call, and to not return from the second call before you are definitely ready.
cancelToken	If requested, abort waiting for the desired temperature.

Property Documentation

Parameters

ParamType AxelSemrau.Chronos.Plugin.IHaveMachineParameters< ParamType >.Parameters

getset

Your parameter set.

Before sequence start, this will be set to the desired values. Wait until ApplyParameters is called to actually transmit these values to the device.

Definition at line 402 of file DeviceInterfaces.cs.

{ set; get; }

---

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

• DeviceInterfaces.cs