ISumRead2.S. Interface

Interface ISumRead2 (supports extended Sum SubResults) Implements the ISumCommand

Namespace:  TwinCAT.Ads.SumCommand
Assembly:  TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

public interface ISumRead2<S> : ISumCommand

Type Parameters

S

The ISumRead2.S. type exposes the following members.

Properties

 

Name

Description

Connection

The connection used for communication. (Inherited from ISumCommand.)

ErrorStrategy

Gets the error strategy of the ISumCommand (Inherited from ISumCommand.)

Executed

Gets a value indicating whether this ISumCommand was already executed. (Inherited from ISumCommand.)

Failed

Gets a value indicating whether this ISumCommand failed. (Inherited from ISumCommand.)

FailedCount

Gets the count of failed subcommands. (Inherited from ISumCommand.)

Result

Gets the AdsErrorCode of the main SumCommandBase ADS Request (Inherited from ISumCommand.)

SubResults

Gets the sub results of the single Sub Requests. (Inherited from ISumCommand.)

Succeeded

Gets a value indicating whether this ISumCommand is succeeded. (Inherited from ISumCommand.)

SucceededCount

Gets the count of succeeded subcommands. (Inherited from ISumCommand.)

Methods

 

Name

Description

Read2

Reads the Values.

Read2Async

Reads Symbol values as an asynchronous operation.

Extension Methods

 

Name

Description

AllFailed

Gets a value indicating, that all SubCommands failed. (Defined by ISumCommandExtension.)

AllSucceeded

Gets a value indicating, that all SubCommands succeeded. (Defined by ISumCommandExtension.)

FirstSubError

Gets the first SubError that is not NoError (Defined by ISumCommandExtension.)

OneFailed

Gets a value indicating, whether the overall Sumcommand failed (checking all subcommand results). (Defined by ISumCommandExtension.)

OneSucceeded

Gets a value indicating, whether the overall SumCommand succeeded (including all subcommands) (Defined by ISumCommandExtension.)

OverallError

Gets the Overall (combined error) from SumCommand AND SubCommands. (Defined by ISumCommandExtension.)

PollValues2.S.(IObservable.Unit.)

Overloaded.

Polls a series of symbols via a ISumRead2.S. command. The SumCommand will read all contained values with every trigger in one roundtrip. (Defined by ValueSymbolExtensions.)

PollValues2.S.(TimeSpan)

Overloaded.

Polls a series of symbols via a ISumRead2.S. command. The SumCommand will read all contained values with every trigger. (Defined by ValueSymbolExtensions.)

Remarks

Implementations of this interface return enriched SubResults on SumCommand Reads, that include the original sourceId in its result to backtrace.

Reference

TwinCAT.Ads.SumCommand Namespace

TwinCAT.Ads.SumCommand.ISumCommand