Connectivity Software User's Guide and Reference
MetricDataDictionary Property



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugPayload Class : MetricDataDictionary Property
A read-only dictionary of Sparkplug metric data for metrics contained in the payload, keyed by metric name.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property MetricDataDictionary As IStringSparkplugMetricDataReadOnlyDictionary
'Usage
 
Dim instance As SparkplugPayload
Dim value As IStringSparkplugMetricDataReadOnlyDictionary
 
value = instance.MetricDataDictionary
[JetBrains.Annotations.NotNull()]
public IStringSparkplugMetricDataReadOnlyDictionary MetricDataDictionary {get;}
[JetBrains.Annotations.NotNull()]
public:
property IStringSparkplugMetricDataReadOnlyDictionary^ MetricDataDictionary {
   IStringSparkplugMetricDataReadOnlyDictionary^ get();
}

Property Value

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

The individual elements of the property value cannot be null (Nothing in Visual Basic).

Remarks

If a metric with the same name appears multiple times in the payload, only the last metric data for that metric is stored in this dictionary. Use PayloadElementCollection if you need access to all occurrences of the metric in the payload.

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