PlcWordAddress Members

Initializes a new instance of the PlcWordAddress class using the specified operand and byteNumber.

C#

public PlcWordAddress(PlcOperand operand, int byteNumber)

Parameters

operand PlcOperand

The PlcOperand to that the new PlcWordAddress refers.

byteNumber Int32

The number of the byte to that the new PlcWordAddress refers.

Exceptions

ArgumentException

The type of operand specified is not supported.

ArgumentNullException

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

ArgumentOutOfRangeException

The byteNumber is out of the bounds defined by MinByteNumber or MaxByteNumber.

Initializes a new instance of the PlcWordAddress class using the specified operandType and byteNumber.

C#

public PlcWordAddress(PlcOperandType operandType, int byteNumber)

Parameters

operandType PlcOperandType

The PlcOperandType to that the new PlcWordAddress refers.

byteNumber Int32

The number of the byte to that the new PlcWordAddress refers.

Exceptions

ArgumentException

The operandType specified requires an operand number.

ArgumentOutOfRangeException

The byteNumber is out of the bounds defined by MinByteNumber or MaxByteNumber.

Initializes a new instance of the PlcWordAddress class using the specified operandType, operandNumber and byteNumber.

C#

public PlcWordAddress(PlcOperandType operandType, int operandNumber, int byteNumber)

Parameters

operandType PlcOperandType

The PlcOperandType to that the new PlcWordAddress refers.

operandNumber Int32

The number of the operand to that the new PlcWordAddress refers.

byteNumber Int32

The number of the byte to that the new PlcWordAddress refers.

Exceptions

ArgumentException

The operandType specified is not supported or the operandType specified does not support an operand number.

ArgumentOutOfRangeException

The operandNumber or byteNumber is out of the bounds defined by MinOperandNumber, MaxOperandNumber, MinByteNumber or MaxByteNumber.

Initializes a new instance of the PlcWordAddress class with serialized data.

C#

protected PlcWordAddress(SerializationInfo info, StreamingContext context)

Parameters

info Serialization.SerializationInfo

The Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.

context Serialization.StreamingContext

The Serialization.StreamingContext that contains contextual information about the source or destination.

Exceptions

ArgumentNullException

The info parameter is null reference (Nothing in Visual Basic).

Serialization.SerializationException

The class name is null reference (Nothing in Visual Basic) or HResult is zero (0).

Compares the current PlcWordAddress with the other.

C#

public override int CompareTo(object other)

Parameters

other Object

The PlcWordAddress to compare with this PlcWordAddress.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(Object)).

Compares the current PlcWordAddress with another PlcWordAddress.

C#

public int CompareTo(PlcWordAddress other)

Parameters

other PlcWordAddress

The PlcWordAddress to compare with this PlcWordAddress.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(0)).

Determines whether the specified other is equal to this PlcWordAddress.

C#

public override bool Equals(object other)

Parameters

other Object

The PlcWordAddress to compare to the current PlcWordAddress.

Returns

Boolean

The value true if the specified PlcWordAddress is equal to the current PlcWordAddress; otherwise the value false.

Determines whether the specified other is equal to this PlcWordAddress.

C#

public bool Equals(PlcWordAddress other)

Parameters

other PlcWordAddress

The PlcWordAddress to compare to the current PlcWordAddress.

Returns

Boolean

The value true if the specified PlcWordAddress is equal to the current PlcWordAddress; otherwise the value false.

Retrieves a hash code for this PlcWordAddress.

C#

public override int GetHashCode()

Returns

Int32

An Int32 that contains the hash code for the PlcWordAddress.

Returns a value indicating whether two instance of PlcWordAddress are equal.

C#

public static bool operator ==(PlcWordAddress left, PlcWordAddress right)

Determines whether the first specified PlcWordAddress object is greater than the second specified PlcWordAddress object.

C#

public static bool operator>(PlcWordAddress left, PlcWordAddress right)

Determines whether the first specified PlcWordAddress object is greater than or equal to the second specified PlcWordAddress object.

C#

public static bool operator >=(PlcWordAddress left, PlcWordAddress right)

Converts a string formatted as address to an PlcWordAddress object.

C#

public static implicit operator PlcWordAddress(string value)

Exceptions

FormatException

The value is not a valid PLC word address.

Returns a value indicating whether two instances of PlcWordAddress are not equal.

C#

public static bool operator !=(PlcWordAddress left, PlcWordAddress right)

Determines whether the first specified PlcWordAddress object is less than the second specified PlcWordAddress object.

C#

public static bool operator <(PlcWordAddress left, PlcWordAddress right)

Exceptions

ArgumentNullException

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

Determines whether the first specified PlcWordAddress object is less than or equal to the second PlcWordAddress object.

C#

public static bool operator <=(PlcWordAddress left, PlcWordAddress right)

Exceptions

ArgumentNullException

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