MockPlugin.Device.DeviceSurveillance Class Reference

Shows how you can directly interact with all configured devices. More...

Inheritance diagram for MockPlugin.Device.DeviceSurveillance:

Collaboration diagram for MockPlugin.Device.DeviceSurveillance:

Public Member Functions
	DeviceSurveillance (IDeviceInfoProvider infoProv)
	Requesting the device info provider via the constructor, not via "Helpers" - makes it easier to write tests for the plugin code.
void	DoYourJob ()
	Will be triggered when the user clicks on the button. The button will be disabled until you return from here.
Public Member Functions inherited from AxelSemrau.Chronos.Plugin.IWorkWithSampleLists

Properties
string	ButtonCaption [get]
	Shown on the sample list page.
Icon	ButtonIcon [get]
	Shown in the button, preferred size 22x22.
IEnumerable< IDevice >	ConfiguredDevices [set]
	List of IDevice for all configured devices in Chronos.
Properties inherited from AxelSemrau.Chronos.Plugin.IWorkWithSampleLists
Properties inherited from AxelSemrau.Chronos.Plugin.IDirectDeviceAccess

Events
EventHandler< TraceWriteEventArgs >	TraceWrite
Events inherited from AxelSemrau.Chronos.Plugin.ITraceLogger
EventHandler< TraceWriteEventArgs >	TraceWrite
	Chronos will subscribe to this event and log the text provided in the event args.

Private Member Functions
void	Trace (string txt)

Private Attributes
readonly IDeviceInfoProvider	mDeviceInfoProvider

Detailed Description

Shows how you can directly interact with all configured devices.

This way of interacting is only for very rare scenarios - you should use IToolbox or ITaskForDevice for device access whenever possible.

Definition at line 17 of file DeviceSurveillance.cs.

Constructor & Destructor Documentation

DeviceSurveillance()

MockPlugin.Device.DeviceSurveillance.DeviceSurveillance

(

IDeviceInfoProvider

infoProv

)

Requesting the device info provider via the constructor, not via "Helpers" - makes it easier to write tests for the plugin code.

Parameters

infoProv

Definition at line 25 of file DeviceSurveillance.cs.

        {
            mDeviceInfoProvider = infoProv;
        }

References MockPlugin.Device.DeviceSurveillance.mDeviceInfoProvider.

Member Function Documentation

DoYourJob()

void MockPlugin.Device.DeviceSurveillance.DoYourJob

(

)

Will be triggered when the user clicks on the button. The button will be disabled until you return from here.

Please note that this will not be run from the main GUI thread. If you have to do something on the GUI thread, use the Helpers.Gui members.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 34 of file DeviceSurveillance.cs.

        {
            // nothing to see here
        }

Trace()

void MockPlugin.Device.DeviceSurveillance.Trace ( string txt )

private

Definition at line 63 of file DeviceSurveillance.cs.

        {
            TraceWrite?.Invoke(this,new TraceWriteEventArgs(txt));
        }

References MockPlugin.Device.DeviceSurveillance.TraceWrite.

Member Data Documentation

mDeviceInfoProvider

readonly IDeviceInfoProvider MockPlugin.Device.DeviceSurveillance.mDeviceInfoProvider

private

Definition at line 19 of file DeviceSurveillance.cs.

Referenced by MockPlugin.Device.DeviceSurveillance.DeviceSurveillance().

Property Documentation

ButtonCaption

string MockPlugin.Device.DeviceSurveillance.ButtonCaption

get

Shown on the sample list page.

You can update this using INotifyPropertyChanged.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 32 of file DeviceSurveillance.cs.

ButtonIcon

Icon MockPlugin.Device.DeviceSurveillance.ButtonIcon

get

Shown in the button, preferred size 22x22.

You can update this using INotifyPropertyChanged.

Implements AxelSemrau.Chronos.Plugin.IWorkWithSampleLists.

Definition at line 33 of file DeviceSurveillance.cs.

ConfiguredDevices

IEnumerable<IDevice> MockPlugin.Device.DeviceSurveillance.ConfiguredDevices

set

List of IDevice for all configured devices in Chronos.

Use with caution!

Implements AxelSemrau.Chronos.Plugin.IDirectDeviceAccess.

Definition at line 43 of file DeviceSurveillance.cs.

        {
            set
            {
                // You could save the list for later use,
                // you could filter the list for specific interfaces,
                // you could call methods of the devices at any time -
                // just make sure you know what you are doing and don't mess with
                // toolboxes and sequence execution.
                Trace("** Start device list dump");
                foreach (var someDev in value)
                {
                    Trace($"{someDev.Name} of type {someDev.GetType().FullName}, connection state {mDeviceInfoProvider.Single(info => info.Device == someDev).ConnectionState}");
                }
                Trace("** End device list dump");
            }
        }

Event Documentation

TraceWrite

EventHandler<TraceWriteEventArgs> MockPlugin.Device.DeviceSurveillance.TraceWrite

Definition at line 69 of file DeviceSurveillance.cs.

Referenced by MockPlugin.Device.DeviceSurveillance.Trace().

---

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

• DeviceSurveillance.cs