Chronos Plugins 5.9.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
AxelSemrau.Chronos.Plugin.ICommandUsingAcquisitionService< TCommandAndParameters > Interface Template Reference

Implement this interface if your acquisition service supports some kind of utility commands that could be run from a method. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.ICommandUsingAcquisitionService< TCommandAndParameters >:
+ Collaboration diagram for AxelSemrau.Chronos.Plugin.ICommandUsingAcquisitionService< TCommandAndParameters >:

Public Member Functions

void ValidateCommand (TCommandAndParameters cmdAndPars)
 Please check if it is likely that you can actually execute the parameters.
 
void RunCommand (TCommandAndParameters cmdAndPars)
 Perform the actual command action.
 

Additional Inherited Members

- Properties inherited from AxelSemrau.Chronos.Plugin.IAcquisitionServiceBase
string Name [get]
 Name that is visible to the user in the list of acquisition services. Do not localize.
 
bool IsAvailable [get]
 The place to check if you can actually use the acquisition service.
 
bool Abort [set]
 Will be set to true if you should abort the current acquisition. Will be set to false when everything is back to normal.
 

Detailed Description

Implement this interface if your acquisition service supports some kind of utility commands that could be run from a method.

Template Parameters
TCommandAndParametersSome class containing all necessary information for the command execution. You could require the user to pick an instrument or select predefined options from dropdown lists here.

An example would be some option to re-calibrate a mass spectrometer between runs.

Type Constraints
TCommandAndParameters :class 
TCommandAndParameters :new() 

Definition at line 289 of file AcquisitionInterfaces.cs.

Member Function Documentation

◆ RunCommand()

void AxelSemrau.Chronos.Plugin.ICommandUsingAcquisitionService< TCommandAndParameters >.RunCommand ( TCommandAndParameters cmdAndPars)

Perform the actual command action.

Parameters
cmdAndParsThe properties of this class will be listed in the RunAcquisitionCommand task parameter list.

◆ ValidateCommand()

void AxelSemrau.Chronos.Plugin.ICommandUsingAcquisitionService< TCommandAndParameters >.ValidateCommand ( TCommandAndParameters cmdAndPars)

Please check if it is likely that you can actually execute the parameters.

Parameters
cmdAndPars

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