CommonMapper Class

A mapper for OPC "Classic" specifications. Provides a functionality to map an object to entities in OPC "Classic" domain.

Object Model

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ComVisibleAttribute(False)>
<CLSCompliantAttribute(True)>
<TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
<DesignerCategoryAttribute("Component")>
Public MustInherit Class CommonMapper 
   Inherits OpcLabs.BaseLib.LiveMapping.AbstractMapper
   Implements OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

'Usage
 
Dim instance As CommonMapper

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[DesignerCategory("Component")]
public abstract class CommonMapper : OpcLabs.BaseLib.LiveMapping.AbstractMapper, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[DesignerCategory("Component")]
public ref class CommonMapper abstract : public OpcLabs.BaseLib.LiveMapping.AbstractMapper, OpcLabs.BaseLib.Licensing.ILicensingContextHolder, OpcLabs.BaseLib.Widgets.ComTypes._Widget, OpcLabs.BaseLib.Widgets.IWidget, System.ComponentModel.IComponent, System.ICloneable, System.IDisposable, System.IServiceProvider, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

Remarks

The mapper object is at the center of the live mapping mode. You will typically use it for two main purposes:

Establish the correspondences between the source OPC data, and you target .NET objects: see Mapping Your Objects.
Perform various operations using the mappings established earlier: Invoking the Operations.

For mapping of OPC Data Access (OPC-DA) sources, the actual mapper class is DAClientMapper. You can create an instance of DAClientMapper simply by instantiating it with one of its constructor overloads. You can also use a static DAClientMapper.SharedInstance object and avoid the need of instantiation.

For mapping of OPC Unified Architecture (OPC-UA) sources, the actual mapper class is UAClientMapper. You can create an instance of UAClientMapper simply by instantiating it with one of its constructor overloads. You can also use a static UAClientMapper.SharedInstance object and avoid the need of instantiation.

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         OpcLabs.BaseLib.Widgets.Widget
            OpcLabs.BaseLib.LiveMapping.AbstractMapper
               OpcLabs.EasyOpc.LiveMapping.CommonMapper
                  OpcLabs.EasyOpc.DataAccess.LiveMapping.DAMapper

Requirements

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

Reference

CommonMapper Members
OpcLabs.EasyOpc.LiveMapping Namespace