Class LiveClient

Inheritance
System.Object
LiveClient
Namespace: Vortex.Adapters.Connector.Tc3
Assembly: Vortex.Adapters.Connector.Tc3.dll
Syntax
class LiveClient

Fields

onlineSymbolRetriever

Declaration
readonly OnlineSymbolRetriever onlineSymbolRetriever
Field Value
Type Description
OnlineSymbolRetriever

SymbolLoaderSession

Declaration
AdsSession SymbolLoaderSession
Field Value
Type Description
TwinCAT.Ads.AdsSession

Properties

AmsNetId

Declaration
public AmsNetId AmsNetId { get; }
Property Value
Type Description
TwinCAT.Ads.AmsNetId

InternalAdsClient

Declaration
public AdsClient InternalAdsClient { get; }
Property Value
Type Description
TwinCAT.Ads.AdsClient

IsConnected

Declaration
public bool IsConnected { get; }
Property Value
Type Description
System.Boolean

OnAdsStateChangeEvent

Declaration
public AdsConnector.OnAdsStateChangeDelegate OnAdsStateChangeEvent { get; set; }
Property Value
Type Description
AdsConnector.OnAdsStateChangeDelegate

OnlineSymbolRetriever

Declaration
public OnlineSymbolRetriever OnlineSymbolRetriever { get; }
Property Value
Type Description
OnlineSymbolRetriever

Timeout

Declaration
public int Timeout { get; set; }
Property Value
Type Description
System.Int32

Methods

ClientAdsStateChanged(Object, AdsStateChangedEventArgs)

Declaration
void ClientAdsStateChanged(object sender, AdsStateChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
TwinCAT.Ads.AdsStateChangedEventArgs e

Connect(Int32)

Declaration
public void Connect(int srvPort)
Parameters
Type Name Description
System.Int32 srvPort

Connect(String, Int32)

Declaration
public void Connect(string netId, int srvPort)
Parameters
Type Name Description
System.String netId
System.Int32 srvPort

CreateVariableHandle(String)

Declaration
public uint CreateVariableHandle(string varName)
Parameters
Type Name Description
System.String varName
Returns
Type Description
System.UInt32

Dispose()

Declaration
public void Dispose()

LoadAndSortOnlineVariablesSymbolList(AdsConnector)

Declaration
public void LoadAndSortOnlineVariablesSymbolList(AdsConnector connector)
Parameters
Type Name Description
AdsConnector connector

LoadAndSortOnlineVariablesSymbolListAll(AdsConnector)

Declaration
void LoadAndSortOnlineVariablesSymbolListAll(AdsConnector connector)
Parameters
Type Name Description
AdsConnector connector

Read(UInt32, UInt32, Memory<Byte>)

Declaration
public void Read(uint indexGroup, uint indexOffset, Memory<byte> adsStream)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
System.Memory<System.Byte> adsStream

ReadAny(UInt32, UInt32, Type)

Declaration
public object ReadAny(uint indexGroup, uint indexOffset, Type type)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
System.Type type
Returns
Type Description
System.Object

ReadAny<T>(UInt32, UInt32, Int32[])

Declaration
public T ReadAny<T>(uint indexGroup, uint indexOffset, int[] args)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
System.Int32[] args
Returns
Type Description
T
Type Parameters
Name Description
T

ReadAnyString(OnlineVariableInfo)

Declaration
public string ReadAnyString(OnlineVariableInfo varInfo)
Parameters
Type Name Description
OnlineVariableInfo varInfo
Returns
Type Description
System.String

ReadAnyWString(OnlineVariableInfo)

Declaration
public string ReadAnyWString(OnlineVariableInfo varInfo)
Parameters
Type Name Description
OnlineVariableInfo varInfo
Returns
Type Description
System.String

ReadSymbolInfo(String)

Declaration
public IAdsSymbol ReadSymbolInfo(string symbol)
Parameters
Type Name Description
System.String symbol
Returns
Type Description
TwinCAT.Ads.TypeSystem.IAdsSymbol

ReadWrite(UInt32, UInt32, Memory<Byte>, ReadOnlyMemory<Byte>)

Declaration
public void ReadWrite(uint indexGroup, uint indexOffset, Memory<byte> rdDataStream, ReadOnlyMemory<byte> wrDataStream)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
System.Memory<System.Byte> rdDataStream
System.ReadOnlyMemory<System.Byte> wrDataStream

TryConnect(Int32, AdsConnector)

Declaration
public void TryConnect(int srvPort, AdsConnector connector)
Parameters
Type Name Description
System.Int32 srvPort
AdsConnector connector

TryConnect(String, Int32, AdsConnector)

Declaration
public void TryConnect(string netId, int srvPort, AdsConnector connector)
Parameters
Type Name Description
System.String netId
System.Int32 srvPort
AdsConnector connector

TryReadState(out StateInfo)

Declaration
public AdsErrorCode TryReadState(out StateInfo stateInfo)
Parameters
Type Name Description
TwinCAT.Ads.StateInfo stateInfo
Returns
Type Description
TwinCAT.Ads.AdsErrorCode

Write(UInt32, UInt32, ReadOnlyMemory<Byte>)

Declaration
public void Write(uint indexGroup, uint indexOffset, ReadOnlyMemory<byte> adsStream)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
System.ReadOnlyMemory<System.Byte> adsStream

WriteAny<T>(UInt32, UInt32, T)

Declaration
public void WriteAny<T>(uint indexGroup, uint indexOffset, T value)
Parameters
Type Name Description
System.UInt32 indexGroup
System.UInt32 indexOffset
T value
Type Parameters
Name Description
T

WriteAny<T>(OnlineVariableInfo, T)

Declaration
public void WriteAny<T>(OnlineVariableInfo varInfo, T value)
Parameters
Type Name Description
OnlineVariableInfo varInfo
T value
Type Parameters
Name Description
T

WriteAnyString(OnlineVariableInfo, String)

Declaration
public void WriteAnyString(OnlineVariableInfo varInfo, string value)
Parameters
Type Name Description
OnlineVariableInfo varInfo
System.String value

WriteAnyWString(OnlineVariableInfo, String)

Declaration
public void WriteAnyWString(OnlineVariableInfo varInfo, string value)
Parameters
Type Name Description
OnlineVariableInfo varInfo
System.String value

Extension Methods