Class ArrayType<TLogixType>

Namespace

L5Sharp.Types

Assembly

L5Sharp.dll

A LogixType that represents an array of other logix types (either atomic or structure).

public sealed class ArrayType<TLogixType> : ArrayType, ILogixSerializable, IEnumerable<TLogixType>, IEnumerable where TLogixType : LogixType

Type Parameters

TLogixType

Inheritance

object

LogixType

ArrayType

ArrayType<TLogixType>

Implements

ILogixSerializable

IEnumerable<TLogixType>

IEnumerable

Inherited Members

ArrayType.TypeName

ArrayType.Name

ArrayType.Family

ArrayType.Class

ArrayType.Dimensions

ArrayType.Radix

ArrayType.Members

ArrayType.New<TLogixType>(Dimensions)

ArrayType.Of<TLogixType>()

ArrayType.Serialize()

LogixType.DataChanged

LogixType.As<TLogixType>()

LogixType.Clone()

LogixType.Equals(object)

LogixType.GetHashCode()

LogixType.Member(string)

LogixType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ArrayType(Array)

Creates a new ArrayType<TLogixType> initialized with the provided one dimensional array.

public ArrayType(Array array)

Parameters

array Array

The one dimensional array to initialize the array type with.

Exceptions

ArgumentNullException

array is null.

ArgumentException

array is empty, contains null or NullType elements, or is an array of more than one logix type.

ArrayType(XElement)

Creates a new ArrayType initialized from the provided XElement data.

public ArrayType(XElement element)

Parameters

element XElement

The element to parse.

Exceptions

ArgumentNullException

element is null.

InvalidOperationException

element does not have required attributes or child elements.

ArrayType(TLogixType[,,])

Creates a new ArrayType<TLogixType> initialized with the provided three dimensional array.

public ArrayType(TLogixType[,,] array)

Parameters

array TLogixType[,,]

The three dimensional array to initialize the array type with.

Exceptions

ArgumentNullException

array is null.

ArgumentException

array is empty, contains null or NullType elements, or is an array of more than one logix type.

ArrayType(TLogixType[,])

Creates a new ArrayType<TLogixType> initialized with the provided two dimensional array.

public ArrayType(TLogixType[,] array)

Parameters

array TLogixType[,]

The two dimensional array to initialize the array type with.

Exceptions

ArgumentNullException

array is null.

ArgumentException

array is empty, contains null or NullType elements, or is an array of more than one logix type.

ArrayType(TLogixType[])

Creates a new ArrayType<TLogixType> initialized with the provided one dimensional array.

public ArrayType(TLogixType[] array)

Parameters

array TLogixType[]

The one dimensional array to initialize the array type with.

Exceptions

ArgumentNullException

array is null.

ArgumentException

array is empty, contains null or NullType elements, or is an array of more than one logix type.

Properties

this[ushort]

Gets the LogixType instance at the specified index.

public TLogixType this[ushort x] { get; set; }

Parameters

x ushort

The index of the array element

Property Value

TLogixType

Exceptions

ArgumentOutOfRangeException

index is out of range of the array.

this[ushort, ushort]

Gets the LogixType instance at the specified index.

public TLogixType this[ushort x, ushort y] { get; set; }

Parameters

x ushort

The x index of the array element

y ushort

The y index of the array element

Property Value

TLogixType

Exceptions

ArgumentOutOfRangeException

index is out of range of the array.

this[ushort, ushort, ushort]

Gets the LogixType instance at the specified index.

public TLogixType this[ushort x, ushort y, ushort z] { get; set; }

Parameters

x ushort

The x index of the array element

y ushort

The y index of the array element

z ushort

The z index of the array element

Property Value

TLogixType

Exceptions

ArgumentOutOfRangeException

index is out of range of the array.

Methods

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TLogixType> GetEnumerator()

Returns

IEnumerator<TLogixType>

An enumerator that can be used to iterate through the collection.

Operators

implicit operator ArrayType<TLogixType>(TLogixType[,,])

Implicitly converts the provided array of logix type objects to an ArrayType<TLogixType>.

public static implicit operator ArrayType<TLogixType>(TLogixType[,,] array)

Parameters

array TLogixType[,,]

Returns

ArrayType<TLogixType>

A new ArrayType<TLogixType> containing the elements of the provided array.

implicit operator ArrayType<TLogixType>(TLogixType[,])

Implicitly converts the provided array of logix type objects to an ArrayType<TLogixType>.

public static implicit operator ArrayType<TLogixType>(TLogixType[,] array)

Parameters

array TLogixType[,]

Returns

ArrayType<TLogixType>

A new ArrayType<TLogixType> containing the elements of the provided array.

implicit operator ArrayType<TLogixType>(TLogixType[])

Implicitly converts the provided array of logix type objects to an ArrayType<TLogixType>.

public static implicit operator ArrayType<TLogixType>(TLogixType[] array)

Parameters

array TLogixType[]

Returns

ArrayType<TLogixType>

A new ArrayType<TLogixType> containing the elements of the provided array.