Chronos Plugins  5.2.0
This documentation covers the plugin interfaces definitions and an example implementation.
AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam > Interface Template Reference

Implement this interface if you want to support soft handshaking (read: not by cable) for your acquisition service. More...

+ Inheritance diagram for AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam >:
+ Collaboration diagram for AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam >:

Public Member Functions

bool RequiresFeedback (TParam parameters)
 Tell Chronos if you really need soft handshake for this specific parameter set. More...
 
void JobFinished (TParam parameters)
 If you required feedback for a set of parameters, and the job containing the matching injection finished, this method will be called to make sure you don't wait forever in case the injection didn't happen for some reason. More...
 
void Injected (TParam parameters)
 Will be called as closely as possible to the moment of the injection. More...
 
- Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IAcquisitionService< TParam >
void Validate (TParam parameters)
 Check the given parameters and throw an exception if they are invalid. More...
 
void RunAcquisition (TParam parameters)
 Send the acquisition parameters to the CDS. More...
 

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. More...
 
bool IsAvailable [get]
 The place to check if you can actually use the acquisition service. More...
 
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. More...
 

Detailed Description

Implement this interface if you want to support soft handshaking (read: not by cable) for your acquisition service.

Template Parameters
TParam
Type Constraints
TParam :class 
TParam :new() 

Definition at line 66 of file AcquisitionInterfaces.cs.

Member Function Documentation

◆ Injected()

void AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam >.Injected ( TParam  parameters)

Will be called as closely as possible to the moment of the injection.

Parameters
parameters

◆ JobFinished()

void AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam >.JobFinished ( TParam  parameters)

If you required feedback for a set of parameters, and the job containing the matching injection finished, this method will be called to make sure you don't wait forever in case the injection didn't happen for some reason.

Parameters
parameters

◆ RequiresFeedback()

bool AxelSemrau.Chronos.Plugin.ISoftHandshakingAcquisitionService< TParam >.RequiresFeedback ( TParam  parameters)

Tell Chronos if you really need soft handshake for this specific parameter set.

Parameters
parameters
Returns

Some systems can support hardware or software handshake, depending on the parameters. If you require feedback, and Chronos can't identify the matching injection for your acquisition, this will result in an error.


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