Connectivity Software User's Guide and Reference
ValueType(SparkplugMetric,SparkplugDataType,Boolean) Method



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugMetricExtension Class > ValueType Method : ValueType(SparkplugMetric,SparkplugDataType,Boolean) Method
The Sparkplug metric that will perform the operation.

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

The Sparkplug data type of the metric.
Specifies whether the metric data should be initialized to default values for the given dataType.
Makes the metric to use the specified Sparkplug data type, and specifying whether to initialize the data to the default.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function ValueType( _
   ByVal metric As SparkplugMetric, _
   ByVal dataType As SparkplugDataType, _
   ByVal initializeData As Boolean _
) As SparkplugMetric
'Usage
 
Dim metric As SparkplugMetric
Dim dataType As SparkplugDataType
Dim initializeData As Boolean
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.ValueType(metric, dataType, initializeData)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric ValueType( 
   SparkplugMetric metric,
   SparkplugDataType dataType,
   bool initializeData
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ ValueType( 
   SparkplugMetric^ metric,
   SparkplugDataType dataType,
   bool initializeData
) 

Parameters

metric
The Sparkplug metric that will perform the operation.

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

dataType
The Sparkplug data type of the metric.
initializeData
Specifies whether the metric data should be initialized to default values for the given dataType.

Return Value

Returns the metric, internally modified as defined by the method.

This method never returns 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

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

See Also