Class RootTwinObject

Object to represent the root TwinObject. Instance of this class is typically used as root for the connector object.

Inheritance
object
RootTwinObject
Connector
Implements
Inherited Members
Namespace: AXSharp.Connector
Assembly: AXSharp.Connector.dll
Syntax
[Obsolete("This class should not be directly instantiated by framework consumers.")]
public class RootTwinObject : ITwinObject, ITwinElement

Properties

| Edit this page View Source

AttributeName

Gets empty name for this root object.

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

HumanReadable

Gets empty human readable of this root object.

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

Identity

Get sn empty identity for this root object.

Declaration
public OnlinerULInt Identity { get; }
Property Value
Type Description
OnlinerULInt
| Edit this page View Source

Interpreter

Declaration
public Translator Interpreter { get; }
Property Value
Type Description
Translator
| Edit this page View Source

Symbol

Gets empty symbol for this root object.

Declaration
public string Symbol { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

AddChild(ITwinObject)

Adds child object to this root object.

Declaration
public void AddChild(ITwinObject twinObject)
Parameters
Type Name Description
ITwinObject twinObject
| Edit this page View Source

AddKid(ITwinElement)

Add member to the list of kids

Declaration
public void AddKid(ITwinElement kid)
Parameters
Type Name Description
ITwinElement kid

Kid
| Edit this page View Source

AddValueTag(ITwinPrimitive)

Adds value tag to this root object.

Declaration
public void AddValueTag(ITwinPrimitive twinPrimitive)
Parameters
Type Name Description
ITwinPrimitive twinPrimitive
| Edit this page View Source

AnyChangeAsync<T>(T)

Compares if the current plain object has changed from the previous object.This method is used by the framework to determine if the object has changed and needs to be updated. [!NOTE] Any member in the hierarchy that is ignored by the compilers (e.g. when CompilerOmitAttribute is used) will not be compared, and therefore will not be detected as changed.

Declaration
public Task<bool> AnyChangeAsync<T>(T plain)
Parameters
Type Name Description
T plain
Returns
Type Description
Task<bool>
Type Parameters
Name Description
T
| Edit this page View Source

GetAttributeName(CultureInfo)

Declaration
public string GetAttributeName(CultureInfo culture)
Parameters
Type Name Description
CultureInfo culture
Returns
Type Description
string
| Edit this page View Source

GetChildren()

Get list for this root object.

Declaration
public IEnumerable<ITwinObject> GetChildren()
Returns
Type Description
IEnumerable<ITwinObject>
| Edit this page View Source

GetConnector()

Get the instance of connector of this root object.

Declaration
public Connector GetConnector()
Returns
Type Description
Connector
| Edit this page View Source

GetHumanReadable(CultureInfo)

Declaration
public string GetHumanReadable(CultureInfo culture)
Parameters
Type Name Description
CultureInfo culture
Returns
Type Description
string
| Edit this page View Source

GetKids()

Gets all kids of this object.

Declaration
public IEnumerable<ITwinElement> GetKids()
Returns
Type Description
IEnumerable<ITwinElement>
| Edit this page View Source

GetParent()

Gets this instance as parent object.

Declaration
public ITwinObject GetParent()
Returns
Type Description
ITwinObject
| Edit this page View Source

GetSymbolTail()

Get symbol tail of this object.

Declaration
public string GetSymbolTail()
Returns
Type Description
string
| Edit this page View Source

GetValueTags()

Gets value tags of this root object.

Declaration
public IEnumerable<ITwinPrimitive> GetValueTags()
Returns
Type Description
IEnumerable<ITwinPrimitive>
| Edit this page View Source

OnlineToPlain()

Declaration
public object OnlineToPlain()
Returns
Type Description
object
| Edit this page View Source

OnlineToPlain<T>()

Reads online data and retrieved POCO object populated with actual online data.

Declaration
public Task<T> OnlineToPlain<T>()
Returns
Type Description
Task<T>

POCO with online data of this object
Type Parameters
Name Description
T
| Edit this page View Source

PlainToOnline(object)

Declaration
public void PlainToOnline(object plain)
Parameters
Type Name Description
object plain
| Edit this page View Source

PlainToOnline<T>(T)

Writes data from POCO object to online data (PLC)

Declaration
public Task PlainToOnline<T>(T plain)
Parameters
Type Name Description
T plain

POCO object to be written to the controller.
Returns
Type Description
Task
Type Parameters
Name Description
T
| Edit this page View Source

PlainToShadow(object)

Declaration
public void PlainToShadow(object plain)
Parameters
Type Name Description
object plain
| Edit this page View Source

PlainToShadow<T>(T)

Writes data from POCO object to shadow data of this object.

Declaration
public Task PlainToShadow<T>(T plain)
Parameters
Type Name Description
T plain

POCO object to be written to the shadows of this object.
Returns
Type Description
Task
Type Parameters
Name Description
T
| Edit this page View Source

Poll()

Add this element for polling the in the next connector read cycle.

Declaration
public void Poll()
| Edit this page View Source

ShadowToPlain()

Declaration
public object ShadowToPlain()
Returns
Type Description
object
| Edit this page View Source

ShadowToPlain<T>()

Read data from shadows of this object to a new instance of a POCO object.

Declaration
public Task<T> ShadowToPlain<T>()
Returns
Type Description
Task<T>

POCO object populated by data from the shadows of this object.
Type Parameters
Name Description
T

Implements

Extension Methods