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

 Manage book (0 page(s))
 Help

IPDeviceEndPoint Members

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

Constructors

IPDeviceEndPoint(IPAddress)

Initializes a new instance of the IPDeviceEndPoint class with the specified address.

C# 

public IPDeviceEndPoint(IPAddress address)


Parameters

address IPAddress

The IPAddress of the endpoint.


Exceptions

ArgumentNullException

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

IPDeviceEndPoint(IPAddress, Int32)

Initializes a new instance of the IPDeviceEndPoint class with the specified address and rack number.

C# 

public IPDeviceEndPoint(IPAddress address, int rack)


Parameters

address IPAddress

The IPAddress of the endpoint.

rack Int32

The rack number associated with the address.


Exceptions

ArgumentNullException

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

ArgumentOutOfRangeException

The rack is out of the bounds defined by MinRack or MaxRack.

IPDeviceEndPoint(IPAddress, Int32, Int32)

Initializes a new instance of the IPDeviceEndPoint class with the specified address, rack number and slot number.

C# 

public IPDeviceEndPoint(IPAddress address, int rack, int slot)


Parameters

address IPAddress

The IPAddress of the endpoint.

rack Int32

The rack number associated with the address.

slot Int32

The slot number associated with the address.


Exceptions

ArgumentNullException

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

ArgumentOutOfRangeException

The rack or slot is out of the bounds defined by MinRack, MaxRack, MinSlot or MaxSlot.

IPDeviceEndPoint(String)

Initializes a new instance of the IPDeviceEndPoint class with the specified address.

C# 

public IPDeviceEndPoint(string address)


Parameters

address String

The string representation of an IPAddress of the endpoint.


Exceptions

ArgumentException

The address is equal to Empty.

ArgumentNullException

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

FormatException

The address is an invalid string representation of an IPAddress.

IPDeviceEndPoint(String, Int32)

Initializes a new instance of the IPDeviceEndPoint class with the specified address and rack number.

C# 

public IPDeviceEndPoint(string address, int rack)


Parameters

address String

The string representation of an IPAddress of the endpoint.

rack Int32

The rack number associated with the address.


Exceptions

ArgumentException

The address is equal to Empty.

ArgumentNullException

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

ArgumentOutOfRangeException

The rack is out of the bounds defined by MinRack or MaxRack.

FormatException

The address is an invalid string representation of an IPAddress.

IPDeviceEndPoint(String, Int32, Int32)

Initializes a new instance of the IPDeviceEndPoint class with the specified address, rack number and slot number.

C# 

public IPDeviceEndPoint(string address, int rack, int slot)


Parameters

address String

The string representation of an IPAddress of the endpoint.

rack Int32

The rack number associated with the address.

slot Int32

The slot number associated with the address.


Exceptions

ArgumentException

The address is equal to Empty.

ArgumentNullException

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

ArgumentOutOfRangeException

The rack or slot is out of the bounds defined by MinRack, MaxRack, MinSlot or MaxSlot.

FormatException

The address is an invalid string representation of an IPAddress.

Fields

DefaultRack

Specifies the default value that is by default assigned to the Rack property.

C# 

public const int DefaultRack = 0


Field Value
Int32

DefaultSlot

Specifies the default value that is by default assigned to the Slot property.

C# 

public const int DefaultSlot = 2


Field Value
Int32

MaxRack

Specifies the maximum value that can be assigned to the Rack property.

C# 

public const int MaxRack = 65535


Field Value
Int32

MaxSlot

Specifies the maximum value that can be assigned to the Slot property.

C# 

public const int MaxSlot = 65535


Field Value
Int32

MinRack

Specifies the minimum value that can be assigned to the Rack property.

C# 

public const int MinRack = 0


Field Value
Int32

MinSlot

Specifies the minimum value that can be assigned to the Slot property.

C# 

public const int MinSlot = 0


Field Value
Int32

Properties

Address

Gets or sets the IP address of the endpoint.

C# 

public virtual IPAddress Address { get; set; }


Property Value

IPAddress

An instance of the IPAddress class containing the IP address of the endpoint.



Exceptions

ArgumentNullException

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

AddressFamily

Gets the address family to which the endpoint belongs.

C# 

public override AddressFamily AddressFamily { get; }


Property Value

Sockets.AddressFamily

One of the members defined by the AddressFamily enumeration. Which specifies the addressing scheme that is used by the endpoint's underlying network protocol.

IsCustomRack

Gets a value indicating whether a custom rack has been associated with this endpoint.

C# 

public bool IsCustomRack { get; }


Property Value

Boolean

The value true, if there was a custom rack assigned to this endpoint; otherwise the value false.



Remarks

In case there is no custom rack number defined the PLC driver does decide on its own which rack is to be used by default to address the PLC device.

IsCustomSlot

Gets a value indicating whether a custom slot has been associated with this endpoint.

C# 

public bool IsCustomSlot { get; }


Property Value

Boolean

The value true, if there was a custom slot assigned to this endpoint; otherwise the value false.



Remarks

In case there is no custom slot number defined the PLC driver does decide on its own which slot is to be used by default to address the PLC device.

Rack

Gets or sets the rack number of the endpoint.

C# 

public int Rack { get; set; }


Property Value

Int32

An integer value in the range MinRack to MaxRack indicating the rack number of the endpoint.



Exceptions

ArgumentOutOfRangeException

The value that was specified is less than MinRack or greater than MaxRack.



Remarks

In case there is no custom rack number defined this property does return the most typical default rack number defined by DefaultRack.

Slot

Gets or sets the slot number of the endpoint.

C# 

public int Slot { get; set; }


Property Value

Int32

An integer value in the range MinSlot to MaxSlot indicating the slot number of the endpoint.



Exceptions

ArgumentOutOfRangeException

The value that was specified is less than MinSlot or greater than MaxSlot.



Remarks

In case there is no custom slot number defined this property does return the most typical default rack number defined by DefaultSlot.

Methods

GetHashCode()

Returns a hash value for an endpoint.

C# 

public override int GetHashCode()


Returns

Int32

An integer hash value.

ToString()

Returns a string that represents the current IPDeviceEndPoint.

C# 

public override string ToString()


Returns

String

A string that represents the current IPDeviceEndPoint.