Chronos Plugins 5.4.0
This documentation covers the plugin interfaces definitions and an example implementation.
Loading...
Searching...
No Matches
MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly Class Reference

In contrast to PretendCoffeeMachineIsBroken, this simulates an error that an autosampler could have while it is used by a task. More...

+ Inheritance diagram for MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly:
+ Collaboration diagram for MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly:

Public Member Functions

override void Execute ()
 Do whatever you have to do with your parameters.
 
override string GetTaskAction ()
 Description of the tasks's action (for hints/time table)
 
- Public Member Functions inherited from MockPlugin.Tasks.CoffeeMachineBaseTask
void SetDevice (IDevice yourDevice)
 
virtual void PreValidate ()
 Called before the schedule construction is completed.
 
virtual void PostValidate ()
 Called after the schedule construction is completed.
 
abstract void Execute ()
 Do whatever you have to do with your parameters.
 
abstract string GetTaskAction ()
 Description of the tasks's action (for hints/time table)
 
void PreValidate ()
 Called before the schedule construction is completed.
 
void PostValidate ()
 Called after the schedule construction is completed.
 
void Execute ()
 Do whatever you have to do with your parameters.
 
string GetTaskAction ()
 Description of the tasks's action (for hints/time table)
 
- Public Member Functions inherited from AxelSemrau.Chronos.Plugin.ITaskForDevice
void SetDevice (IDevice yourDevice)
 Will be called by chronos when building the schedule.
 

Properties

string ErrorDescription = "Some random error message that is shown to the user" [get, set]
 
ErrorType ErrorType = ErrorType.MissingVial [get, set]
 
bool ResolvedAfterHandling = false [get, set]
 Should we consider the error fixed after error handling has run?
 
- Properties inherited from MockPlugin.Tasks.CoffeeMachineBaseTask
IConsumableManipulator Consumables [get, set]
 You will get an instance of a helper class that helps your task to find the correct consumable puddle.
 
- Properties inherited from AxelSemrau.Chronos.Plugin.Consumables.IConsumer
IConsumableManipulator Consumables [set]
 You will get an instance of a helper class that helps your task to find the correct consumable puddle.
 

Additional Inherited Members

- Protected Member Functions inherited from MockPlugin.Tasks.CoffeeMachineBaseTask
void CheckForCoffeeMachine (IDevice yourDevice)
 It makes no sense to use any other "Autosampler" than our fake coffee machine here.
 
- Protected Attributes inherited from MockPlugin.Tasks.CoffeeMachineBaseTask
MockDevice mDevice
 

Detailed Description

In contrast to PretendCoffeeMachineIsBroken, this simulates an error that an autosampler could have while it is used by a task.

Definition at line 433 of file MockUseDeviceTasks.cs.

Member Function Documentation

◆ Execute()

override void MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.Execute ( )
virtual

Do whatever you have to do with your parameters.

Implements MockPlugin.Tasks.CoffeeMachineBaseTask.

Definition at line 441 of file MockUseDeviceTasks.cs.

442 {
444 }
ErrorType
Lets a device implementing IHaveInteractiveErrorHandling specify which kind of error occurred.
void RaiseError(string errorDescription, ErrorType errType, bool resolved)
"Retry" here means that we don't retry some action, but that we raise the error again.
Definition: MockDevice.cs:370
bool ResolvedAfterHandling
Should we consider the error fixed after error handling has run?

References MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.ErrorDescription, MockPlugin.Tasks.CoffeeMachineBaseTask.mDevice, MockPlugin.Device.MockDevice.RaiseError(), and MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.ResolvedAfterHandling.

◆ GetTaskAction()

override string MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.GetTaskAction ( )
virtual

Description of the tasks's action (for hints/time table)

Implements MockPlugin.Tasks.CoffeeMachineBaseTask.

Definition at line 446 of file MockUseDeviceTasks.cs.

447 {
448 return $"Raising error type {ErrorType} with description \"{ErrorDescription}\"";
449 }

Property Documentation

◆ ErrorDescription

string MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.ErrorDescription = "Some random error message that is shown to the user"
getset

Definition at line 435 of file MockUseDeviceTasks.cs.

435{ get; set; } = "Some random error message that is shown to the user";

Referenced by MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.Execute().

◆ ErrorType

ErrorType MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.ErrorType = ErrorType.MissingVial
getset

Definition at line 436 of file MockUseDeviceTasks.cs.

436{ get; set; } = ErrorType.MissingVial;

◆ ResolvedAfterHandling

bool MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.ResolvedAfterHandling = false
getset

Should we consider the error fixed after error handling has run?

Definition at line 440 of file MockUseDeviceTasks.cs.

440{ get; set; } = false;

Referenced by MockPlugin.Tasks.CoffeeMachineDoesNotWorkProperly.Execute().


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