Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

IPlcRelocatable Members

Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The IPlcRelocatable interface defines the following members.

Methods

Relocate(Int32)

Relocates the IPlcRelocatable using the specified offset.

C# 

IPlcRelocatable Relocate(int operandNumber)


Parameters

operandNumber Int32

The operand number offset used to adjust the PlcAddress information.


Returns

IPlcRelocatable

A new instance of the IPlcRelocatable configured with the same metadata as this instance but relocated using the specified offset.



Exceptions

ArgumentOutOfRangeException

The offset specified by operandNumber result into a new value that would be out of the bounds defined by MinOperandNumber or MaxOperandNumber.

InvalidOperationException

It is not possible to relocate relative types.

Relocate(Int32, Int32)

Relocates the IPlcRelocatable using the specified offset.

C# 

IPlcRelocatable Relocate(int operandNumber, int byteNumber)


Parameters

operandNumber Int32

The operand number offset used to adjust the PlcAddress information.

byteNumber Int32

The byte number offset used to adjust the PlcAddress information.


Returns

IPlcRelocatable

A new instance of the IPlcRelocatable configured with the same metadata as this instance but relocated using the specified offset.



Exceptions

ArgumentOutOfRangeException

One of the offsets specified by operandNumber or byteNumber result into a new value that would be out of the bounds defined by MinOperandNumber, MaxOperandNumber, MinByteNumber and MaxByteNumber.

InvalidOperationException

It is not possible to relocate relative types.

Relocate(Int32, Int32, Int32)

Relocates the IPlcRelocatable using the specified offset.

C# 

IPlcRelocatable Relocate(int operandNumber, int byteNumber, int bitNumber)


Parameters

operandNumber Int32

The operand number offset used to adjust the PlcAddress information.

byteNumber Int32

The byte number offset used to adjust the PlcAddress information.

bitNumber Int32

The bit number offset used to adjust the PlcAddress information.


Returns

IPlcRelocatable

A new instance of the IPlcRelocatable configured with the same metadata as this instance but relocated using the specified offset.



Exceptions

ArgumentOutOfRangeException

One of the offsets specified by operandNumber, byteNumber or bitNumber result into a new value that would be out of the bounds defined by MinOperandNumber, MaxOperandNumber, MinByteNumber, MaxByteNumber, MinBitNumber or MaxBitNumber.

InvalidOperationException

It is not possible to relocate relative types.

Relocate(PlcAddress)

Relocates the IPlcRelocatable using the specified address.

C# 

IPlcRelocatable Relocate(PlcAddress address)


Parameters

address PlcAddress

The PlcAddress to that the object is to be relocated.


Returns

IPlcRelocatable

A new instance of the IPlcRelocatable configured with the same metadata as this instance but relocated using the specified address.



Exceptions

ArgumentNullException

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

ArgumentException

The address does not refer to the same RawType as this IPlcRelocatable.

InvalidOperationException

It is not possible to relocate absolute object types without relative type information.


Remarks

The RawType of the address specified needs to be the same as defined by this IPlcRelocatable.