Class Parameter

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

A component of the AddOnInstruction that makes up the structure of the instruction type.

public sealed class Parameter : LogixComponent<Parameter>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<Parameter>

Parameter

Implements

ILogixSerializable

Inherited Members

LogixComponent<Parameter>.Use

LogixComponent<Parameter>.Name

LogixComponent<Parameter>.Description

LogixComponent<Parameter>.AddAfter(Parameter)

LogixComponent<Parameter>.AddBefore(Parameter)

LogixComponent<Parameter>.Clone()

LogixComponent<Parameter>.Remove()

LogixComponent<Parameter>.Replace(Parameter)

LogixComponent<Parameter>.ToString()

LogixElement.IsAttached

LogixElement.Clone<TElement>()

LogixElement.L5X()

LogixElement.Serialize()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Parameter()

Creates a new Parameter with default values.

public Parameter()

Parameter(XElement)

Creates a new Parameter initialized with the provided XElement.

public Parameter(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

AliasFor

The tag name of the tag that is the alias of the current parameter.

public TagName? AliasFor { get; set; }

Property Value

TagName

A TagName string representing the full tag name of the alias tag.

Constant

Indicates whether the parameter is a constant.

public bool? Constant { get; set; }

Property Value

bool?

true if the parameter is constant; otherwise, false.

Remarks

Only value type tags have the ability to be set as a constant. Default is false.

DataType

The name of the data type of the parameter.

public string? DataType { get; set; }

Property Value

string

A string containing the data type name of the parameter. Default is Empty. Valid value is required for valid import.

Default

A default value of the parameter when instantiated.

public AtomicType? Default { get; set; }

Property Value

AtomicType

An AtomicType representing the default value/data. Default is null.

Dimension

The array dimension of the parameter.

public Dimensions? Dimension { get; set; }

Property Value

Dimensions

A Dimensions representing the array dimensions of the parameter. Default is Empty. Members should not have multidimensional arrays.

ExternalAccess

The external access of the parameter.

public ExternalAccess? ExternalAccess { get; set; }

Property Value

ExternalAccess

A ExternalAccess representing read/write access of the parameter. Default is ReadWrite.

Radix

The radix value format of the parameter.

public Radix? Radix { get; set; }

Property Value

Radix

A Radix representing the value type format of the parameter. Default is Null. Should be Null for all non atomic types.

Required

Indicates whether the parameter is required form the instruction code clock.

public bool? Required { get; set; }

Property Value

bool?

true if the parameter is required; otherwise, false. Default is false.

TagType

A type indicating whether the current parameter is a base tag, or alias for another tag instance.

public TagType? TagType { get; set; }

Property Value

TagType

A TagType option representing the type of parameter. Default is Base.

Usage

The usage option indicating the scope in which the parameter is visible or usable from.

public TagUsage Usage { get; set; }

Property Value

TagUsage

A TagUsage option representing the parameter scope. Default for AOI is Input. Only valid options for AOI are Input, Output, and InOut.

Visible

Indicates whether the parameter is visible from the instruction code block.

public bool? Visible { get; set; }

Property Value

bool?

true if the parameter is visible; otherwise, false. Default is false.