Connectivity Software User's Guide and Reference
Metadata Property (EasySparkplugMetricNotificationEventArgs)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.OperationModel Namespace > EasySparkplugMetricNotificationEventArgs Class : Metadata Property
The metadata associated with the Sparkplug metric, if available.
Syntax
'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Public Property Metadata As SparkplugMetadata
'Usage
 
Dim instance As EasySparkplugMetricNotificationEventArgs
Dim value As SparkplugMetadata
 
instance.Metadata = value
 
value = instance.Metadata
[JetBrains.Annotations.CanBeNull()]
public SparkplugMetadata Metadata {get; set;}
[JetBrains.Annotations.CanBeNull()]
public:
property SparkplugMetadata^ Metadata {
   SparkplugMetadata^ get();
   void set (    SparkplugMetadata^ value);
}

Property Value

The value of this property can be null (Nothing in Visual Basic).

The default value of this property is null.

Remarks

In Sparkplug, metadata is normally provided in the Birth messages only. The component, however, replicates the metadata from the Birth message into the subsequent Data notifications for the same metric, so that your code does not have to store the Birth notifications and correlate them with the Data notifications.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Requirements

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

See Also