Constant(SparkplugMetric,TypeCode,SparkplugData) Method

Makes a constant metric with given value type code, and Sparkplug data object (value, timestamp).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function Constant( _
   ByVal metric As SparkplugMetric, _
   ByVal valueTypeCode As TypeCode, _
   ByVal data As SparkplugData _
) As SparkplugMetric

'Usage
 
Dim metric As SparkplugMetric
Dim valueTypeCode As TypeCode
Dim data As SparkplugData
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.Constant(metric, valueTypeCode, data)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric Constant( 
   SparkplugMetric metric,
   TypeCode valueTypeCode,
   SparkplugData data
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ Constant( 
   SparkplugMetric^ metric,
   TypeCode valueTypeCode,
   SparkplugData^ data
)

Parameters

metric: The Sparkplug metric that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
valueTypeCode: The type of the Sparkplug metric, expressed as .NET type code (System.TypeCode).
data: The constant Sparkplug data that will be provided by the metric.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the , internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.
System.ComponentModel.InvalidEnumArgumentException	An invalid enumeration value was used. 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.

System.ArgumentNullException

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.

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

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.

System.ComponentModel.InvalidEnumArgumentException

An invalid enumeration value was used.

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 metric is made read-only, and its minimum sampling interval is set to System.Threading.Timeout.Infinite, effectively disabling the sampling.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

Reference

SparkplugMetricExtension Class
SparkplugMetricExtension Members
Overload List

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.