SumSymbolRead Class

Inheritance Hierarchy

SystemObject
  SumCommandWrapperSumReadWrite
    SumSymbolCommandSumReadWrite
      SumSymbolReadBase
        TwinCAT.Ads.SumCommandSumSymbolRead

Namespace: TwinCAT.Ads.SumCommand
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

C#

public class SumSymbolRead : SumSymbolReadBase, 
    ISumRead, ISumCommand, ISumRead2<ISymbol>

The SumSymbolRead type exposes the following members.

Methods

	Name	Description
	createResults	Creates the SumCommand results (abstract) (Overrides SumSymbolReadBase.createResults(IListSumDataEntity, IListReadOnlyMemoryByte, AdsErrorCode))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Read2	Reads the Values.
	Read2Async	Read2 as an asynchronous operation.
	ReadAsResult	Reads the combined (Sum) Symbols and returns them as Result object.
	ReadAsync	Reads Symbol values as an asynchronous operation.
	ReadRaw	Reads the Result Values as Raw data
	ReadRawAsync	Reads the Result Values as Raw data
	ToString	Returns a string that represents the current object. (Inherited from Object)

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)
	PollValues	Polls a series of symbols via a ISumRead command. The SumCommand will read all contained values with every trigger. (Defined by ValueSymbolExtensions)
	PollValues	Polls a series of symbols via a ISumRead2S command. The SumCommand will read all contained values with every trigger in one roundtrip. (Defined by ValueSymbolExtensions)
	PollValues2ISymbol	Polls a series of symbols via a ISumRead2S command. The SumCommand will read all contained values with every trigger in one roundtrip. (Defined by ValueSymbolExtensions)
	PollValues2ISymbol	Polls a series of symbols via a ISumRead2S command. The SumCommand will read all contained values with every trigger. (Defined by ValueSymbolExtensions)

Remarks

The SumSymbolRead implements symbolic read access with automatic (dynamic) value marshalling. The advantage of the symbolic access is (in contrast to the handle access classes SumHandleReadAnyType,SumHandleWriteAnyType) that all type information is available when using this ADS Sum Command. The disadvantage is, that the Symbolic information must be loaded beforehand, see examples. The SumSymbolWrite defaults to an InstancPath/SymbolName read (ValueByName).

Usage of SumSymbolRead/SumSymbolWrite with AdsSession

/// <summary>
/// Defines the entry point of the application.
/// </summary>
/// <param name="args">The arguments.</param>
static async void Main(string[] args)
{
    Console.WriteLine("");
    Console.WriteLine("Press [Enter] for start:");
    Console.ReadLine();

    // Parse the command-line arguments
    AmsAddress address = ArgParser.Parse(args);

    CancellationTokenSource cancelSource = new CancellationTokenSource();
    CancellationToken cancel = cancelSource.Token;

    using (AdsSession session = new AdsSession(address))
    {
    // Connect to the device target.
    AdsConnection connection = (AdsConnection)session.Connect();

    // Load symbolic information
    var resultSymbols = await session.SymbolServer.GetSymbolsAsync(cancel);
    resultSymbols.ThrowOnError();

    ISymbolCollection<ISymbol> symbols = resultSymbols.Symbols;

    ISymbol bVar1 = symbols["GVL.bVar1"];
    ISymbol bVar2 = symbols["GVL.bVar2"];
    ISymbol projectName = symbols["TwinCAT_SystemInfoVarList._AppInfo.ProjectName"];

    SymbolCollection coll = new SymbolCollection() {bVar1, bVar2, projectName};

    // Sum Command Read
    SumSymbolRead readCommand = new SumSymbolRead(connection,coll, SumFallbackMode.All);
    var resultReadValues = await readCommand.ReadAsync(cancel);

    if (resultReadValues.Succeeded)
    {
        object[] values = resultReadValues.Values;

        for (int i = 0; i < coll.Count; i++)
        {
        Console.WriteLine("Symbol: {0} (Value: {1}, Type: {2})", coll[i].InstancePath, values[i].ToString(), values[i].GetType().Name);
        }
    }
    // Sum Command Write

    SumSymbolWrite writeCommand = new SumSymbolWrite(connection,coll, SumFallbackMode.All);
    object[] writeValues = new object[] {true, (short) 42, "MyNewProjectName"};

    var resultWrite = await writeCommand.WriteAsync(writeValues,cancel);
    }

    Console.WriteLine("");
    Console.WriteLine("Press [Enter] for leave:");
    Console.ReadLine();
}

Reference

TwinCAT.Ads.SumCommand Namespace ISumCommand SumAnyTypeRead SumSymbolWrite

Beckhoff Automation GmbH & Co. KG 2001-2026