Class Module

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

A logix Module component. Contains the properties that comprise the L5X Module element.

public class Module : LogixComponent<Module>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<Module>

Module

Implements

ILogixSerializable

Inherited Members

LogixComponent<Module>.Use

LogixComponent<Module>.Description

LogixComponent<Module>.AddAfter(Module)

LogixComponent<Module>.AddBefore(Module)

LogixComponent<Module>.Clone()

LogixComponent<Module>.Remove()

LogixComponent<Module>.Replace(Module)

LogixComponent<Module>.ToString()

LogixElement.Element

LogixElement.IsAttached

LogixElement.Clone<TElement>()

LogixElement.L5X()

LogixElement.Serialize()

LogixElement.GetValue<T>(string)

LogixElement.GetValue<T>(Func<XElement, XElement>, string)

LogixElement.GetValue<T>(XName, string)

LogixElement.GetRequiredValue<T>(string)

LogixElement.GetProperty<T>(string)

LogixElement.GetComplex<T>(string)

LogixElement.GetContainer<TChild>(string)

LogixElement.GetDateTime(string, string)

LogixElement.SetValue<T>(T, string)

LogixElement.SetValue<T>(T, Func<XElement, XElement>, string)

LogixElement.SetValue<T>(T, XName, string)

LogixElement.SetRequiredValue<T>(T, string)

LogixElement.SetProperty<T>(T, string)

LogixElement.SetComplex<T>(T, string)

LogixElement.SetContainer<TChild>(LogixContainer<TChild>, string)

LogixElement.SetDateTime(DateTime?, string, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

Module()

Creates a new default LogixElement initialized with an XElement having the L5XType name of the element.

public Module()

Module(XElement)

Initializes a new LogixElement with the provided XElement

public Module(XElement element)

Parameters

element XElement

The L5X XElement to initialize the entity with.

Exceptions

ArgumentNullException

element is null.

Properties

CatalogNumber

Specify the catalog number that uniquely identifies the module. This is a rockwell defined convention, and represents the identity of the module type.

public string? CatalogNumber { get; set; }

Property Value

string

A string value containing the catalog number.

Communications

public Communications? Communications { get; set; }

Property Value

Communications

Inhibited

An indication of whether the module is inhibited or disabled.

public bool Inhibited { get; set; }

Property Value

bool

Keying

The electronic keying mode of the module.

public ElectronicKeying? Keying { get; set; }

Property Value

ElectronicKeying

A ElectronicKeying enum value representing the mode.

MajorFault

An indication of whether the module the module will cause a major fault when faulted.

public bool MajorFault { get; set; }

Property Value

bool

Name

The unique name of the component.

public override string Name { get; set; }

Property Value

string

A string representing the component name.

Remarks

The name servers as a unique identifier for various types of components. In most cases, the component name should satisfy Logix naming constraints of alphanumeric and underscore ('_') characters, start with a letter, and be between 1 and 40 characters. Validation is not performed by this library, so importing components with invalid names may fail.

ParentModPortId

The port id of the parent module that the current module is connected to. This specified how the module is connected within the module tree.

public int ParentModPortId { get; set; }

Property Value

int

A int representing the id of the parent port. Default is zero.

ParentModule

The name of the parent module, or module that the current module is connected to upstream. This specifies how the module is connected within the module tree.

public string? ParentModule { get; set; }

Property Value

string

A string representing the parent module name. Default is an empty string.

Ports

A collection of Port elements that define the module's connection within the module tree.

public LogixContainer<Port> Ports { get; set; }

Property Value

LogixContainer<Port>

A LogixContainer<TElement> of Port objects.

Remarks

Ports define how a module's peripherals are connected to other module's, forming the network or tree of devices used to communicated with a controller and field equipment. Ports must have a unique id, a type, and address.

ProductCode

The unique product code value of the module.

public ushort ProductCode { get; set; }

Property Value

ushort

Remarks

This is a unique value that identifies the module and is assigned by Logix.

ProductType

The product type of the module, representing a category of the module.

public ProductType? ProductType { get; set; }

Property Value

ProductType

Remarks

All modules have a product type representing the product category of the module.

Revision

The revision number or hardware version of the module.

public Revision? Revision { get; set; }

Property Value

Revision

A Revision object representing the major and minor version.

Remarks

All modules must have a specified revision number.

SafetyEnabled

An indication of whether whether the module has safety features enabled.

public bool SafetyEnabled { get; set; }

Property Value

bool

Vendor

The vendor or manufacturer of the module.

public Vendor? Vendor { get; set; }

Property Value

Vendor

A Vendor entity that contains the id and name of the vendor.

Remarks

All modules have a vendor representing the manufacturer of the module.