Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The PlcMemberInfo type exposes the following members.
Initializes a new instance of the PlcMemberInfo class using the specified type
and name
.
C#
protected PlcMemberInfo(PlcType type, PlcName name)
Parameters
type
PlcType
The PlcType of the member.
name
PlcName
The name of the member.
Exceptions
The type
specified is not supported.
The type
or name
is a null reference (Nothing in Visual Basic).
When implemented in a derived class, retrieves the IPlcMemberInfo as an absolute addressable PLC data member.
C#
public abstract IPlcMemberInfo MakeAbsoluteMember(PlcIdentity identity)
Parameters
identity
PlcIdentity
The PlcIdentity to use to define the absolute location. This identity is used to define the basis starting from that the member is be located.
Returns
In case there IsAbsolute is equals true the reference to this member; otherwise a new instance of the member which refers to an absolute PlcType.
Exceptions
The identity
specified does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
Relocates the PlcMemberInfo using the specified offset.
C#
public IPlcMemberInfo Relocate(int operandNumber)
Parameters
operandNumber
Int32
The operand number offset used to adjust the PlcAddress information.
Returns
A new instance of the PlcMemberInfo configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
The offset specified by operandNumber
result into a new value that would be out of the bounds defined by MinOperandNumber or MaxOperandNumber.
It is not possible to relocate relative types.
Relocates the PlcMemberInfo using the specified offset.
C#
public IPlcMemberInfo 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
A new instance of the PlcMemberInfo configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
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.
It is not possible to relocate relative types.
Relocates the PlcMemberInfo using the specified offset.
C#
public IPlcMemberInfo 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
A new instance of the PlcMemberInfo configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
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.
It is not possible to relocate relative types.
Relocates the PlcMemberInfo using the specified address
.
C#
public IPlcMemberInfo Relocate(PlcAddress address)
Parameters
address
PlcAddress
The PlcAddress to that the object is to be relocated.
Returns
A new instance of the PlcType configured with the same metadata as this instance but relocated using the specified address
.
Exceptions
The address
is a null reference (Nothing in Visual Basic).
The address
does not refer to the same RawType as this PlcType.
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 PlcMemberInfo.
When implemented in a derived class, relocates the member to the type
specified.
C#
protected abstract PlcMemberInfo RelocateCore(PlcType type)
Parameters
type
PlcType
The PlcType to that the member is to be relocated.
Returns
A new instance of the same type as this PLC member instance relocated to the type
specified.
Retrieves the string representation of the PlcMemberInfo.
C#
public override string ToString()
Returns
The string representation of the PlcMemberInfo.