ESAPI-1.0
This interface describes the extensions to the acquisition interface by Exactive based instruments.
In the following example "acquisition"
has to be assigned elsewhere.
IAcquisition acquisition;
IExactiveAcquisition exactiveExtensions = acquisition as IExactiveAcquisition;
if (value != null)
{
Console.WriteLine("Exactive extensions available");
}
Start an acquisition providing a workflow for this operation. The instrument must be on mode "On".
There must not be any pending acquisition. The new acquisition will run under direct control.
workflow of the new acquisition.
The result of the change request as far as the task is processed in the current process
Cancel any pending acquisition that is started under direct control.
The result of the change request as far as the task is processed in the current process
Create an object that will instruct the instrument on to start
an acquisition. This kind of acquisition can be paused and resumed.
The current set of tune data will be used. It can be changed during operation.
The instrument operation mode will switch to DirectControl.
The acquisition can be stopped by calling .
The created acquisition workflow can be used in .
Create an object that will instruct the instrument on to start
an acquisition. This kind of acquisition can be paused and resumed.
The current set of tune data will be used. It can be changed during operation.
The instrument operation mode will switch to DirectControl.
The acquisition can be stopped by calling and will implicitely terminated
after the specified amount of scans have been taken.
The number of scans to be taken during this acquisition. The number must be positive and must not exceed 1000000.
The created acquisition workflow can be used in .
Create an object that will instruct the instrument on to start
an acquisition. This kind of acquisition can be paused and resumed.
The current set of tune data will be used. It can be changed during operation.
The instrument operation mode will switch to DirectControl.
The acquisition can be stopped by calling and will implicitely terminated
after the the specified time span has elapsed.
The amount of time of the acquisition. The lower limit is 0.01 min and the maximum 15000 min.
The created acquisition workflow can be used in .
Create an object that will instruct the instrument on to start
a method-based acquisition. This kind of acquisition can be paused and resumed.
Tune data will be retrieved from those files present in the method.
The instrument operation mode will switch to DirectControl.
The acquisition can be stopped by calling and will implicitely terminated
after the duration specified in the method has elapsed.
name of the method to execute.
The created acquisition workflow can be used in .
Create an object that will instruct the instrument on to start
a method-based acquisition. This kind of acquisition can be paused and resumed.
Tune data will be retrieved from those files present in the method.
The instrument operation mode will switch to DirectControl.
The acquisition can be stopped by calling and will implicitely terminated
after the the specified time span has elapsed.
name of the method to execute.
The amount of time of the acquisition. The lower limit is 0.01 min and the maximum 15000 min.
The created acquisition workflow can be used in .
Create a new object that allows to wait for a trigger condition in the instrument.
name of the trigger returned by
The trigger one can wait for
Get access to all trigger names that can be used in .
A trigger is a special readback value that usually initiates an operation.
An instance of this class will be created by .
This special workflow selects a method to be executed. No further instruments like AS, LC or GC will be
driven. The duration of the method can be enhanced or reduced.
The tune parameters taken of the method's tune file(s) will be used.
This workflow base class contains properties available in all acquisition workflows.
Default values are "empty" for no rawfile acquisition, without sample name. etc.
Continuation defaults to StayOn.
Note that no other device will be instructed to take scans.
Access to the raw file name to be used during an acquisition. Setting this value to null lets the instrument
take acquisitions without storing in a separate file.
An evaluation of this value will happen on submission to .
This property defines what shappens when the acquisition stops.
Trigger to wait for before doing the operation.
This property defines the arbitrary sample name.
This property defines an arbitrary comment.
The instrument will not execute any scan
if this property is positive until the delay has expired
or a new custom scan has been defined.
It will be quaranteed that after the event
no will be populated or written to the rawfile
if this delay is pending and no custom scan has been placed.
The unit of this property is seconds and possible values are
between 0 and 600 inclusively. The default value is 0.
Access to the method name to be used during an acquisition.
Access to the duration of the acquisition. Setting this to null choses the duration chosen in the method
itself. The lower limit is 0.01 min and the maximum 15000 min.
Defines what shall happen when an acquisition request ended.
See for an example how this enumeration can be used.
The instrument will continue to run, but no method execution is performed nor is
data written to a raw file.
The instrument enters the standby state.
The instrument enters the off state.
This interface describes the extensions to IInstrumentValues by Exactive based instruments.
In the following example "access"
has to be assigned elsewhere.
IInstrumentAccess access;
IControl control = access.Control;
IInstrumentValues values = control.InstrumentValues;
IExactiveInstrumentValues exactiveValues = values as IExactiveInstrumentValues;
if (exactiveValues == null)
{
Console.WriteLine("Exactive extensions are not available");
}
Get access to an instrument value by its name.
Each name has also a numeric representation, see .
This method is the instrument-specific implementation for Exactive-based instruments.
The name of the value
null is returned for an invalid or unknown name, otherwise the value linked with the passed name is returned.
Get access to an instrument value by its number.
This method is the instrument-specific implementation for Exactive-based instruments.
The number of the value
The value linked with the passed name is returned. Nodes unknown to the instrument may return in a dumb value instance.
This namespace contains classes needed to start an acquisition on Exactive based instruments.
This namespace covers the single extension that Exactive-based instruments have in addition
to standard instruments' methods.
You can simply cast an
to an
on an Exactive based instrument.
This interface covers all control functionality for tune data in the instrument.
An instance of this class will be created by .
Load a different tunefile and set the .
name of the file where to take the settings from.
true if the request has been transmitted to the instrument, false otherwise
Store the current settings in a file and set the .
name of the file where to store the settings. null or the empty string stores current values.
true if the request has been transmitted to the instrument, false otherwise
Get the name of the current tunefile.
Has the tunefile been changed since its last load/stave operation?
This event will be fired when then tunefile's name or modification status has changed.
This interface describes the extensions to an instrument value by Exactive based instruments.
In the following example "values"
has to be assigned elsewhere.
IInstrumentValues values;
IExactiveValue value = values.Get("InstrumentAcquisition") as IExactiveValue;
if (value != null)
{
Console.WriteLine(value.Commands.Length + " commands available");
}
A full-file example can be found here: .
Execute a command on this value. The command will be verified using .
The command to the value.
null or the argument of the command.
true if the command has been sent to the instrument, false otherwise
Get access to a list of available commands. The list may change if the user role changes.
Any executed command name will be tested against this list.
The commands will be null if the instrument is not connected or if the IValue is unknown
to the instrument.
This event will be fired when the set of commands have changed. The calling thread
should not be blocked by complex actions.
This special workflow restricts an acquisition to a specific duration.
The current tune parameters of the instrument will be used.
Access to the duration of the acquisition. The lower limit is 0.01 min and the maximum 15000 min.
This namespace contains the extension to start acquisitions directly on Exactive based instruments.
This interface describes the API extensions of Exactive based instruments.
A typical use can be performed by .NET's using statement as shown
here. This ensures proper disposal after use. In the following example the container
has to be assigned elsewhere.
InstrumentAccessContainer container;
using (IInstrumentAccess instrument = container.Get(1))
{
IExactiveInstrumentAccess exactive = instrument as IExactiveInstrumentAccess;
if (exactive != null)
{
// further code
}
}
Get access to the interface covering all control functionality of an instrument.
This property is the instrument-specific implementation for Exactive-based instruments.
This property is accessible offline.
Access to the current user role (license class) the system has.
An invalid value will be ignored on set access.
Access to the list of possible user roles.
Access to the list of possible access licenses.
This event will be fired when the current user role or the list
of possible userroles or licenses change.
This namespace covers the extensions that Exactive-based instruments have in addition
to standard instruments. Exactive based systems have support for tunefiles where a bunch of
optimized instrument values are stored that usually be constant during an acquisition.
You can simply cast an
to an
on an Exactive based instrument.
This interface describes the extensions to the table row interface by Exactive based instruments.
In the following example "tableRow"
has to be assigned elsewhere.
ITableRow tableRow;
IExactiveTableRow exactiveExtensions = tableRow as IExactiveTableRow;
if (value != null)
{
Console.WriteLine("Exactive extensions available");
}
This method assigns a value to a table row. The key can be arbitrary as long as if it
is understood by the instrument.
For XML data exchange, e.g. with the instrument, XML is used. This is transparent to
user code. However, under some conditions it is helpful to set values directly.
Special licenses are needed to access this method.
name recognizable by the instrument
value of the name
This method reads a value from table row. The key can be arbitrary as long as if it
is understood by the instrument.
For XML data exchange, e.g. with the instrument, XML is used. This is transparent to
user code. However, under some conditions it is helpful to read values directly.
Special licenses are needed to access this interface.
name recognizable by the instrument
value of that key which can be null. The value is also null if the key is not found.
true if the value was found, false otherwise
This namespace covers the single extension that Exactive-based instruments have in addition
to standard instruments' value control. Some Set/Readback values nodes allow to perform additional
actions on Exactive based instruments.
You can simply cast an
to an
on an Exactive based instrument.
This interface describes the extensions to IControl by Exactive based instruments.
In the following example "access"
has to be assigned elsewhere.
IInstrumentAccess access;
IControl control = access.Control;
IExactiveControl exactiveControl = control as IExactiveControl;
if (exactiveControl == null)
{
Console.WriteLine("Exactive extensions are not available");
}
Get access to the instrument values that can be accessed individually.
The returned instance is helpful for status control and direct value
manipulation.
A synchroneous change of several scan-related elements should better
be performed using .
This property is the instrument-specific implementation for Exactive-based instruments.
Get access to the acquisition interface.
This property is the instrument-specific implementation for Exactive-based instruments.
Get access to the tunefile control implementation.
The returned instance is helpful for managing the current tunefile
in the instrument.
This special workflow restricts an acquisition to a specific count of scans
to be taken by the instrument. Scans acquired using the interface
are not counted.
The current tune parameters of the instrument will be used.
The number of scans to be taken during this acquisition. The number must
be positive and must not exceed 1000000.
A strongly-typed resource class, for looking up localized strings, etc.
Returns the cached ResourceManager instance used by this class.
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
This namespace covers the single extension that Exactive-based instruments have in addition
to standard instruments. The user role management allows to determine the current user role as well
as setting a different role or determine access rights.
You can simply cast an
to an
on an Exactive based instrument.