Connectivity Software User's Guide and Reference
SparkplugPayload Constructor(String,SparkplugMetricData)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugPayload Class > SparkplugPayload Constructor : SparkplugPayload Constructor(String,SparkplugMetricData)
The Sparkplug metric name.

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

The Sparkplug metric data.

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

Initializes a new instance of the class, specifying a Sparkplug metric name and data.
Syntax
'Declaration
 
Public Function New( _
   ByVal metricName As String, _
   ByVal metricData As SparkplugMetricData _
)
'Usage
 
Dim metricName As String
Dim metricData As SparkplugMetricData
 
Dim instance As New SparkplugPayload(metricName, metricData)
public SparkplugPayload( 
   string metricName,
   SparkplugMetricData metricData
)
public:
SparkplugPayload( 
   String^ metricName,
   SparkplugMetricData^ metricData
)

Parameters

metricName
The Sparkplug metric name.

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

metricData
The Sparkplug metric data.

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

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

The payload will contain a single payload element with the specified metric, and no metadata.

 

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