MockPlugin.Tasks.BrewFrappuccino Class Reference

A task working on a complex parameter set. More...

Inheritance diagram for MockPlugin.Tasks.BrewFrappuccino:

Collaboration diagram for MockPlugin.Tasks.BrewFrappuccino:

Classes
class	CompositionData
	Let's pretend the composition is really complex and better done with a custom editor. More...
class	CompositionEditor
	Provide an editor for our complex parameter set, the standard component model way. More...

Public Types
enum	CreamType { Normal , LowFat , Vegan }
	Enum properties result in nice drop-down lists. More...

Public Member Functions
override string	GetTaskAction ()
	Description of the tasks's action (for hints/time table)
	BrewFrappuccino ()
override void	Execute ()
	Send the recipe to our device.
override void	PostValidate ()
	Called after the schedule construction is completed.
void	PropertyEdited (string propName, object propValue)
	The method editor informs us about changed values.
Public Member Functions inherited from MockPlugin.Tasks.CoffeeMachineBaseTask
void	SetDevice (IDevice yourDevice)
virtual void	PreValidate ()
	Called before 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.ITask
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.ITaskForDevice
void	SetDevice (IDevice yourDevice)
	Will be called by chronos when building the schedule.
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IWantEditorUpdates

Properties
CompositionData	Composition [get, set]
	Our extremely complex composition which could in no way be done with normal text-editable properties.
uint	Volume [get, set]
uint	CupSize [get, set]
int?	CalculatedRuntime [get]
	Return some fake runtimes depending on the requested volume.
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
Properties inherited from AxelSemrau.Chronos.Plugin.IGiveARuntimeHint

Events
PropertyChangedEventHandler	PropertyChanged

Private Member Functions
void	RegisterConsumption (CompositionData composition)
	Register consumption of coffee / cream with the consumables tracker.

Private Attributes
CompositionData	mComposition
MockDevice	mDevInEditor

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

A task working on a complex parameter set.

This task has some more complex property which is assumed to be not suitable for simple text editing and token substitution or calculations. Therefore, we have to provide an editor of our own. The property data will be serialized and stored within the Chronos method. The Volume parameter can also be set directly from the method editor like a normal property. Additionally, the task has a rough idea of how long it can take.

Definition at line 140 of file MockUseDeviceTasks.cs.

Member Enumeration Documentation

CreamType

enum MockPlugin.Tasks.BrewFrappuccino.CreamType

Enum properties result in nice drop-down lists.

Enumerator
Normal
LowFat
Vegan

Definition at line 146 of file MockUseDeviceTasks.cs.

        {
            Normal,
            LowFat,
            Vegan
        }

Constructor & Destructor Documentation

BrewFrappuccino()

MockPlugin.Tasks.BrewFrappuccino.BrewFrappuccino

(

)

Definition at line 293 of file MockUseDeviceTasks.cs.

        {
            Composition = new CompositionData();
            CupSize = 250;
        }

References MockPlugin.Tasks.BrewFrappuccino.Composition, and MockPlugin.Tasks.BrewFrappuccino.CupSize.

Member Function Documentation

Execute()

override void MockPlugin.Tasks.BrewFrappuccino.Execute

(

)

Send the recipe to our device.

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 302 of file MockUseDeviceTasks.cs.

        {
            mDevice.BrewFrappuccino(Composition);
            RegisterConsumption(Composition);
        }

References MockPlugin.Device.MockDevice.BrewFrappuccino(), MockPlugin.Tasks.BrewFrappuccino.Composition, MockPlugin.Tasks.CoffeeMachineBaseTask.mDevice, and MockPlugin.Tasks.BrewFrappuccino.RegisterConsumption().

GetTaskAction()

override string MockPlugin.Tasks.BrewFrappuccino.GetTaskAction

(

)

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

Implements AxelSemrau.Chronos.Plugin.ITask.

Definition at line 265 of file MockUseDeviceTasks.cs.

        {
            return LocalizeMockPlugin.BrewFrappuccino_GetTaskAction_Brew_a_frappuccino__composition__ + Composition;
        }

References MockPlugin.Tasks.BrewFrappuccino.Composition.

PostValidate()

override void MockPlugin.Tasks.BrewFrappuccino.PostValidate ( )

virtual

Called after the schedule construction is completed.

Reimplemented from MockPlugin.Tasks.CoffeeMachineBaseTask.

Definition at line 308 of file MockUseDeviceTasks.cs.

        {
            RegisterConsumption(Composition);
        }

References MockPlugin.Tasks.BrewFrappuccino.Composition, and MockPlugin.Tasks.BrewFrappuccino.RegisterConsumption().

PropertyEdited()

void MockPlugin.Tasks.BrewFrappuccino.PropertyEdited	(	string	propName,
		object	propValue )

The method editor informs us about changed values.

Parameters

propName
propValue

It is possible that the given propValue can not be converted to our property type - for example, if there is a calculation or a reference to a different task's property in the method editor field.

Implements AxelSemrau.Chronos.Plugin.IWantEditorUpdates.

Definition at line 351 of file MockUseDeviceTasks.cs.

        {
            if (propName == nameof(Volume))
            {
                // the uint32 converter can't convert from uint32 to uint32 but throws an exception.
                if (propValue is uint u)
                {
                    Volume = u;
                }
                else
                {
                    var conv = TypeDescriptor.GetConverter(Volume, true);
                    if (conv.IsValid(propValue))
                    {
                        // ReSharper disable once PossibleNullReferenceException
                        Volume = (uint)conv.ConvertFrom(null, System.Globalization.CultureInfo.InvariantCulture, propValue);
                    }
                }
            }
            else if (propName == "Autosampler")
            {
                mDevInEditor = MockDevice.Instances.FirstOrDefault(someDev => someDev.Name == propValue?.ToString());
                if (mComposition != null)
                {
                    mComposition.DevInEditor = mDevInEditor;
                }
            }           
        }

References MockPlugin.Tasks.BrewFrappuccino.mComposition, MockPlugin.Tasks.BrewFrappuccino.mDevInEditor, and MockPlugin.Tasks.BrewFrappuccino.Volume.

RegisterConsumption()

void MockPlugin.Tasks.BrewFrappuccino.RegisterConsumption ( CompositionData composition )

private

Register consumption of coffee / cream with the consumables tracker.

Parameters

composition

Definition at line 317 of file MockUseDeviceTasks.cs.

        {
            var sizeFactor = composition.Volume / 125.0;
            Consumables.ModifyLevel(CoffeeConsumableManager.GetLocationIdentifier(mDevice,MockConsumablesForCoffeeMakerDevice.Coffee.Name),new Quantity(-7*sizeFactor, Units.Gram));
            string creamName;
            switch (composition.Cream)
            {
                case CreamType.LowFat:
                    // intentionally picked name of a component that is not tracked. Results just in a log entry, not visible on tracker's page.
                    creamName = "Low Fat Milk";
                    break;
                case CreamType.Normal:
                    creamName = MockConsumablesForCoffeeMakerDevice.Milk.Name;
                    break;
                case CreamType.Vegan:
                    creamName = MockConsumablesForCoffeeMakerDevice.VeganCream.Name;
                    break;
                default:
                    creamName = "";
                    break;
            }
            Consumables.ModifyLevel(CoffeeConsumableManager.GetLocationIdentifier(mDevice, creamName),new Quantity(-10*sizeFactor,Units.MilliLiter));
        }

References MockPlugin.Tasks.CoffeeMachineBaseTask.Consumables, MockPlugin.Tasks.BrewFrappuccino.CompositionData.Cream, MockPlugin.Consumables.CoffeeConsumableManager.GetLocationIdentifier(), MockPlugin.Tasks.CoffeeMachineBaseTask.mDevice, AxelSemrau.Chronos.Plugin.Consumables.IConsumableManipulator.ModifyLevel(), and MockPlugin.Device.MockDevice.Name.

Referenced by MockPlugin.Tasks.BrewFrappuccino.Execute(), and MockPlugin.Tasks.BrewFrappuccino.PostValidate().

Member Data Documentation

mComposition

CompositionData MockPlugin.Tasks.BrewFrappuccino.mComposition

private

Definition at line 238 of file MockUseDeviceTasks.cs.

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

mDevInEditor

MockDevice MockPlugin.Tasks.BrewFrappuccino.mDevInEditor

private

Definition at line 380 of file MockUseDeviceTasks.cs.

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

Property Documentation

CalculatedRuntime

int? MockPlugin.Tasks.BrewFrappuccino.CalculatedRuntime

get

Return some fake runtimes depending on the requested volume.

Implements AxelSemrau.Chronos.Plugin.IGiveARuntimeHint.

Definition at line 389 of file MockUseDeviceTasks.cs.

        {
            get
            {
                if (Volume > 250)
                {
                    return 30;
                }
 
                if (Volume > 100)
                {
                    return 15;
                }
 
                return 10;
            }
        }

Composition

CompositionData MockPlugin.Tasks.BrewFrappuccino.Composition

getset

Our extremely complex composition which could in no way be done with normal text-editable properties.

Definition at line 244 of file MockUseDeviceTasks.cs.

        {
            get
            {
                if (mComposition != null && mComposition.DevInEditor == null)
                {
                    mComposition.DevInEditor = mDevInEditor;
                }
                return mComposition;
            }
            set 
            { 
                mComposition = value;
                if (mComposition != null)
                {
                    mComposition.DevInEditor = mDevInEditor;
                }
                RaiseVolumeChanged();
            }
        }

Referenced by MockPlugin.Tasks.BrewFrappuccino.BrewFrappuccino(), MockPlugin.Tasks.BrewFrappuccino.Execute(), MockPlugin.Tasks.BrewFrappuccino.GetTaskAction(), and MockPlugin.Tasks.BrewFrappuccino.PostValidate().

CupSize

uint MockPlugin.Tasks.BrewFrappuccino.CupSize

getset

Definition at line 287 of file MockUseDeviceTasks.cs.

        {
            get;
            set;
        }

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

Volume

uint MockPlugin.Tasks.BrewFrappuccino.Volume

getset

Definition at line 272 of file MockUseDeviceTasks.cs.

        {
            get => mComposition.Volume;
            set
            {
                if(mComposition.Volume == value) return;
                mComposition.Volume = value;
                RaiseVolumeChanged();
            }
        }

Referenced by MockPlugin.Tasks.FrappuccinoCompositionEditor.CopyDataToGui(), and MockPlugin.Tasks.BrewFrappuccino.PropertyEdited().

Event Documentation

PropertyChanged

PropertyChangedEventHandler MockPlugin.Tasks.BrewFrappuccino.PropertyChanged

Definition at line 382 of file MockUseDeviceTasks.cs.

---

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

• MockUseDeviceTasks.cs