Class Environment.Communication.Protocol

Graphical representation of a Connection class. The class does not handle any communication, that is being handles by the Connection class.

Inheritance

System.Object

Environment.Communication.Protocol

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Experior.Core

Assembly: Experior.Core.dll

Syntax

public class Protocol

Fields

HighLevelProtocols

Read only collection of high level protocols.

High level protocols are protocols that are used to communicate between PLCs and a material handling system (MES, WMS etc.). A protocol will be added to this collection if it inherits from Connection and not from Connection.

Declaration

public static ReadOnlyCollection<Environment.UI.Toolbar.BarItem> HighLevelProtocols

Field Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<Environment.UI.Toolbar.BarItem>

LowLevelProtocols

Read only collection of low level protocols.

Low level protocols are protocols that communicate with PLC in such a way that they trick a PLC to think that it's communicating with real hardware (through fieldbus). A protocol will be added to this collection if it inherits from Connection.

Declaration

public static ReadOnlyCollection<Environment.UI.Toolbar.BarItem> LowLevelProtocols

Field Value

Type	Description
System.Collections.ObjectModel.ReadOnlyCollection<Environment.UI.Toolbar.BarItem>

Methods

Add(Environment.UI.Toolbar.BarItem)

This method is oblsoete. Please use Add(String, ImageSource, List<Environment.UI.Toolbar.BarItem>, Type, Nullable<Int32>) or Add(String, ImageSource, List<Environment.UI.Toolbar.BarItem>, Type, Nullable<Int32>)

Declaration

[Obsolete("Please see summary.")]
public static void Add(Environment.UI.Toolbar.BarItem item)

Parameters

Type	Name	Description
Environment.UI.Toolbar.BarItem	item

Add(String, ImageSource, List<Environment.UI.Toolbar.BarItem>, Type, Nullable<Int32>)

Method to add a folder with a set of Connection types to the list of available connections. The folder will be added to the context menu of the connection window. In the folder the individual Connection will be added. Unlike Add(String, ImageSource, EventHandler, Type, Nullable<Int32>) the developer needs to handle the event manually for each entry in the subItems.

Declaration

public static Environment.UI.Toolbar.Folder Add(string title, ImageSource image, List<Environment.UI.Toolbar.BarItem> subItems, Type type, int? index = default(int? ))

Parameters

Type	Name	Description
System.String	title	The title of the folder in the context menu.
System.Windows.Media.ImageSource	image	The icon of the folder in the context menu.
System.Collections.Generic.List<Environment.UI.Toolbar.BarItem>	subItems	The entries that will appear under the title in the context menu.
System.Type	type	The type of connections used. This is used to determine if the connection is low (LowLevelProtocols) or high level (HighLevelProtocols).
System.Nullable<System.Int32>	index	The intended index in the list (in the context menu)

Returns

Type	Description
Environment.UI.Toolbar.Folder	The Toolbar Folder that was generated from the subItems

Exceptions

Type	Condition
System.InvalidOperationException	Exception will be thrown if the type is not inheriting from Connection

Add(String, ImageSource, EventHandler, Type, Nullable<Int32>)

Method to add a Connection type to the list of available connections. Adding a Connection will make it appear in the context menu of the communication window.

Declaration

public static void Add(string title, ImageSource image, EventHandler click, Type type, int? index = default(int? ))

Parameters

Type	Name	Description
System.String	title	The title associated with the Connection type. Will be shown at title in the connection window context menu
System.Windows.Media.ImageSource	image	The icon associated with the Connection type. Will be shown at title in the connection window context menu
System.EventHandler	click	Method that gets called when the user clicks the type on the context menu
System.Type	type	The type of connection used. This is used to determine if the connection is low (LowLevelProtocols) or high level (HighLevelProtocols).
System.Nullable<System.Int32>	index	The intended index in the list (in the context menu)

Exceptions

Type	Condition
System.InvalidOperationException	Exception will be thrown if the type is not inheriting from Connection