Chronos Plugins 5.9.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
MockPlugin.AcquisitionService.MockDynamicParAcquisitionService Class Reference

Acquisition service for a parameter class that has a variable number of properties. More...

+ Inheritance diagram for MockPlugin.AcquisitionService.MockDynamicParAcquisitionService:
+ Collaboration diagram for MockPlugin.AcquisitionService.MockDynamicParAcquisitionService:

Public Member Functions

void Validate (DynamicAcqPars parameters)
 
void RunAcquisition (DynamicAcqPars parameters)
 
void GoToStandby ()
 Send the system to standby mode.
 
- Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IAcquisitionService< DynamicAcqPars >
void Validate (TParam parameters)
 Check the given parameters and throw an exception if they are invalid.
 
void RunAcquisition (TParam parameters)
 Send the acquisition parameters to the CDS.
 
- Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IStandbySupportingAcquisitionService

Properties

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 = false [set, private get]
 Will be set to true if you should abort the current acquisition. Will be set to false when everything is back to normal.
 
- Properties inherited from AxelSemrau.Chronos.Plugin.IAcquisitionServiceBase

Events

Action< string > WriteToRunlog
 
- Events inherited from AxelSemrau.Chronos.Plugin.IHaveRunlogOutput
Action< string > WriteToRunlog
 Use this event to send output to the Run Control / Runlog page and, if applicable, to the runlog file.
 

Detailed Description

Acquisition service for a parameter class that has a variable number of properties.

Definition at line 133 of file MockDynamicParAcquisitionService.cs.

Member Function Documentation

◆ GoToStandby()

void MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.GoToStandby ( )

Send the system to standby mode.

Implements AxelSemrau.Chronos.Plugin.IStandbySupportingAcquisitionService.

Definition at line 158 of file MockDynamicParAcquisitionService.cs.

159 {
160 WriteToRunlog?.Invoke("Mock acquisition service going to standby mode");
161 }

References MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.WriteToRunlog.

◆ RunAcquisition()

void MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.RunAcquisition ( DynamicAcqPars parameters)

Definition at line 151 of file MockDynamicParAcquisitionService.cs.

152 {
153 // nothing
154 }

◆ Validate()

void MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.Validate ( DynamicAcqPars parameters)

Definition at line 146 of file MockDynamicParAcquisitionService.cs.

147 {
148 // nothing
149 }

Property Documentation

◆ Abort

bool MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.Abort = false
setprivate get

Will be set to true if you should abort the current acquisition. Will be set to false when everything is back to normal.

Implements AxelSemrau.Chronos.Plugin.IAcquisitionServiceBase.

Definition at line 140 of file MockDynamicParAcquisitionService.cs.

140{ private get; set; } = false;

◆ IsAvailable

bool MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.IsAvailable
get

The place to check if you can actually use the acquisition service.

Implements AxelSemrau.Chronos.Plugin.IAcquisitionServiceBase.

Definition at line 138 of file MockDynamicParAcquisitionService.cs.

◆ Name

string MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.Name
get

Name that is visible to the user in the list of acquisition services. Do not localize.

Implements AxelSemrau.Chronos.Plugin.IAcquisitionServiceBase.

Definition at line 137 of file MockDynamicParAcquisitionService.cs.

Event Documentation

◆ WriteToRunlog

Action<string> MockPlugin.AcquisitionService.MockDynamicParAcquisitionService.WriteToRunlog

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