PlcStatus Members

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

PlcStatus()

Initializes a new instance of the PlcStatus class.

C#

public PlcStatus()

Changed

Occurs when the PlcStatus changed.

C#

public event EventHandler Changed

Code

Gets the recent code of the status represented.

C#

public PlcStatusCode Code { get; }


Property Value

PlcStatusCode

One of the members defined by the PlcStatusCode enumeration. Which specifies the concrete type of status represented.

Exception

Gets the PlcException which is thrown in case there the evaluation of the PlcStatus does indicate an exceptional situation.

C#

public PlcException Exception { get; }


Property Value

PlcException

An instance of the PlcException class initialized according to the current state of this PlcStatus.

InnerException

Gets the Exception which occured during the most recent operation.

C#

public Exception InnerException { get; }


Property Value

Exception

The Exception which occured during the most recent operation.

SocketCode

Gets the code of the recent socket operation performed its status is represented.

C#

public int SocketCode { get; }


Property Value

Int32

The code of the recent socket operation performed its status is represented.

Text

Gets the string representation of the Code.

C#

public string Text { get; }


Property Value

String

The string representation of the Code. These String value describes the status in a more meaningful way as the Code does.

TimeStamp

Gets the date and time of the most recent update of the status data provided by this PlcStatus.

C#

public DateTime TimeStamp { get; }


Property Value

DateTime

The DateTime of the most recent metadata update.

Type

Gets the PlcType affected by the most recent operation.

C#

public PlcType Type { get; }


Property Value

PlcType

The PlcType affected by the most recent operation.

GetText(PlcStatusCode)

Retrieves a meaningful string value which describes the status represented by the code.

C#

public static string GetText(PlcStatusCode code)


Parameters

code PlcStatusCode

The PlcStatusCode its textual description is to be retrieved.


Returns

String

A meaningful string value which describes the code.

GetText(PlcStatusCode, Int32)

Retrieves a meaningful string value which describes the status represented by the code and socketCode.

C#

public static string GetText(PlcStatusCode code, int socketCode)


Parameters

code PlcStatusCode

The PlcStatusCode its textual description is to be retrieved.

socketCode Int32

The code of the socket operation which ended with the code.


Returns

String

A meaningful string value which describes the code and socketCode.

GetText(PlcStatusCode, Int32, PlcType)

Retrieves a meaningful string value which describes the status represented by the code, socketCode and type.

C#

public static string GetText(PlcStatusCode code, int socketCode, PlcType type)


Parameters

code PlcStatusCode

The PlcStatusCode its textual description is to be retrieved.

socketCode Int32

The code of the socket operation which ended with the code.

type PlcType

The PlcType which was affected by the operation its status text is to be retrieved.


Returns

String

A meaningful string value which describes the code and socketCode.

OnChanged(EventArgs)

Raises the Changed event.

C#

protected virtual void OnChanged(EventArgs e)


Parameters

e EventArgs

The EventArgs that contains the event data.

ToString()

Returns a string that represents the PlcStatus.

C#

public override string ToString()


Returns

String

A string that represents the PlcStatus.