PlcByteArray Members

Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The PlcByteArray type exposes the following members.

PlcByteArray(PlcByteArrayType)

Initializes a new instance of the PlcByteArray class using the specified type.

C#

public PlcByteArray(PlcByteArrayType type)


Parameters

type PlcByteArrayType

The PlcByteArrayType of the new PlcByteArray to which the PLC array belongs.


Exceptions

ArgumentNullException

The type is a null reference (Nothing in Visual Basic).

PlcByteArray(PlcByteArrayType, Byte[])

Initializes a new instance of the PlcByteArray class using the specified type and values.

C#

public PlcByteArray(PlcByteArrayType type, params byte[] values)


Parameters

type PlcByteArrayType

The PlcByteArrayType of the new PlcByteArray to which the PLC array belongs.

values Byte[]

The initial values of the new PlcByteArray.


Exceptions

ArgumentNullException

The type is a null reference (Nothing in Visual Basic).

PlcByteArray(PlcByteArrayType, PlcName, Byte[])

Initializes a new instance of the PlcByteArray class using the specified type, name and values.

C#

public PlcByteArray(PlcByteArrayType type, PlcName name, params byte[] values)


Parameters

type PlcByteArrayType

The PlcByteArrayType of the new PlcByteArray to which the PLC array belongs.

name PlcName

The name of the array represented.

values Byte[]

The initial values of the new PlcByteArray.


Exceptions

ArgumentNullException

The type or name is a null reference (Nothing in Visual Basic).

PlcByteArray(PlcIdentity, Byte[])

Initializes a new instance of the PlcByteArray class using the specified identity and values.

C#

public PlcByteArray(PlcIdentity identity, params byte[] values)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcByteArray to which the PLC array belongs.

values Byte[]

The initial values of the new PlcByteArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity is a null reference (Nothing in Visual Basic).

PlcByteArray(PlcIdentity, Int32)

Initializes a new instance of the PlcByteArray class using the specified identity and length.

C#

public PlcByteArray(PlcIdentity identity, int length)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcByteArray to which the PLC array belongs.

length Int32

The array length used to store the array values of the PlcByteArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

PlcByteArray(PlcIdentity, PlcName, Byte[])

Initializes a new instance of the PlcByteArray class using the specified identity, name and values.

C#

public PlcByteArray(PlcIdentity identity, PlcName name, params byte[] values)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcByteArray to which the PLC array belongs.

name PlcName

The name of the array represented.

values Byte[]

The initial values of the new PlcByteArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity or name is a null reference (Nothing in Visual Basic).

PlcByteArray(PlcIdentity, PlcName, Int32)

Initializes a new instance of the PlcByteArray class using the specified identity, name and length.

C#

public PlcByteArray(PlcIdentity identity, PlcName name, int length)


Parameters

identity PlcIdentity

The PlcIdentity of the new PlcByteArray to which the PLC array belongs.

name PlcName

The name of the array represented.

length Int32

The array length used to store the array values of the PlcByteArray.


Exceptions

ArgumentException

The identity does not refer to the Byte.

ArgumentNullException

The identity or name is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

GetElementCore(Int32)

Retrieves the PlcByte at the specified index.

C#

protected override PlcByte GetElementCore(int index)


Parameters

index Int32

The zero-based index of the element to get.


Returns

PlcByte

The PlcByte at the specified index.

GetValueCore(PlcDeviceConnection)

Retrieves the current value of the PLC value from a IPlcDevice using the connection specified.

C#

protected override byte[] GetValueCore(PlcDeviceConnection connection)


Parameters

connection PlcDeviceConnection

The PlcDeviceConnection from that the data is to be retrieved.


Returns

Byte[]

The current value of the PLC value.



Exceptions

InvalidOperationException

The connection is in Faulted state and cannot longer be opened.

ObjectDisposedException

The connection has been disposed of.

RelocateCore(PlcAddress)

Relocates the value to the address specified.

C#

protected override IPlcValue RelocateCore(PlcAddress address)


Parameters

address PlcAddress

The PlcAddress to that the value is to be relocated.


Returns

IPlcValue

A new instance of the same type as this PLC value instance relocated to the address specified.

SetValueCore(PlcDeviceConnection, Byte[])

Stores the value in the IPlcDevice assigned to the connection specified.

C#

protected override void SetValueCore(PlcDeviceConnection connection, byte[] value)


Parameters

connection PlcDeviceConnection

The PlcDeviceConnection to use to store the value.

value Byte[]

The value to be stored.



Exceptions

InvalidOperationException

The connection is in Faulted state and cannot longer be opened.

ObjectDisposedException

The connection has been disposed of.