Class DataType

Namespace

L5Sharp.Components

Assembly

L5Sharp.dll

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

public class DataType : LogixComponent<DataType>, ILogixSerializable

Inheritance

object

LogixElement

LogixComponent<DataType>

DataType

Implements

ILogixSerializable

Inherited Members

LogixComponent<DataType>.Use

LogixComponent<DataType>.Name

LogixComponent<DataType>.Description

LogixComponent<DataType>.AddAfter(DataType)

LogixComponent<DataType>.AddBefore(DataType)

LogixComponent<DataType>.Clone()

LogixComponent<DataType>.Remove()

LogixComponent<DataType>.Replace(DataType)

LogixComponent<DataType>.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)

Remarks

Observe these guidelines when defining a DataType:
• DataTypes must be defined first within the controller body.
• DataTypes can be defined out of order. For example, if Type1 depends on Type2, Type2 can be defined first.
• DataTypes can be unverified. For example if Type1 depends on Type2 and Type2 is never defined, then Type1
will be accessible as an unverified type. Type2 will be typeless type. Tags of Type1 may be created but not of Type2.
• Datatype members can be arrays but only one dimension is allowed.
• These DataTypes cannot be used in a user-defined datatype:
• ALARM_ANALOG
• ALARM_DIGITAL
• AXIS types
• COORDINATE_SYSTEM
• MOTION_GROUP
• MESSAGE
• MODULE
• If one user-defined datatype references a second user-defined datatype defined in the file, the second
user-defined datatype appears before the first one in the import/export file.

Constructors

DataType()

Creates a new DataType with default values.

public DataType()

DataType(XElement)

Creates a new DataType initialized with the provided XElement.

public DataType(XElement element)

Parameters

element XElement

The XElement to initialize the type with.

Exceptions

ArgumentNullException

element is null.

Properties

Class

The class of the DataType component.

public DataTypeClass? Class { get; set; }

Property Value

DataTypeClass

A DataTypeClass option indicating the class for which the current data type belongs. L5X files will only ever contain User class types.

Family

The family of the DataType component.

public DataTypeFamily? Family { get; set; }

Property Value

DataTypeFamily

A DataTypeFamily option indicating the family for which the current data type belongs. This is just string for string types and none for all others.

Members

The collection of DataTypeMember that make up the structure of the DataType component.

public LogixContainer<DataTypeMember> Members { get; set; }

Property Value

LogixContainer<DataTypeMember>