Class Connection

Namespace

L5Sharp.Elements

Assembly

L5Sharp.dll

A component of a Module that represents the properties and data of the connection to the field device.

public sealed class Connection : LogixElement, ILogixSerializable

Inheritance

object

LogixElement

Connection

Implements

ILogixSerializable

Inherited Members

LogixElement.IsAttached

LogixElement.Clone()

LogixElement.Clone<TElement>()

LogixElement.L5X()

LogixElement.Serialize()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Connection()

Creates a new Connection with default values.

public Connection()

Connection(XElement)

Creates a new Connection initialized with the provided XElement.

public Connection(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

EventId

Gets the value of the Event ID used in conjunction with an event task for the Connection.

public int? EventId { get; set; }

Property Value

int?

InputConnectionType

Gets the TransmissionType value for the Connection.

public TransmissionType? InputConnectionType { get; set; }

Property Value

TransmissionType

InputCxnPoint

Gets the input connection point for the primary Connection.

public ushort InputCxnPoint { get; set; }

Property Value

ushort

InputProductionTrigger

Gets the ProductionTrigger value for the Connection.

public ProductionTrigger? InputProductionTrigger { get; set; }

Property Value

ProductionTrigger

InputSize

Gets the input size for the Connection.

public ushort InputSize { get; set; }

Property Value

ushort

InputTag

Gets the Tag that represents the input channel data for the Connection element.

public Tag? InputTag { get; set; }

Property Value

Tag

A Tag component containing the module defined data structure for the input connection data.

InputTagSuffix

The character used to define the tag name for the InputTag element.

public string InputTagSuffix { get; set; }

Property Value

string

A string containing the suffix character if it exists; Otherwise, will default as 'I'.

Remarks

This value is used in determining the module tag name. Not all modules serialize this property, but still use 'I' as the suffix character for input tags. Therefore, we will default to 'I' if not found.

Name

Gets the name of the Connection component.

public string Name { get; set; }

Property Value

string

OutputCxnPoint

Gets the output connection point for the primary Connection.

public ushort OutputCxnPoint { get; set; }

Property Value

ushort

OutputRedundantOwner

Gets a value indicating whether the Connection output is a redundant owner.

public bool OutputRedundantOwner { get; set; }

Property Value

bool

OutputSize

Gets the output size for the Connection.

public ushort OutputSize { get; set; }

Property Value

ushort

OutputTag

Gets the Tag that represents the output channel data for the Connection element.

public Tag? OutputTag { get; set; }

Property Value

Tag

A Tag component containing the module defined data structure for the output connection data.

OutputTagSuffix

The character used to define the tag name for the OutputTag element.

public string OutputTagSuffix { get; set; }

Property Value

string

A string containing the suffix character if it exists; Otherwise, will default as 'O'.

Remarks

This value is used in determining the module tag name. Not all modules serialize this property, but still use 'O' as the suffix character for output tags. Therefore, we will default to 'O' if not found.

Priority

Gets the ConnectionPriority value for the Connection.

public ConnectionPriority? Priority { get; set; }

Property Value

ConnectionPriority

RPI

Gets the value of the Request Packet Interval for the Connection.

public int RPI { get; set; }

Property Value

int

Type

Gets the ConnectionType value for the Connection.

public ConnectionType? Type { get; set; }

Property Value

ConnectionType

Unicast

Gets the value indicating whether the EtherNet/IP connection is unicast.

public bool Unicast { get; set; }

Property Value

bool