PlcByteAddress Members

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

C#

public PlcByteAddress(PlcOperand operand, int byteNumber)

Parameters

operand PlcOperand

The PlcOperand to that the new PlcByteAddress refers.

byteNumber Int32

The number of the byte to that the new PlcByteAddress 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 PlcByteAddress class using the specified operandType and byteNumber.

C#

public PlcByteAddress(PlcOperandType operandType, int byteNumber)

Parameters

operandType PlcOperandType

The PlcOperandType to that the new PlcByteAddress refers.

byteNumber Int32

The number of the byte to that the new PlcByteAddress 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 PlcByteAddress class using the specified operandType, operandNumber and byteNumber.

C#

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

Parameters

operandType PlcOperandType

The PlcOperandType to that the new PlcByteAddress refers.

operandNumber Int32

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

byteNumber Int32

The number of the byte to that the new PlcByteAddress 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 PlcByteAddress class with serialized data.

C#

protected PlcByteAddress(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).

Creates a new PlcBitAddress from this PlcByteAddress using the bitNumber specified.

C#

public PlcBitAddress Bit(int bitNumber)

Parameters

bitNumber Int32

The number of the bit to that the new PlcBitAddress refers.

Returns

PlcBitAddress

A new PlcBitAddress which refers to the bitNumber specified.

Exceptions

ArgumentException

The type of Operand does not support a bit number.

ArgumentOutOfRangeException

The bitNumber is out of the bounds defined by MinBitNumber or MaxBitNumber.

Compares the current PlcByteAddress with the other.

C#

public override int CompareTo(object other)

Parameters

other Object

The PlcByteAddress to compare with this PlcByteAddress.

Returns

Int32

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

Compares the current PlcByteAddress with another PlcByteAddress.

C#

public int CompareTo(PlcByteAddress other)

Parameters

other PlcByteAddress

The PlcByteAddress to compare with this PlcByteAddress.

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 PlcByteAddress.

C#

public override bool Equals(object other)

Parameters

other Object

The PlcByteAddress to compare to the current PlcByteAddress.

Returns

Boolean

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

Determines whether the specified other is equal to this PlcByteAddress.

C#

public bool Equals(PlcByteAddress other)

Parameters

other PlcByteAddress

The PlcByteAddress to compare to the current PlcByteAddress.

Returns

Boolean

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

Retrieves a hash code for this PlcByteAddress.

C#

public override int GetHashCode()

Returns

Int32

An Int32 that contains the hash code for the PlcByteAddress.

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

C#

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

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

C#

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

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

C#

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

Converts a string formatted as address to an PlcByteAddress object.

C#

public static implicit operator PlcByteAddress(string value)

Exceptions

FormatException

The value is not a valid PLC byte address.

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

C#

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

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

C#

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

Exceptions

ArgumentNullException

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

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

C#

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

Exceptions

ArgumentNullException

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