MockPlugin.Device.MockDevice Class Reference

A chronos plugin implementation for a fake device. We pretend we are controlling a mixture of coffee machine and waiter robot. More...

Inheritance diagram for MockPlugin.Device.MockDevice:

Collaboration diagram for MockPlugin.Device.MockDevice:

Public Member Functions
	MockDevice ()
void	Dispose ()
void	BrewFrappuccino (BrewFrappuccino.CompositionData composition)
	Pretend we are doing some operation on a complex parameter set. More...
void	SomeDummyMethod ()
	Just for testing if methods of this device can be called from some other point in our code. More...
void	Connect ()
	Inform the user of our connect attempt / success. Instead of establishing a real connection, show some message box. More...
void	Disconnect ()
	Pretend we are closing the connection. Actual operation substituted by a message box. More...
void	ShowTheMessage (string messageText)
	Let our device set a status message and display some message box instead of doing real work. More...
void	TriggerAbort (string reason, bool softStop)
	This will trigger the AbortSchedule-Event 5 seconds after it was called from a task. More...
void	CheckForAbort ()
Task	ApplyParametersAsync (bool waitUntilSetpointIsReached, CancellationToken canToken)
void	WaitIfPaused ()
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IHaveMachineParameters< CoffeMakerParams >
Task	ApplyParametersAsync (bool waitUntilSetpointIsReached, CancellationToken cancelToken)
	Set the given parameters on the device. More...

Static Public Attributes
const string	DeviceTypeName = "ACME Coffee Maker"

Properties
string	DisplayedTypeName [get]
	Visible to the user on the instruments page of the settings editor. More...
string	DeviceTypeDescription [get]
	Device class specification referred to by some messages. More...
string	Name [get, set]
string	Connection = "COM17" [get, set]
	Connection as set in the Chronos instrument settings. More...
bool	IsConnected [get, set]
	Helper for our toolbox. More...
CoffeMakerParams	Parameters = new CoffeMakerParams() [get, set]
bool	Aborted [get, set]
bool	Paused [get, set]
IEnumerable< string >	LogPaths [get]
Func< StopRunArgs, Task >	StopRun [get, set]
IScheduleEvents	ScheduleEvents [set]
Properties inherited from AxelSemrau.Chronos.Plugin.IDevice
string	DisplayedTypeName [get]
	Text which is displayed in the instruments settings "Autosampler Type" column and in many other places. More...
string	DeviceTypeDescription [get]
	Text which is displayed to make clear which kind of device a named sampler is. More...
string	Name [get, set]
	User-selected name for the device instance. More...
Properties inherited from AxelSemrau.Chronos.Plugin.INeedAConnection
string	Connection [get, set]
	Name of a serial port, IP address, hostname.... More...
Properties inherited from AxelSemrau.Chronos.Plugin.ICanInterrupt
bool	Aborted [get, set]
	If set, abort execution as soon as possible. You can throw an OperationCanceledException. Well be set to false after termination of the run. More...
bool	Paused [get, set]
	If paused, wait until paused is reset before executing the next command. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IHaveMachineParameters< CoffeMakerParams >
ParamType	Parameters [get, set]
	Your parameter set. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IProvideDiagnosticLogs
IEnumerable< string >	LogPaths [get]
	Provide full paths to each of your log files here. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IStopRuns
Func< StopRunArgs, Task >	StopRun [set]
	Callback function returning a task that completes once the schedule queue was stopped. More...
Properties inherited from AxelSemrau.Chronos.Plugin.IScheduleStateAware
IScheduleEvents	ScheduleEvents [set]
	Hook up immediately or save this for later use. More...

Events
Action< ConnectionState >	ConnectionStateChanged
Action< string >	SetStatusMessage
Action< string >	DebugOutput
PropertyChangedEventHandler	PropertyChanged
Action< string >	AbortSchedule
Events inherited from AxelSemrau.Chronos.Plugin.IDevice
Action< ConnectionState >	ConnectionStateChanged
	Raise this event when your connection state has changed. More...
Events inherited from AxelSemrau.Chronos.Plugin.IProvideStatusMessages
Action< string >	SetStatusMessage
	Raise this event to set your current status while doing something on the device. Messages passed to this event will be shown in the "Autosampler status" line. More...
Events inherited from AxelSemrau.Chronos.Plugin.IHaveDebugOutput
Action< string >	DebugOutput
	Messages passed to this event will be logged (including a timestamp) to the user configured debug logfile. More...
Events inherited from AxelSemrau.Chronos.Plugin.IAbortSchedules
Action< string >	AbortSchedule
	If you raise this event, the schedule will be aborted. More...

Private Member Functions
void	OnIsConnectedChanged ()
	For thread-safe update of the toolbox's GUI elements representing the connection state. More...
void	ScheduleStateChangedHandler (object sender, ScheduleStateEventArgs e)

Private Attributes
bool	mIsConnected
readonly ManualResetEventSlim	mPauseEnded = new ManualResetEventSlim(true)
	Using an event here instead of a simple bool helps us avoid polling while checking for the events. More...
readonly ManualResetEventSlim	mAborted = new ManualResetEventSlim(false)
IScheduleEvents	mScheduleEvents

Detailed Description

A chronos plugin implementation for a fake device. We pretend we are controlling a mixture of coffee machine and waiter robot.

Just an example implementation that doesn't do any real work.

Definition at line 37 of file MockDevice.cs.

Constructor & Destructor Documentation

MockDevice()

MockPlugin.Device.MockDevice.MockDevice

(

)

Definition at line 61 of file MockDevice.cs.

        {
            Instances.Add(this);
        }

Member Function Documentation

ApplyParametersAsync()

Task MockPlugin.Device.MockDevice.ApplyParametersAsync	(	bool	waitUntilSetpointIsReached,
		CancellationToken	canToken
	)

Definition at line 265 of file MockDevice.cs.

        {
            
            SetStatusMessage?.Invoke($"Applying parameters: '{Parameters}' and {(!waitUntilSetpointIsReached ? "not " : "")} waiting for setpoint.");
            if (waitUntilSetpointIsReached)
            {
                return Task.Delay(TimeSpan.FromSeconds(10),canToken);
            }
            return Task.CompletedTask;
        }

References MockPlugin.Device.MockDevice.SetStatusMessage.

BrewFrappuccino()

void MockPlugin.Device.MockDevice.BrewFrappuccino

(

BrewFrappuccino.CompositionData

composition

)

Pretend we are doing some operation on a complex parameter set.

Parameters

composition

Definition at line 94 of file MockDevice.cs.

        {
            WaitIfPaused();
            ShowTheMessage(
                $"Making a {composition.Volume} mL frappuccino with cream type \"{composition.Cream}\"{(composition.DeCaffeinated ? ", decaffeinated." : "")}.");
        }

References MockPlugin.Device.MockDevice.ShowTheMessage(), and MockPlugin.Device.MockDevice.WaitIfPaused().

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

CheckForAbort()

void MockPlugin.Device.MockDevice.CheckForAbort

(

)

Definition at line 251 of file MockDevice.cs.

        {
            if (mAborted.IsSet)
            {
                throw new OperationCanceledException("Aborted");
            }
        }

References MockPlugin.Device.MockDevice.mAborted.

Referenced by MockPlugin.Device.MockDevice.WaitIfPaused().

Connect()

void MockPlugin.Device.MockDevice.Connect

(

)

Inform the user of our connect attempt / success. Instead of establishing a real connection, show some message box.

Implements AxelSemrau.Chronos.Plugin.IDevice.

Definition at line 112 of file MockDevice.cs.

        {
            ConnectionStateChanged(ConnectionState.Connecting);
            MessageBox.Show(Helpers.Gui.MainWindow, $"Device {Name} was connected to {Connection}.");
            ConnectionStateChanged(ConnectionState.Connected);
            mIsConnected = true;
            OnIsConnectedChanged();
        }

References MockPlugin.Device.MockDevice.ConnectionStateChanged, AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, MockPlugin.Device.MockDevice.mIsConnected, and MockPlugin.Device.MockDevice.OnIsConnectedChanged().

Disconnect()

void MockPlugin.Device.MockDevice.Disconnect

(

)

Pretend we are closing the connection. Actual operation substituted by a message box.

Implements AxelSemrau.Chronos.Plugin.IDevice.

Definition at line 124 of file MockDevice.cs.

        {
            ConnectionStateChanged(ConnectionState.Disconnecting);
            MessageBox.Show(Helpers.Gui.MainWindow, $"Device {Name} was disconnected from {Connection}.");
            ConnectionStateChanged(ConnectionState.Disconnected);
            mIsConnected = false;
            OnIsConnectedChanged();
        }

References MockPlugin.Device.MockDevice.ConnectionStateChanged, AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, MockPlugin.Device.MockDevice.mIsConnected, and MockPlugin.Device.MockDevice.OnIsConnectedChanged().

Dispose()

void MockPlugin.Device.MockDevice.Dispose

(

)

Definition at line 68 of file MockDevice.cs.

        {
            Instances.Remove(this);
            DebugOutput?.Invoke($"MockDevice {Name} disposed");
        }

References MockPlugin.Device.MockDevice.DebugOutput.

OnIsConnectedChanged()

void MockPlugin.Device.MockDevice.OnIsConnectedChanged ( )

private

For thread-safe update of the toolbox's GUI elements representing the connection state.

Definition at line 205 of file MockDevice.cs.

        {
            var myHandler = PropertyChanged;
            if (myHandler != null)
            {
                Helpers.Gui.GuiTaskFactory.StartNew(() => myHandler(this, new PropertyChangedEventArgs(nameof(IsConnected))));
            }
        }

References AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.GuiTaskFactory, MockPlugin.Device.MockDevice.IsConnected, and MockPlugin.Device.MockDevice.PropertyChanged.

Referenced by MockPlugin.Device.MockDevice.Connect(), and MockPlugin.Device.MockDevice.Disconnect().

ScheduleStateChangedHandler()

void MockPlugin.Device.MockDevice.ScheduleStateChangedHandler ( object  sender, ScheduleStateEventArgs  e  )

private

Definition at line 346 of file MockDevice.cs.

        {
            DebugOutput?.Invoke($"Schedule {e.PlanerName} ({e.PlanerID}) state {e.State}, abort reason {(string.IsNullOrEmpty(e.AbortReason) ? "N/A" : e.AbortReason)}");   
        }

References MockPlugin.Device.MockDevice.DebugOutput.

ShowTheMessage()

void MockPlugin.Device.MockDevice.ShowTheMessage

(

string

messageText

)

Let our device set a status message and display some message box instead of doing real work.

Parameters

messageText

Definition at line 156 of file MockDevice.cs.

        {
            WaitIfPaused();
            SetStatusMessage?.Invoke("The device just did something wonderful.");
            MessageBox.Show(Helpers.Gui.MainWindow,
                $"The following message was shown addressing the mock device {Name}:\r\n{messageText}",
                "Mock Device",
                MessageBoxButtons.OK);
            DebugOutput?.Invoke($"Finished showing the message {messageText}");
        }

References MockPlugin.Device.MockDevice.DebugOutput, AxelSemrau.Chronos.Plugin.Helpers.Gui, AxelSemrau.Chronos.Plugin.IGuiHelper.MainWindow, MockPlugin.Device.MockDevice.SetStatusMessage, and MockPlugin.Device.MockDevice.WaitIfPaused().

Referenced by MockPlugin.Device.MockDevice.BrewFrappuccino(), MockPlugin.Device.MockDeviceToolbox.btnShowMessage_Click(), and MockPlugin.Tasks.BrewCoffee.Execute().

SomeDummyMethod()

void MockPlugin.Device.MockDevice.SomeDummyMethod

(

)

Just for testing if methods of this device can be called from some other point in our code.

Definition at line 104 of file MockDevice.cs.

        {
            DebugOutput?.Invoke($"Dummy method of {Name} was called.");
        }

References MockPlugin.Device.MockDevice.DebugOutput.

TriggerAbort()

void MockPlugin.Device.MockDevice.TriggerAbort	(	string	reason,
		bool	softStop
	)

This will trigger the AbortSchedule-Event 5 seconds after it was called from a task.

Parameters

reason
softStop

For a real device, this would be something like a leak, a failed pump or heater or anything else that makes it impossible to operate the device properly.

Definition at line 229 of file MockDevice.cs.

        {
            Task.Run(() =>
                     {
                         Thread.Sleep(5000);
                         if (softStop)
                         {
                             StopRun?.Invoke(new StopRunArgs()
                             {
                                 How = StopRunArgs.StopMode.NoNewJobs, StopQueue = true, Reason = reason,
                                 RestartRemainingJobs = false
                             });
                         }
                         else
                         {
                             AbortSchedule?.Invoke(reason);
                         }
                     });
}

References MockPlugin.Device.MockDevice.AbortSchedule, and MockPlugin.Device.MockDevice.StopRun.

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

WaitIfPaused()

void MockPlugin.Device.MockDevice.WaitIfPaused

(

)

Definition at line 278 of file MockDevice.cs.

        {
            WaitHandle.WaitAny(new[] { mPauseEnded.WaitHandle, mAborted.WaitHandle });
            CheckForAbort();
        }

References MockPlugin.Device.MockDevice.CheckForAbort(), MockPlugin.Device.MockDevice.mAborted, and MockPlugin.Device.MockDevice.mPauseEnded.

Referenced by MockPlugin.Device.MockDevice.BrewFrappuccino(), and MockPlugin.Device.MockDevice.ShowTheMessage().

Member Data Documentation

DeviceTypeName

const string MockPlugin.Device.MockDevice.DeviceTypeName = "ACME Coffee Maker"

static

Definition at line 52 of file MockDevice.cs.

mAborted

readonly ManualResetEventSlim MockPlugin.Device.MockDevice.mAborted = new ManualResetEventSlim(false)

private

Definition at line 291 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.CheckForAbort(), and MockPlugin.Device.MockDevice.WaitIfPaused().

mIsConnected

bool MockPlugin.Device.MockDevice.mIsConnected

private

Definition at line 55 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.Connect(), and MockPlugin.Device.MockDevice.Disconnect().

mPauseEnded

readonly ManualResetEventSlim MockPlugin.Device.MockDevice.mPauseEnded = new ManualResetEventSlim(true)

private

Using an event here instead of a simple bool helps us avoid polling while checking for the events.

Definition at line 289 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.WaitIfPaused().

mScheduleEvents

IScheduleEvents MockPlugin.Device.MockDevice.mScheduleEvents

private

Definition at line 327 of file MockDevice.cs.

Property Documentation

Aborted

bool MockPlugin.Device.MockDevice.Aborted

getset

Definition at line 293 of file MockDevice.cs.

        {
            get => mAborted.IsSet;
            set
            {
                if (value) { mAborted.Set(); } else { mAborted.Reset(); }
            }
        }

Connection

string MockPlugin.Device.MockDevice.Connection = "COM17"

getset

Connection as set in the Chronos instrument settings.

If this gets a bit more complicated, you can also use a UITypeEditor here.

Definition at line 146 of file MockDevice.cs.

{ get; set; } = "COM17";

DeviceTypeDescription

string MockPlugin.Device.MockDevice.DeviceTypeDescription

get

Device class specification referred to by some messages.

Definition at line 82 of file MockDevice.cs.

DisplayedTypeName

string MockPlugin.Device.MockDevice.DisplayedTypeName

get

Visible to the user on the instruments page of the settings editor.

Definition at line 77 of file MockDevice.cs.

IsConnected

bool MockPlugin.Device.MockDevice.IsConnected

getset

Helper for our toolbox.

Definition at line 170 of file MockDevice.cs.

        {
            get => mIsConnected;
            set
            {
                if (!mIsConnected && value)
                {
                    Connect();
                }
                else if (mIsConnected && !value)
                {
                    Disconnect();
                }
            }
        }

Referenced by MockPlugin.Device.MockDevice.OnIsConnectedChanged().

LogPaths

IEnumerable<string> MockPlugin.Device.MockDevice.LogPaths

get

Definition at line 320 of file MockDevice.cs.

Name

string MockPlugin.Device.MockDevice.Name

getset

Definition at line 84 of file MockDevice.cs.

        {
            get;
            set;
        }

Referenced by MockPlugin.Tasks.BrewCoffee.RegisterCoffeeConsumption(), MockPlugin.Tasks.BrewFrappuccino.RegisterConsumption(), and MockPlugin.Misc.StatusViewControl.timer1_Tick().

Parameters

CoffeMakerParams MockPlugin.Device.MockDevice.Parameters = new CoffeMakerParams()

getset

Definition at line 263 of file MockDevice.cs.

{ get; set; } = new CoffeMakerParams();

Paused

bool MockPlugin.Device.MockDevice.Paused

getset

Definition at line 302 of file MockDevice.cs.

        {
            get => !mPauseEnded.IsSet;
            set
            {
                if (value)
                {
                    mPauseEnded.Reset();
                }
                else
                {
                    mPauseEnded.Set();
                }
            }
        }

ScheduleEvents

IScheduleEvents MockPlugin.Device.MockDevice.ScheduleEvents

set

Definition at line 329 of file MockDevice.cs.

        {
            set
            {
                if (mScheduleEvents != null)
                {
                    mScheduleEvents.ScheduleStateChanged -= ScheduleStateChangedHandler;
                }
 
                mScheduleEvents = value;
                if (value != null)
                {
                    mScheduleEvents.ScheduleStateChanged += ScheduleStateChangedHandler;
                }
            }
        }

StopRun

Func<StopRunArgs, Task> MockPlugin.Device.MockDevice.StopRun

getset

Definition at line 323 of file MockDevice.cs.

{ get; set; }

Referenced by MockPlugin.Device.MockDevice.TriggerAbort().

Event Documentation

AbortSchedule

Action<string> MockPlugin.Device.MockDevice.AbortSchedule

Definition at line 249 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.TriggerAbort().

ConnectionStateChanged

Action<ConnectionState> MockPlugin.Device.MockDevice.ConnectionStateChanged

Definition at line 133 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.Connect(), and MockPlugin.Device.MockDevice.Disconnect().

DebugOutput

Action<string> MockPlugin.Device.MockDevice.DebugOutput

Definition at line 196 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.Dispose(), MockPlugin.Device.MockDevice.ScheduleStateChangedHandler(), MockPlugin.Device.MockDevice.ShowTheMessage(), and MockPlugin.Device.MockDevice.SomeDummyMethod().

PropertyChanged

PropertyChangedEventHandler MockPlugin.Device.MockDevice.PropertyChanged

Definition at line 214 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.OnIsConnectedChanged().

SetStatusMessage

Action<string> MockPlugin.Device.MockDevice.SetStatusMessage

Definition at line 190 of file MockDevice.cs.

Referenced by MockPlugin.Device.MockDevice.ApplyParametersAsync(), and MockPlugin.Device.MockDevice.ShowTheMessage().

---

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

• MockDevice.cs