Class OnlinerBase

Base non-generic class for onliner types

Inheritance

object

OnlinerBase

OnlinerBase<T>

Implements

ITwinPrimitive

ITwinElement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: AXSharp.Connector.ValueTypes

Assembly: AXSharp.Connector.dll

Syntax

public abstract class OnlinerBase : ITwinPrimitive, ITwinElement

Constructors

OnlinerBase()

Creates new instance of OnlinerBase

Declaration

protected OnlinerBase()

OnlinerBase(ITwinObject, string, string)

Creates an instance of OnlinerBase<T>.

Declaration

protected OnlinerBase(ITwinObject parent, string readableTail, string symbolTail)

Parameters

Type	Name	Description
ITwinObject	parent	Parent object that creates this instance.
string	readableTail	HumanReadable tail of this instance.
string	symbolTail	Symbol tail of this instance.

Properties

AccessStatus

Holds information about the data exchange between target system and the application.

Declaration

public PrimitiveAccessStatus AccessStatus { get; }

Property Value

Type	Description
PrimitiveAccessStatus

AttributeFormatString

Gets or sets string format for the display of the value.

Declaration

public string AttributeFormatString { get; set; }

Property Value

Type	Description
string

Remarks

If you would like to transform the value using String.Format use FormatString attribute in your PLC code. Notice the usage of [[ and ]]. During runtime "[[" will be replaced with "{" and "[[" will be replaced with "}" so you can use String.Format class as you wish.

Examples

{attribute addProperty Name "REAL"}
{attribute addProperty FormatString "[[0:F2]]"}
REAL_val : REAL;

AttributeName

Gets or sets the attribute name.

Declaration

public string AttributeName { get; set; }

Property Value

Type	Description
string

EditValueChange

Delegate invoked when the 'Edit' value changes.

Declaration

public virtual OnlinerBase.ValueChangeDelegate EditValueChange { get; set; }

Property Value

Type	Description
OnlinerBase.ValueChangeDelegate

HumanReadable

Provides a string combined from AttributeName of ancestors (Parent) of this instance and the tail of this instance.

Declaration

public string HumanReadable { get; protected set; }

Property Value

Type	Description
string

Interpreter

Declaration

public Translator Interpreter { get; }

Property Value

Type	Description
Translator

Parent

Gets the parent object of this instance. Parent object is the object that created this instance.

Declaration

protected ITwinObject Parent { get; set; }

Property Value

Type	Description
ITwinObject

PollingInterval

Gets current polling interval.

Declaration

public int PollingInterval { get; }

Property Value

Type	Description
int

ReadOnce

Indicates that the member should be accessed only once during the lifetime of the application when accessing using polling or cyclic access. Other types of access won't be affected (Batch/Direct).

Declaration

public bool ReadOnce { get; }

Property Value

Type	Description
bool

ReadWriteAccess

Gets the read write access mode for this tag.

Declaration

public ReadWriteAccess ReadWriteAccess { get; }

Property Value

Type	Description
ReadWriteAccess

ShadowValueChange

Delegate invoked when the 'Shadow' value changes.

Declaration

public virtual OnlinerBase.ValueChangeDelegate ShadowValueChange { get; set; }

Property Value

Type	Description
OnlinerBase.ValueChangeDelegate

Symbol

Gets the symbol of this on line variable.

Declaration

public string Symbol { get; protected set; }

Property Value

Type	Description
string

SymbolTail

Gets or sets the tail of the symbol of this tag.

Declaration

protected string SymbolTail { get; set; }

Property Value

Type	Description
string

Methods

AddToPeriodicQueue()

Declaration

public void AddToPeriodicQueue()

CreateSymbol(string, string)

Creates symbol path concatenating parent symbol with child symbol

Declaration

protected static string CreateSymbol(string rootSymbol, string symbol)

Parameters

Type	Name	Description
string	rootSymbol	Parent symbol.
string	symbol	Symbol tail.

Returns

Type	Description
string

FromOnlineToShadow()

Copies the value from the plc to the shadow value holder.

Declaration

public abstract void FromOnlineToShadow()

FromShadowToOnline()

Copies the value from the shadow value holder to the respective plc variable.

Declaration

public abstract void FromShadowToOnline()

GetAttributeName(CultureInfo)

Declaration

public string GetAttributeName(CultureInfo culture)

Parameters

Type	Name	Description
CultureInfo	culture

Returns

Type	Description
string

GetHumanReadable(CultureInfo)

Declaration

public string GetHumanReadable(CultureInfo culture)

Parameters

Type	Name	Description
CultureInfo	culture

Returns

Type	Description
string

GetParent()

Gets the parent object of this instance. Parent object is the object that created this instance.

Declaration

public ITwinObject GetParent()

Returns

Type	Description
ITwinObject	Parent object.

GetSymbolTail()

Gets tail of the this tag symbol.

Declaration

public string GetSymbolTail()

Returns

Type	Description
string	Tail of this tag's symbol.

GetValueChangeEventSubscribers()

Gets delegates associated with ValueChangeEvent

Declaration

public IEnumerable<Delegate> GetValueChangeEventSubscribers()

Returns

Type	Description
IEnumerable<Delegate>

MakeReadOnce()

Sets the member to be accessed only once during the lifetime of the application. This applies only on periodic (polling or cyclic reading)

Declaration

public void MakeReadOnce()

MakeReadOnly()

Makes this tag readonly for the current application.

Declaration

public void MakeReadOnly()

NotifyPropertyChanged(string)

Implementation of INotifyPropertyChanged.

Declaration

protected void NotifyPropertyChanged(string propertyName)

Parameters

Type	Name	Description
string	propertyName	Property name.

OnValueChangeEvent(object)

Notifies the change of cyclic value.

Declaration

protected void OnValueChangeEvent(object newValue)

Parameters

Type	Name	Description
object	newValue

Poll()

Add this primitive to next periodic read queue.

Declaration

public void Poll()

Subscribe()

Subscribes for periodic reading of this variable.

Declaration

public void Subscribe()

Subscribe(ValueChangedEventHandlerDelegate)

Subscribes this tag for cyclical reading and invokes ValueChangedEventHandlerDelegate when the value changes.

Declaration

public void Subscribe(ValueChangedEventHandlerDelegate handler)

Parameters

Type	Name	Description
ValueChangedEventHandlerDelegate	handler	Handles the value change event.

SubscribeForPeriodicReading()

Subscribes this item for periodic reading.

Declaration

public void SubscribeForPeriodicReading()

UnSubscribe(ValueChangedEventHandlerDelegate)

Un-subscribes this tag from handling the value change. The cyclical reading of this tag will not be cancelled.

Declaration

public void UnSubscribe(ValueChangedEventHandlerDelegate handler)

Parameters

Type	Name	Description
ValueChangedEventHandlerDelegate	handler

Events

PropertyChanged

Implementation of INotifyPropertyChanged interface.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

ValueChangeEvent

Onliner cyclic property changed event.

Declaration

public event ValueChangedEventHandlerDelegate ValueChangeEvent

Event Type

Type	Description
ValueChangedEventHandlerDelegate

Implements

ITwinPrimitive

ITwinElement

Extension Methods

TranslatorExtension.Translate(ITwinElement, string, CultureInfo)

TwinObjectExtensions.HasAttribute<T>(ITwinElement)

TwinObjectExtensions.StartPolling(ITwinElement, int, object)

TwinObjectExtensions.StopPolling(ITwinElement, object)

TwinPrimitiveExtensions.GetAttribute<T>(ITwinElement)

TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement)

TwinPrimitiveExtensions.GetCyclicValue<T>(OnlinerBase)

TwinPrimitiveExtensions.GetLastValue<T>(OnlinerBase)

TwinPrimitiveExtensions.GetShadowValue<T>(OnlinerBase)

TwinPrimitiveExtensions.SetCyclicValue<T>(OnlinerBase, T)

TwinPrimitiveExtensions.SetShadowValue<T>(OnlinerBase, T)