Class Routine

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

A logix Routine component. Contains the properties for a generic Routine element. This type does not include content property. More specific routine types are derived from this base class.

public class Routine : LogixComponent<Routine>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<Routine>

Routine

Implements

ILogixSerializable

Inherited Members

LogixComponent<Routine>.Use

LogixComponent<Routine>.Name

LogixComponent<Routine>.Description

LogixComponent<Routine>.AddAfter(Routine)

LogixComponent<Routine>.AddBefore(Routine)

LogixComponent<Routine>.Clone()

LogixComponent<Routine>.Remove()

LogixComponent<Routine>.Replace(Routine)

LogixComponent<Routine>.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

Routine()

Creates a new Routine with default values.

public Routine()

Remarks

By default this will be a RLL routine type. To specify a different type, use the RoutineType constructor.

Routine(RoutineType)

Creates a new Routine of the specified RoutineType.

public Routine(RoutineType type)

Parameters

type RoutineType

The RoutineType of the routine.

Exceptions

ArgumentNullException

type is null.

Routine(XElement)

Creates a new Routine initialized with the provided XElement.

public Routine(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

OnlineEditType

The online edit type for the ST/FBD/SFC Routine type.

public OnlineEditType? OnlineEditType { get; set; }

Property Value

OnlineEditType

If the routine is a ST, FBD, or SFC type, then the OnlineEditType value; Otherwise, null for RLL routines.

SheetOrientation

The sheet orientation for the FBD or SFC Routine type.

public SheetOrientation? SheetOrientation { get; set; }

Property Value

SheetOrientation

If the routine is a FBD or SFC type, then the SheetOrientation value; Otherwise, null for RLL or ST routines.

SheetSize

The sheet size for the FBD or SFC Routine type.

public SheetSize? SheetSize { get; set; }

Property Value

SheetSize

If the routine is a FBD or SFC type, then the SheetSize value; Otherwise, null for RLL or ST routines.

Type

The type of the Routine component.

public RoutineType Type { get; set; }

Property Value

RoutineType

A RoutineType enum specifying the type content the routine contains.

Methods

Content<TElement>()

Gets the routine content as a LogixContainer<TElement> containing elements of the specified type.

public LogixContainer<TElement> Content<TElement>() where TElement : LogixElement

Returns

LogixContainer<TElement>

A LogixContainer<TElement> with access to the root content and specified element types.

Type Parameters

TElement

The content element type to return.

Remarks

This method offers a dynamic interface for accessing content of any routine type. If the underlying routine content does not match the Type specified, a L5XException will be thrown.

Exceptions

InvalidOperationException

No content element corresponding to the specified Type exists for the underlying XElement. This can happen if the provided element is not valid.