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
void	DoYourJob ()
	Will be triggered when the user clicks on the button. The button will be disabled until you return from here. More...

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

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. More...

Private Member Functions
void	Trace (string txt)

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.

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 23 of file DeviceSurveillance.cs.

        {
            // nothing to see here
        }

Trace()

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

private

Definition at line 52 of file DeviceSurveillance.cs.

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

References MockPlugin.Device.DeviceSurveillance.TraceWrite.

Property Documentation

ButtonCaption

string MockPlugin.Device.DeviceSurveillance.ButtonCaption

get

Definition at line 21 of file DeviceSurveillance.cs.

ButtonIcon

Icon MockPlugin.Device.DeviceSurveillance.ButtonIcon

get

Definition at line 22 of file DeviceSurveillance.cs.

ConfiguredDevices

IEnumerable<IDevice> MockPlugin.Device.DeviceSurveillance.ConfiguredDevices

set

Definition at line 32 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 {Helpers.Devices.Single(info => info.Device == someDev).ConnectionState}");
                }
                Trace("** End device list dump");
            }
        }

Event Documentation

TraceWrite

EventHandler<TraceWriteEventArgs> MockPlugin.Device.DeviceSurveillance.TraceWrite

Definition at line 58 of file DeviceSurveillance.cs.

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

---

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

• DeviceSurveillance.cs