Class Program

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

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

public class Program : LogixComponent<Program>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<Program>

Program

Implements

ILogixSerializable

Inherited Members

LogixComponent<Program>.Use

LogixComponent<Program>.Name

LogixComponent<Program>.Description

LogixComponent<Program>.AddAfter(Program)

LogixComponent<Program>.AddBefore(Program)

LogixComponent<Program>.Clone()

LogixComponent<Program>.Remove()

LogixComponent<Program>.Replace(Program)

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

Program()

Creates a new Program with default values.

public Program()

Program(XElement)

Creates a new Program initialized with the provided XElement.

public Program(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

Disabled

The value indicating whether the program is disabled (or inhibited).

public bool Disabled { get; set; }

Property Value

bool

A bool; true if the program is disabled; otherwise false.

FaultRoutineName

The name of the routine that serves as the fault routine for the program.

public string? FaultRoutineName { get; set; }

Property Value

string

A string representing the name of the fault routine for the program.

MainRoutineName

The name of the routine that serves as the entry point for the program (i.e. main routine).

public string? MainRoutineName { get; set; }

Property Value

string

A string representing the name of the main routine for the program.

Routines

The collection of Routine objects for the program component.

public LogixContainer<Routine> Routines { get; set; }

Property Value

LogixContainer<Routine>

Tags

The collection of Tag objects for the program component.

public LogixContainer<Tag> Tags { get; set; }

Property Value

LogixContainer<Tag>

TestEdits

The value indicating whether the program has current test edits pending.

public bool TestEdits { get; set; }

Property Value

bool

A bool; trueif the program has test edits; otherwise false.

Type

Gets the type of the program (Normal, Equipment Phase).

public ProgramType Type { get; set; }

Property Value

ProgramType

A ProgramType enum representing the type of the program.

UseAsFolder

A flag indicating whether the program is used as a folder or container for other programs, as opposed to a container of tags and logix.

public bool UseAsFolder { get; set; }

Property Value

bool

A bool; true if the program is a folder; otherwise, false.