UAClientDataMapping Class

A data mapping based on OPC Unified Architecture (OPC-UA) specification.

Object Model

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ComVisibleAttribute(False)>
<CLSCompliantAttribute(True)>
<TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
Public NotInheritable Class UAClientDataMapping 
   Inherits UAMapping

'Usage
 
Dim instance As UAClientDataMapping

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
public sealed class UAClientDataMapping : UAMapping

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
public ref class UAClientDataMapping sealed : public UAMapping

Remarks

The mapping is a relation between a mapping source and a mapping target. Besides specifying which mapping source and mapping target belong together, it also specifies how and when the data is being transferred between the two.

For example, a mapping for OPC Data Access items ( DAClientItemMapping) may specify that the data is only transferred (from the source to the target) when a “Read” operation is requested (see Mapping Operations) and that the data will be in form of the value-timestamp-quality triple, i.e. a DAVtq object (see Mapping Kinds). With OPC-UA and UAClientDataMapping, the “Read” operation exists as well, and an example form of transfer may be the UAAttributeData, which contains the attribute value, status code, and timestamps. Or, the transferred data may simple be the OPC value itself.

When you annotate your objects using attributes, and then map your objects using the mapper object, the necessary mappings are created for all members of your objects that are annotated in such way. You therefore do not normally need to create mappings individually.

For OPC Data Access, there are two types of mappings that you can use:

The DAClientItemMapping relates a DAClientItemSource to some mapping target. It refers to an OPC item, and you can read it or write it, or subscribe to it. These mappings are created with the use of the DAItem attribute (see further below).
The DAClientPropertyMapping relates a DAClientPropertySource to some mapping target. It refers to an OPC property, and you can get its value. These mappings are created with the use of the DAProperty attribute (see further below).

For OPC Unified Architecture, following type of mapping exists:

The UAClientDataMapping relates a UAClientDataMappingSource to some mapping target. It refers to an attribute of an OPC-UA node , and you can read it or write it, or subscribe to it. These mappings are created with the use of the UAData attribute (see further below).

Inheritance Hierarchy

System.Object
   OpcLabs.BaseLib.LiveMapping.AbstractMapping
      OpcLabs.EasyOpc.UA.LiveMapping.UAMapping
         OpcLabs.EasyOpc.UA.LiveMapping.UAClientDataMapping

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UAClientDataMapping Members
OpcLabs.EasyOpc.UA.LiveMapping Namespace

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.