Class WebApiUdInt

Represents wrapper for a PLC UDINT variable.

Inheritance
object
OnlinerBase
OnlinerBase<uint>
OnlinerUDInt
WebApiUdInt
Implements
Inherited Members
Namespace: AXSharp.Connector.S71500.WebApi
Assembly: AXSharp.Connector.S71500.WebAPI.dll
Syntax
public class WebApiUdInt : OnlinerUDInt, INotifyPropertyChanged, IValueBoundaries<uint>, IOnlineUDInt, IOnline<uint>, IShadowUDInt, IShadow<uint>, ITwinPrimitive, ITwinElement

Constructors

| Edit this page View Source

WebApiUdInt()

Initializes a new instance of the OnlinerUDInt class.

Declaration
public WebApiUdInt()
| Edit this page View Source

WebApiUdInt(ITwinObject, string, string)

Initializes a new instance of the OnlinerUDInt class.

Declaration
public WebApiUdInt(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()

Gets the value of this variable from the controller asynchronously.

Declaration
public override Task<uint> GetAsync()
Returns
Type Description
Task<uint>
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(uint)

Sets the value of this variable to the controller asynchronously.

Declaration
public override Task<uint> SetAsync(uint value)
Parameters
Type Name Description
uint value
Returns
Type Description
Task<uint>
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