Class OnlineVariableInfo

Online variable information class.

Inheritance

System.Object

OnlineVariableInfo

Implements

IValueTagInfo

Namespace: Vortex.Adapters.Connector.Tc3

Assembly: Vortex.Adapters.Connector.Tc3.dll

Syntax

sealed class OnlineVariableInfo : IValueTagInfo

Constructors

OnlineVariableInfo(String, AdsClient)

Declaration

OnlineVariableInfo(string symbol, AdsClient client)

Parameters

Type	Name	Description
System.String	symbol
TwinCAT.Ads.AdsClient	client

Fields

_client

Declaration

AdsClient _client

Field Value

Type	Description
TwinCAT.Ads.AdsClient

_handle

Declaration

uint _handle

Field Value

Type	Description
System.UInt32

_symbols

Declaration

static Dictionary<string, ISymbol> _symbols

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, TwinCAT.TypeSystem.ISymbol>

reservedGroups

Declaration

static IEnumerable<uint> reservedGroups

Field Value

Type	Description
System.Collections.Generic.IEnumerable<System.UInt32>

Properties

AdsSymbol

Declaration

public ISymbol AdsSymbol { get; }

Property Value

Type	Description
TwinCAT.TypeSystem.ISymbol

BitSize

Gets the length of the variable.

Declaration

public int BitSize { get; }

Property Value

Type	Description
System.Int32

Handle

Declaration

public uint Handle { get; }

Property Value

Type	Description
System.UInt32

IndexGroup

Declaration

uint IndexGroup
{
}

Property Value

Type	Description
System.UInt32

IndexOffset

Gets index offset of the variable.

Declaration

uint IndexOffset
{
}

Property Value

Type	Description
System.UInt32

IsAvailableInController

Gets a value indicating whether the variable is available in the controller.

Declaration

bool IsAvailableInController
{
}

Property Value

Type	Description
System.Boolean

IsValid

Declaration

bool IsValid
{
}

Property Value

Type	Description
System.Boolean

Length

Gets the length of the variable.

Declaration

public int Length { get; }

Property Value

Type	Description
System.Int32

Name

Gets or sets variables name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

ReservedGroups

Declaration

static IEnumerable<uint> ReservedGroups
{
}

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.UInt32>

Size

Gets the length of the variable.

Declaration

public int Size { get; }

Property Value

Type	Description
System.Int32

Symbol

Gets the symbol of the variable.

Declaration

public string Symbol { get; }

Property Value

Type	Description
System.String

Methods

CreateSymbolTable(ISymbolCollection<ISymbol>, AdsConnector)

Declaration

static void CreateSymbolTable(ISymbolCollection<ISymbol> symbols, AdsConnector connector)

Parameters

Type	Name	Description
TwinCAT.TypeSystem.ISymbolCollection<TwinCAT.TypeSystem.ISymbol>	symbols
AdsConnector	connector

InvalidateSymbol()

Declaration

void InvalidateSymbol()

IsSymbolExpectedToBeAvailable(OnlineVariableInfo)

Gets true when online variable is expected to be is available in the controller and accessible to .Net environment.

Declaration

static bool IsSymbolExpectedToBeAvailable(OnlineVariableInfo onlineSymbolInfo)

Parameters

Type	Name	Description
OnlineVariableInfo	onlineSymbolInfo	Online variable symbol information.

Returns

Type	Description
System.Boolean	The System.Boolean.

Link(String, AdsConnector, OnlineVariableInfo)

Declaration

void Link(string symbol, AdsConnector connector, OnlineVariableInfo varInfo)

Parameters

Type	Name	Description
System.String	symbol
AdsConnector	connector
OnlineVariableInfo	varInfo

LinkOnlineVariableSymbolInfo(String, AdsConnector)

Declaration

void LinkOnlineVariableSymbolInfo(string symbol, AdsConnector connector)

Parameters

Type	Name	Description
System.String	symbol
AdsConnector	connector

LinkOnlineVariableSymbolInfo(OnlineVariableInfo, AdsConnector)

Declaration

void LinkOnlineVariableSymbolInfo(OnlineVariableInfo symbol, AdsConnector connector)

Parameters

Type	Name	Description
OnlineVariableInfo	symbol
AdsConnector	connector

LoadSymbolOnTheFly(AdsConnector)

Declaration

void LoadSymbolOnTheFly(AdsConnector connector)

Parameters

Type	Name	Description
AdsConnector	connector

LoadSymbolOnTheFlyFromPreLoadedSymbols(AdsConnector)

Declaration

void LoadSymbolOnTheFlyFromPreLoadedSymbols(AdsConnector connector)

Parameters

Type	Name	Description
AdsConnector	connector

LoadSymbolOnTheFlyUseSymbolLoader(AdsConnector)

Declaration

void LoadSymbolOnTheFlyUseSymbolLoader(AdsConnector connector)

Parameters

Type	Name	Description
AdsConnector	connector

LoadSymbolOnTheFlyUseSymbolReader(AdsConnector)

Declaration

void LoadSymbolOnTheFlyUseSymbolReader(AdsConnector connector)

Parameters

Type	Name	Description
AdsConnector	connector

SymbolInfoFactory(IAdsSymbol, String, AdsClient)

Declaration

public static OnlineVariableInfo SymbolInfoFactory(IAdsSymbol adsSymbolInfo, string symbol, AdsClient client)

Parameters

Type	Name	Description
TwinCAT.Ads.TypeSystem.IAdsSymbol	adsSymbolInfo
System.String	symbol
TwinCAT.Ads.AdsClient	client

Returns

Type	Description
OnlineVariableInfo

Explicit Interface Implementations

IValueTagInfo.Group

Declaration

uint IValueTagInfo.Group { get; }

Returns

Type	Description
System.UInt32

IValueTagInfo.IsAvailable

Declaration

bool IValueTagInfo.IsAvailable { get; }

Returns

Type	Description
System.Boolean

IValueTagInfo.Length

Declaration

int IValueTagInfo.Length { get; }

Returns

Type	Description
System.Int32

IValueTagInfo.Offset

Declaration

uint IValueTagInfo.Offset { get; }

Returns

Type	Description
System.UInt32

IValueTagInfo.Size

Declaration

int IValueTagInfo.Size { get; }

Returns

Type	Description
System.Int32

Implements

IValueTagInfo

Extension Methods

IValueTagExtensions.Cast<T>(T, Object)