Table of Contents

Class SuctionModule

Namespace
Loehnert.Lisrt.AutomationController
Assembly
Loehnert.Lisrt.AutomationController.dll

Represents a suction module.

public class SuctionModule : PropertyChangedBase, ILisrtModule, IInitializable, INotifyPropertyChangedEx, INotifyPropertyChanged, IHasServiceView, IHasDeviceLabel
Inheritance
PropertyChangedBase
SuctionModule
Implements
INotifyPropertyChangedEx
Inherited Members
PropertyChangedBase.Refresh()
PropertyChangedBase.IsNotifying
PropertyChangedBase.PropertyChanged

Properties

DeviceLabel

Gets or sets the label for the device.

[Configuration("")]
public string DeviceLabel { get; set; }

Property Value

string

Enabled

Gets or sets a value indicating whether the module is enabled.

public bool Enabled { get; set; }

Property Value

bool

FlowMonitorInput

Gets or sets the input port of flow sensor.

[Configuration(-1, Description = "Input of flow sensor or -1 if disabled.")]
public int FlowMonitorInput { get; set; }

Property Value

int

HasError

Gets a value indicating whether suction is in error.

public bool HasError { get; }

Property Value

bool

Icon

Gets the icon from the module.

public Uri Icon { get; }

Property Value

Uri

InitializationState

Gets a value indicating whether the object is initialized.

public InitializationState InitializationState { get; }

Property Value

InitializationState

InstanceID

Gets or sets the ID for this instance.

public int InstanceID { get; set; }

Property Value

int

IsActive

Gets a value indicating whether the suction is active.

public bool IsActive { get; }

Property Value

bool

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

Parent

Gets or sets the parent module.

public ILisrtModule Parent { get; set; }

Property Value

ILisrtModule

StartupTimeInMS

Gets or sets the start-up time in ms.

[Configuration(0, Description = "Start-up time of the suction in ms.")]
public int StartupTimeInMS { get; set; }

Property Value

int

SuctionType

Gets or sets the type of suction.

[Configuration(SuctionType.External, Description = "Sets the type of suction.")]
public SuctionType SuctionType { get; set; }

Property Value

SuctionType

TreeItem

Gets the view model for the module.

public ITreeItem TreeItem { get; }

Property Value

ITreeItem

Methods

Exit()

Exits the object.

public void Exit()

Initialize()

Initializes the object.

public void Initialize()

ShowServiceView()

Shows the service window.

public void ShowServiceView()

StartSuction(int)

Starts suction.

public void StartSuction(int timeoutInMs = 15000)

Parameters

timeoutInMs int

Timeout of changing state.

StopSuction(int)

Stops suction.

public void StopSuction(int timeoutInMs = 15000)

Parameters

timeoutInMs int

Timeout of changing state.