Class AdsConnector

Ads connector.

Inheritance
System.Object
RootVortexerObject
IConnector
AdsConnector
Implements
System.IDisposable
System.ComponentModel.INotifyPropertyChanged
Inherited Members
Namespace: Vortex.Adapters.Connector.Tc3
Assembly: Vortex.Adapters.Connector.Tc3.dll
Syntax
class AdsConnector : IConnector, IVortexObject, ITwinObject, IVortexElement, IDisposable, INotifyPropertyChanged

Constructors

AdsConnector()

Initializes a new instance of the AdsConnector class.

Declaration
public AdsConnector()

AdsConnector(Object[])

Initializes new instance of AdsConnector

Declaration
public AdsConnector(object[] parameters)
Parameters
Type Name Description
System.Object[] parameters

Connection parameters

Fields

_justBuilt

Declaration
bool _justBuilt
Field Value
Type Description
System.Boolean

_onlineVariables

Declaration
IAdsBaseType[] _onlineVariables
Field Value
Type Description
IAdsBaseType[]

chunk_size

Declaration
readonly int chunk_size
Field Value
Type Description
System.Int32

HasAdsSymbolVersionChanged

Declaration
bool HasAdsSymbolVersionChanged
Field Value
Type Description
System.Boolean

liveClient

Declaration
readonly LiveClient liveClient
Field Value
Type Description
LiveClient
Declaration
List<IAdsBaseType> onlineTagToObjectLinks
Field Value
Type Description
System.Collections.Generic.List<IAdsBaseType>

qr

Declaration
IQueryable<IAdsBaseType> qr
Field Value
Type Description
System.Linq.IQueryable<IAdsBaseType>

readSumMutex

Declaration
volatile object readSumMutex
Field Value
Type Description
System.Object

rwopsAction

Declaration
Action rwopsAction
Field Value
Type Description
System.Action

writeSumMutex

Declaration
volatile object writeSumMutex
Field Value
Type Description
System.Object

Properties

AMSID

Declaration
public string AMSID { get; }
Property Value
Type Description
System.String

Client

Gets the client.

Declaration
LiveClient Client
{
}
Property Value
Type Description
LiveClient

DoNotStartReportingConsole

Gets or sets a value indicating whether start reporting console.

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

Do not start reporting console when true.

ErrorCount

Declaration
public override int ErrorCount { get; set; }
Property Value
Type Description
System.Int32
Overrides

LoadingStatus

Gets or sets the loading status.

Declaration
public static string LoadingStatus { get; set; }
Property Value
Type Description
System.String

The loading status.

Name

Gets or sets the name of this connector.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name of the connector.

NetId

Gets the net id.

Declaration
public string NetId { get; }
Property Value
Type Description
System.String

The net id.

OnlineTags

Declaration
public override IEnumerable<IValueTag> OnlineTags { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IValueTag>
Overrides

OnlineVariables

Declaration
IAdsBaseType[] OnlineVariables
{
}
Property Value
Type Description
IAdsBaseType[]

PreventSynchronousAccess

Declaration
bool PreventSynchronousAccess
{
}
Property Value
Type Description
System.Boolean

SrvPort

Gets the server port.

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

The server port.

SymbolLoadingMode

Gets or sets symbol loading mode.

Declaration
public SymbolLoadingMode SymbolLoadingMode { get; set; }
Property Value
Type Description
SymbolLoadingMode

SymbolLoadMethod

Get or sets symbol loading method.

Declaration
public SymbolLoadMethod SymbolLoadMethod { get; set; }
Property Value
Type Description
SymbolLoadMethod

Timeout

Gets or sets a value indicating whether synchronous access should be suspended. Typically this value should be set to true during extensive reflection operation when synchronous access to the controller is not required. Suspending synchronous access considerably improves performance. N.B. Suspended synchronous access bypasses all synchronous read and write operations with no further warning.

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

Synchronous access is suspended.

Methods

AddTagLink(IAdsBaseType)

Declaration
void AddTagLink(IAdsBaseType variable)
Parameters
Type Name Description
IAdsBaseType variable

AdsClient_AdsStateChanged(Object, AdsStateChangedEventArgs)

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

AdsClient_AdsSymbolVersionChanged(Object, EventArgs)

Declaration
void AdsClient_AdsSymbolVersionChanged(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

BuildAndStart()

Declaration
public override IConnector BuildAndStart()
Returns
Type Description
IConnector
Overrides

ConnectToController(String, Int32)

Creates connection.

Declaration
protected void ConnectToController(string netId, int srvPort)
Parameters
Type Name Description
System.String netId

The net id.
System.Int32 srvPort

The server port.

CyclicRead()

Reads online variables required to be read.

Declaration
protected void CyclicRead()

CyclicWrite()

Writes modified online variables.

Declaration
protected void CyclicWrite()

CyclicWriteRead()

Write read operation.

Declaration
protected void CyclicWriteRead()

Dispose()

The dispose.

Declaration
public void Dispose()

InitializeConnector()

Initializes connector for on line operations.

Declaration
void InitializeConnector()

InvalidateSymbols()

Declaration
void InvalidateSymbols()

InvokeRpc(String, String, Object[])

Declaration
public override object InvokeRpc(string symbolPath, string methodName, object[] params)
Parameters
Type Name Description
System.String symbolPath
System.String methodName
System.Object[] params
Returns
Type Description
System.Object
Overrides

ReadBatch(IEnumerable<IValueTag>)

Declaration
public override void ReadBatch(IEnumerable<IValueTag> valueTags)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IValueTag> valueTags
Overrides

ReadFully(Stream)

Declaration
public static byte[] ReadFully(Stream input)
Parameters
Type Name Description
System.IO.Stream input
Returns
Type Description
System.Byte[]

ReadSum(IEnumerable<IAdsBaseType>)

The read sum non extended types from current Ads connection.

Declaration
void ReadSum(IEnumerable<IAdsBaseType> tags)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IAdsBaseType> tags

Online tags to be read.

ReloadConnector()

Declaration
public override void ReloadConnector()
Overrides

SetAllToCyclicReading()

Sets all online variables to cyclic reading.

Declaration
[Obsolete]
public void SetAllToCyclicReading()

SplitIntoChunks<T>(IEnumerable<T>, Int32)

Declaration
static IEnumerable<IEnumerable<T>> SplitIntoChunks<T>(IEnumerable<T> source, int chunkSize)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<T> source
System.Int32 chunkSize
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<T>>
Type Parameters
Name Description
T

StartReadWriteOps()

Starts cyclical read write operation on this connector.

Declaration
protected void StartReadWriteOps()

WriteBatch(IEnumerable<IValueTag>)

Declaration
public override void WriteBatch(IEnumerable<IValueTag> valueTags)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IValueTag> valueTags
Overrides

WriteSum(IEnumerable<IAdsBaseType>)

Writes non extended online variables.

Declaration
void WriteSum(IEnumerable<IAdsBaseType> tags)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IAdsBaseType> tags

Online tags to be written.

Implements

System.IDisposable
System.ComponentModel.INotifyPropertyChanged

Extension Methods