Connectivity Software User's Guide and Reference
ReadValueFunction(SparkplugMetric,Type,Func<Object>) Method
Example 



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugMetricExtension Class > ReadValueFunction Method : ReadValueFunction(SparkplugMetric,Type,Func<Object>) Method
The Sparkplug metric that will perform the operation.

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

The type of the Sparkplug metric, expressed as .NET System.Type.

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

The read value function, i.e. the function that performs the read operation and returns the value that will be published.

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

Specifies value type and read value function, for the pull data provision model.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function ReadValueFunction( _
   ByVal metric As SparkplugMetric, _
   ByVal valueType As Type, _
   ByVal readValueFunction As Func(Of Object) _
) As SparkplugMetric
'Usage
 
Dim metric As SparkplugMetric
Dim valueType As Type
Dim readValueFunction As Func(Of Object)
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.ReadValueFunction(metric, valueType, readValueFunction)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric ReadValueFunction( 
   SparkplugMetric metric,
   Type valueType,
   Func<object> readValueFunction
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ ReadValueFunction( 
   SparkplugMetric^ metric,
   Type^ valueType,
   Func<Object^>^ readValueFunction
) 

Parameters

metric
The Sparkplug metric that will perform the operation.

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

valueType
The type of the Sparkplug metric, expressed as .NET System.Type.

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

readValueFunction
The read value function, i.e. the function that performs the read operation and returns the value that will be published.

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

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.

Example
// This example shows how to create a metric of type UInt16 and implement reading its value using a function.
//
// You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
// program, to subscribe to the edge node data. 
//
// Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
// Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
// Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
// a commercial license in order to use Online Forums, and we reply to every post.

using OpcLabs.EasySparkplug;
using System;

namespace SparkplugDocExamples.EdgeNode._SparkplugMetric
{
    partial class ReadValueFunction
    {
        static public void UInt16()
        {
            // Note that the default port for the "mqtt" scheme is 1883.
            var hostDescriptor = new SparkplugHostDescriptor("mqtt://localhost");

            // Instantiate the edge node object and hook events.
            var edgeNode = new EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo");
            edgeNode.SystemConnectionStateChanged += (sender, eventArgs) =>
            {
                // Display the new connection state (such as when the connection to the broker succeeds or fails).
                Console.WriteLine($"{nameof(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}");
            };

            // Create a metric, defining its read values by a function.
            // We explicitly specify the Sparkplug data type of the metric to be UInt16. The read value function can then
            // return any type of object, and EasySparkplug will attempt to convert it to the specified Sparkplug data type.
            // This is helpful in languages like VB.NET that do not have full support for some types (such as unsigned
            // integers).
            var random = new Random();
            edgeNode.Add(new SparkplugMetric("ReadThisMetric").ReadValueFunction(
                typeof(UInt16), () => random.Next(65536)));

            // Start the edge node.
            Console.WriteLine("The edge node is starting...");
            edgeNode.Start();

            Console.WriteLine("The edge node is started.");
            Console.WriteLine();

            // Let the user decide when to stop.
            Console.WriteLine("Press Enter to stop the edge node...");
            Console.ReadLine();

            // Stop the edge node.
            Console.WriteLine("The edge node is stopping...");
            edgeNode.Stop();

            Console.WriteLine("The edge node is stopped.");
        }
    }
}
' This example shows how to create a metric of type UInt16 and implement reading its value using a function.
'
' You can use any Sparkplug application, including our SparkplugCmd utility and the SparkplugApplicationConsoleDemo
' program, to subscribe to the edge node data.
'
' Find all latest examples here: https://opclabs.doc-that.com/files/onlinedocs/OPCLabs-ConnectivityStudio/Latest/examples.html .
' Sparkplug examples in C# on GitHub: https://github.com/OPCLabs/Examples-ConnectivityStudio-CSharp .
' Missing some example? Ask us for it on our Online Forums, https://www.opclabs.com/forum/index ! You do not have to own
' a commercial license in order to use Online Forums, and we reply to every post.

Imports OpcLabs.EasySparkplug

Namespace Global.SparkplugDocExamples.EdgeNode._SparkplugMetric
    Partial Class ReadValueFunction
        Public Shared Sub UInt16()
            ' Note that the default port for the "mqtt" scheme is 1883.
            Dim hostDescriptor = New SparkplugHostDescriptor("mqtt://localhost")

            ' Instantiate the edge node object and hook events.
            Dim edgeNode = New EasySparkplugEdgeNode(hostDescriptor, "easyGroup", "easySparkplugDemo")
            AddHandler edgeNode.SystemConnectionStateChanged,
                Sub(sender, eventArgs)
                    ' Display the new connection state (such as when the connection to the broker succeeds or fails).
                    Console.WriteLine($"{NameOf(EasySparkplugEdgeNode.SystemConnectionStateChanged)}: {eventArgs}")
                End Sub

            ' Create a metric, defining its read values by a function.
            ' We explicitly specify the Sparkplug data type of the metric to be UInt16. The read value function can then
            ' return any type of object, and EasySparkplug will attempt to convert it to the specified Sparkplug data type.
            ' This is helpful in languages like VB.NET that do not have full support for some types (such as unsigned
            ' integers).
            Dim random = New Random()
            edgeNode.Add(New SparkplugMetric("ReadThisMetric").ReadValueFunction(
                GetType(UInt16), Function() random.Next(65536)))

            ' Start the edge node.
            Console.WriteLine("The edge node is starting...")
            edgeNode.Start()

            Console.WriteLine("The edge node is started.")
            Console.WriteLine()

            ' Let the user decide when to stop.
            Console.WriteLine("Press Enter to stop the edge node...")
            Console.ReadLine()

            ' Stop the edge node.
            Console.WriteLine("The edge node is stopping...")
            edgeNode.Stop()

            Console.WriteLine("The edge node is stopped.")
        End Sub
    End Class
End Namespace
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