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

This task will trigger a timer in our device which will make it complain about an error situation, even if at that time no task is trying to use it. More...

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

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

bool SoftStop [get, set]
 
- 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

This task will trigger a timer in our device which will make it complain about an error situation, even if at that time no task is trying to use it.

Definition at line 415 of file MockUseDeviceTasks.cs.

Member Function Documentation

◆ Execute()

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

Do whatever you have to do with your parameters.

Implements MockPlugin.Tasks.CoffeeMachineBaseTask.

Definition at line 418 of file MockUseDeviceTasks.cs.

419 {
420 mDevice.TriggerAbort(LocalizeMockPlugin
421 .PretendCoffeeMachineIsBroken_Execute_The_coffee_machine_s_heater_failed_,SoftStop);
422 }
void TriggerAbort(string reason, bool softStop)
This will trigger the AbortSchedule-Event 5 seconds after it was called from a task.
Definition: MockDevice.cs:231

References MockPlugin.Tasks.CoffeeMachineBaseTask.mDevice, MockPlugin.Tasks.PretendCoffeeMachineIsBroken.SoftStop, and MockPlugin.Device.MockDevice.TriggerAbort().

◆ GetTaskAction()

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

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

Implements MockPlugin.Tasks.CoffeeMachineBaseTask.

Definition at line 424 of file MockUseDeviceTasks.cs.

425 {
426 return String.Format(LocalizeMockPlugin.PretendCoffeeMachineIsBroken_GetTaskAction_Will_make_the_device_abort_the_schedule_after_a_few_seconds_,SoftStop);
427 }

References MockPlugin.Tasks.PretendCoffeeMachineIsBroken.SoftStop.

Property Documentation

◆ SoftStop

bool MockPlugin.Tasks.PretendCoffeeMachineIsBroken.SoftStop
getset

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