Files
UA-.NETStandard/Libraries/Opc.Ua.Client.ComplexTypes/DataTypeException.cs
T
Martin Regen 1fec89b073 Complex types improvements (#1915)
Improvements for complex types.

- Support to encode/decode complex type structures with multidimensional arrays.
- Perf improvements for type loader using new NodeCache fetch multiple interfaces.
- DataTypeDictionary validation when dependencies are used.
- interface for complex type resolver, to build custom types in code.
- improvements of console client to demonstrate browse/read of custom values

+++ Breaking changes +++

IDecoder interface change of the `ReadArray` method

- Return type is now `Array` for all types of arrays. Previously the method returned an array for 1-dim and a `Matrix` type for multidimensional arrays. In addition the convention in generated code is to use `Collection` for all 1-dim arrays, and so was built the `BaseComplexType`. The new convention is to expose the native `Array` type from a complex type, in all cases, hence the return type of `ReadArray` was changed to reflect that for a consistent programming model.
- `ReadArray` has a new parameter `systemType` to efficiently read encodeable types. Previously the `Type` of an encodeable was determined by the encodingid and lookup in the type factory, even when the Type is already known by the caller.  The 'old' style is still supported.
- `ReadArray` supports to read encodeable type arrays which are directly encoded in structures. These arrays differ from standard encoding of arrays and they are handled when `BuiltInType.Null` is used as parameter.
2022-10-04 19:45:26 +02:00

139 lines
4.9 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
namespace Opc.Ua.Client.ComplexTypes
{
/// <summary>
/// Exception is thrown if the data type is not found.
/// </summary>
[Serializable]
public class DataTypeNotFoundException : Exception
{
/// <summary>
/// The nodeId of the data type.
/// </summary>
public ExpandedNodeIdCollection NodeIds { get; }
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeIds">The collection of nodeId of the data types not found.</param>
public DataTypeNotFoundException(ExpandedNodeIdCollection nodeIds)
{
this.NodeIds = nodeIds;
}
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeIds">The collection of nodeId of the data types not found.</param>
/// <param name="message">The exception message.</param>
public DataTypeNotFoundException(ExpandedNodeIdCollection nodeIds, string message)
: base(message)
{
this.NodeIds = nodeIds;
}
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeIds">The collection of nodeId of the data types not found.</param>
/// <param name="message">The exception message.</param>
/// <param name="inner">The inner exception.</param>
public DataTypeNotFoundException(ExpandedNodeIdCollection nodeIds, string message, Exception inner)
: base(message, inner)
{
this.NodeIds = nodeIds;
}
}
/// <summary>
/// DataType is not supported due to structure or value rank.
/// </summary>
[Serializable]
public class DataTypeNotSupportedException : Exception
{
/// <summary>
/// The nodeId of the data type.
/// </summary>
public ExpandedNodeId NodeId { get; }
/// <summary>
/// The name of the data type.
/// </summary>
public string TypeName { get; }
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeId">The nodeId of the data type.</param>
public DataTypeNotSupportedException(ExpandedNodeId nodeId)
{
this.NodeId = nodeId;
}
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="typeName">The name of the type.</param>
/// <param name="message">The exception message.</param>
public DataTypeNotSupportedException(string typeName, string message)
: base(message)
{
this.NodeId = Ua.NodeId.Null;
this.TypeName = typeName;
}
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeId">The nodeId of the data type.</param>
/// <param name="message">The exception message.</param>
public DataTypeNotSupportedException(ExpandedNodeId nodeId, string message)
: base(message)
{
this.NodeId = nodeId;
}
/// <summary>
/// Create the exception.
/// </summary>
/// <param name="nodeId">The nodeId of the data type.</param>
/// <param name="message">The exception message.</param>
/// <param name="inner">The inner exception.</param>
public DataTypeNotSupportedException(ExpandedNodeId nodeId, string message, Exception inner)
: base(message, inner)
{
this.NodeId = nodeId;
}
}
}//namespace