Class WebApiWString

Represents wrapper for a PLC WSTRING variable.

Inheritance
object
OnlinerBase
OnlinerBase<string>
OnlinerWString
WebApiWString
Implements
Inherited Members
Namespace: AXSharp.Connector.S71500.WebApi
Assembly: AXSharp.Connector.S71500.WebAPI.dll
Syntax
public class WebApiWString : OnlinerWString, INotifyPropertyChanged, IValueBoundaries<string>, IOnlineWString, IOnline<string>, IShadowWString, IShadow<string>, ITwinPrimitive, ITwinElement

Constructors

| Edit this page View Source

WebApiWString()

Initializes a new instance of the OnlinerWString class.

Declaration
public WebApiWString()
| Edit this page View Source

WebApiWString(ITwinObject, string, string)

Initializes a new instance of the OnlinerWString class.

Declaration
public WebApiWString(ITwinObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
ITwinObject parent

Parent object of this instance.
string readableTail

Human readable tail of this instance.
string symbolTail

Symbol tail of this instance.

Methods

| Edit this page View Source

GetAsync()

Get the value of this OnlinerWString.

Declaration
public override Task<string> GetAsync()
Returns
Type Description
Task<string>

Value of this OnlinerWString
Overrides
Remarks

This method accesses the item in a single request over communication layer; accessing multiple items may result in performance degradation over the communication interface with the target system. This method is to be used only when you need the item to be read from the PLC and the return the control of the program. Consider using ITwinObjects ReadAsync(ITwinObject) or WriteAsync(ITwinObject) methods for bulk access to entire structures.

| Edit this page View Source

Read(string)

Declaration
public void Read(string value)
Parameters
Type Name Description
string value
| Edit this page View Source

SetAsync(string)

Sets the value of this OnlinerWString.

Declaration
public override Task<string> SetAsync(string value)
Parameters
Type Name Description
string value

Value to be set.
Returns
Type Description
Task<string>
Overrides
Remarks

This method accesses the item in a single request over communication layer; accessing multiple items may result in performance degradation over the communication interface with the target system. This method is to be used only when you need the item to be read from the PLC and the return the control of the program. Consider using ITwinObjects ReadAsync(ITwinObject) or WriteAsync(ITwinObject) methods for bulk access to entire structures.

Implements

Extension Methods