Class OnlinerWString

Class providing access to the WSTRING type online variable.

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

Constructors

| Edit this page View Source

OnlinerWString()

Initializes a new instance of the OnlinerWString class.

Declaration
public OnlinerWString()
| Edit this page View Source

OnlinerWString(ITwinObject, string, string)

Initializes a new instance of the OnlinerWString class.

Declaration
public OnlinerWString(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.

Properties

| Edit this page View Source

Cyclic

Gets tranlated and interpolated string of Cyclic value. Sets Cyclic value.

Declaration
public override string Cyclic { get; set; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

InstanceMaxValue

Gets the max value for this instance.

Declaration
public override string InstanceMaxValue { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

InstanceMinValue

Gets the min value for this instance.

Declaration
public override string InstanceMinValue { get; }
Property Value
Type Description
string
Overrides

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

GetAsync(CultureInfo)

Gets value translated in give CultureInfo

Declaration
public override Task<string> GetAsync(CultureInfo culture)
Parameters
Type Name Description
CultureInfo culture

Culture into which the value should be translated.
Returns
Type Description
Task<string>

Translated value.
Overrides
| Edit this page View Source

GetCyclic(CultureInfo)

Gets cyclic with provided CultureInfo

Declaration
public override string GetCyclic(CultureInfo culture = null)
Parameters
Type Name Description
CultureInfo culture

Desired culture.
Returns
Type Description
string

Translated value
Overrides
| 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