// This example obtains and prints out information about PubSub connections, writer groups, and dataset writers in the
// OPC UA PubSub configuration.
using System;
using OpcLabs.BaseLib.Collections.Specialized;
using OpcLabs.EasyOpc.UA.OperationModel;
using OpcLabs.EasyOpc.UA.PubSub.Configuration;
using OpcLabs.EasyOpc.UA.PubSub.InformationModel;
using OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions;
namespace UADocExamples.PubSub._IUAReadOnlyPubSubConfiguration
{
partial class GetMethods
{
public static void PubSubComponents()
{
// Instantiate the publish-subscribe client object.
var publishSubscribeClient = new EasyUAPublishSubscribeClient();
try
{
Console.WriteLine("Loading the configuration...");
// Load the PubSub configuration from a file. The file itself is at the root of the project, and we have
// specified that it has to be copied to the project's output directory.
IUAReadOnlyPubSubConfiguration pubSubConfiguration =
publishSubscribeClient.LoadReadOnlyConfiguration("UADemoPublisher-Default.uabinary");
// Alternatively, using the statement below, you can access a live configuration residing in an OPC UA Server
// with appropriate information model.
//IUAReadOnlyPubSubConfiguration pubSubConfiguration =
// publishSubscribeClient.AccessReadOnlyConfiguration("opc.tcp://localhost:48010");
// Get the names of PubSub connections in the configuration, regardless of the folder they reside in.
StringCollection pubSubConnectionNames = pubSubConfiguration.ListConnectionNames();
foreach (string pubSubConnectionName in pubSubConnectionNames)
{
Console.WriteLine($"PubSub connection: {pubSubConnectionName}");
// You can use the statement below to obtain parameters of the PubSub connection.
//UAPubSubConnectionElement connectionElement =
// pubSubConfiguration.GetConnectionElement(pubSubConnectionName);
// Get names of the writer groups on this PubSub connection.
StringCollection writerGroupNames = pubSubConfiguration.ListWriterGroupNames(pubSubConnectionName);
foreach (string writerGroupName in writerGroupNames)
{
Console.WriteLine($" Writer group: {writerGroupName}");
// You can use the statement below to obtain parameters of the writer group.
//UAWriterGroupElement writerGroupElement =
// pubSubConfiguration.GetWriterGroupElement(pubSubConnectionName, writerGroupName);
// Get names of the dataset writers on this writer group.
StringCollection dataSetWriterNames =
pubSubConfiguration.ListDataSetWriterNames(pubSubConnectionName, writerGroupName);
foreach (string dataSetWriterName in dataSetWriterNames)
{
Console.WriteLine($" Dataset writer: {dataSetWriterName}");
// You can use the statement below to obtain parameters of the dataset writer.
//UADataSetWriterElement dataSetWriterElement = pubSubConfiguration.GetDataSetWriterElement(
// pubSubConnectionName, writerGroupName, dataSetWriterName);
}
}
}
}
catch (UAException uaException)
{
Console.WriteLine($"*** Failure: {uaException.InnerException.Message}");
}
Console.WriteLine("Finished.");
}
// Example output:
//
//Loading the configuration...
//PubSub connection: FixedLayoutConnection
// Writer group: FixedLayoutGroup
// Dataset writer: SimpleWriter
// Dataset writer: AllTypesWriter
// Dataset writer: MassTestWriter
//PubSub connection: DynamicLayoutConnection
// Writer group: DynamicLayoutGroup
// Dataset writer: SimpleWriter
// Dataset writer: MassTestWriter
// Dataset writer: AllTypes-DynamicWriter
// Dataset writer: EventSimpleWriter
//PubSub connection: FlexibleLayoutConnection
// Writer group: FlexibleLayoutGroup
// Dataset writer: SimpleWriter
// Dataset writer: MassTestWriter
// Dataset writer: AllTypes-DynamicWriter
//Finished.
}
}
# This example obtains and prints out information about PubSub connections, writer groups, and dataset writers in the
# OPC UA PubSub configuration.
# The QuickOPC package is needed. Install it using "pip install opclabs_quickopc".
import opclabs_quickopc
# Import .NET namespaces.
from OpcLabs.BaseLib import *
#from OpcLabs.EasyOpc.UA import *
#from OpcLabs.EasyOpc.UA.PubSub.Configuration.Extensions import *
from OpcLabs.EasyOpc.UA.OperationModel import *
from OpcLabs.EasyOpc.UA.PubSub.InformationModel import *
from OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions import *
from OpcLabs.EasyOpc.UA.PubSub.OperationModel import *
# Instantiate the publish-subscribe client object.
publishSubscribeClient = EasyUAPublishSubscribeClient()
try:
print('Loading the configuration...')
# Load the PubSub configuration from a file. The file itself is in this script's directory.
pubSubConfiguration = IEasyUAPublishSubscribeClientExtension.LoadReadOnlyConfiguration(publishSubscribeClient,
'UADemoPublisher-Default.uabinary')
# Alternatively, using the statement below, you can access a live configuration residing in an OPC UA
# Server with appropriate information model.
#pubSubConfiguration = publishSubscribeClient.AccessReadOnlyConfiguration(
# UAEndpointDescriptor('opc.tcp://localhost:48010'))
# Get the names of PubSub connections in the configuration, regardless of the folder they reside in.
pubSubConnectionNames = pubSubConfiguration.ListConnectionNames()
for pubSubConnectionName in pubSubConnectionNames:
print('PubSub connection: ', pubSubConnectionName, sep='')
# You can use the statement below to obtain parameters of the PubSub connection.
#connectionElement = IUAReadOnlyPubSubConfigurationExtension.GetConnectionElement(pubSubConfiguration,
# pubSubConnectionName)
# Get names of the writer groups on this PubSub connection.
writerGroupNames = pubSubConfiguration.ListWriterGroupNames(pubSubConnectionName)
for writerGroupName in writerGroupNames:
print(' Writer group: ', writerGroupName, sep='')
# You can use the statement below to obtain parameters of the writer group.
#writerGroupElement = IUAReadOnlyPubSubConfigurationExtension.GetWriterGroupElement(pubSubConfiguration,
# pubSubConnectionName, writerGroupName)
# Get names of the dataset writers on this writer group.
dataSetWriterNames = pubSubConfiguration.ListDataSetWriterNames(pubSubConnectionName, writerGroupName)
for dataSetWriterName in dataSetWriterNames:
print(' Dataset writer: ', dataSetWriterName, sep='')
# You can use the statement below to obtain parameters of the dataset writer.
#dataSetWriterElement = IUAReadOnlyPubSubConfigurationExtension.GetDataSetWriterElement(pubSubConfiguration,
# pubSubConnectionName, writerGroupName, dataSetWriterName)
except UAException as uaException:
print('*** Failure: ' + uaException.GetBaseException().Message)
exit()
print('Finished.')
' This example obtains and prints out information about PubSub connections, writer groups, and dataset writers in the
' OPC UA PubSub configuration.
Imports OpcLabs.EasyOpc.UA.OperationModel
Imports OpcLabs.EasyOpc.UA.PubSub.Configuration
'Imports OpcLabs.EasyOpc.UA.PubSub.Configuration.Extensions
Imports OpcLabs.EasyOpc.UA.PubSub.InformationModel
Imports OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions
Namespace PubSub._IUAReadOnlyPubSubConfiguration
Partial Friend Class GetMethods
Public Shared Sub PubSubComponents()
' Instantiate the publish-subscribe client object.
Dim publishSubscribeClient = New EasyUAPublishSubscribeClient()
Try
Console.WriteLine("Loading the configuration...")
' Load the PubSub configuration from a file. The file itself is at the root of the project, and we have
' specified that it has to be copied to the project's output directory.
Dim pubSubConfiguration As IUAReadOnlyPubSubConfiguration =
publishSubscribeClient.LoadReadOnlyConfiguration("UADemoPublisher-Default.uabinary")
' Alternatively, using the statement below, you can access a live configuration residing in an OPC UA
' Server with appropriate information model.
'Dim pubSubConfiguration As IUAReadOnlyPubSubConfiguration =
' publishSubscribeClient.AccessReadOnlyConfiguration("opc.tcp://localhost:48010")
' Get the names of PubSub connections in the configuration, regardless of the folder they reside in.
Dim pubSubConnectionNames = pubSubConfiguration.ListConnectionNames()
For Each pubSubConnectionName As String In pubSubConnectionNames
Console.WriteLine($"PubSub connection: {pubSubConnectionName}")
' You can use the statement below to obtain parameters of the PubSub connection.
'Dim connectionElement As UAPubSubConnectionElement =
' pubSubConfiguration.GetConnectionElement(pubSubConnectionName)
' Get names of the writer groups on this PubSub connection.
Dim writerGroupNames = pubSubConfiguration.ListWriterGroupNames(pubSubConnectionName)
For Each writerGroupName As String In writerGroupNames
Console.WriteLine($" Writer group: {writerGroupName}")
' You can use the statement below to obtain parameters of the writer group.
'Dim writerGroupElement As UAWriterGroupElement =
' pubSubConfiguration.GetWriterGroupElement(pubSubConnectionName, writerGroupName)
' Get names of the dataset writers on this writer group.
Dim dataSetWriterNames =
pubSubConfiguration.ListDataSetWriterNames(pubSubConnectionName, writerGroupName)
For Each dataSetWriterName As String In dataSetWriterNames
Console.WriteLine($" Dataset writer: {dataSetWriterName}")
' You can use the statement below to obtain parameters of the dataset writer.
'Dim dataSetWriterElement As UADataSetWriterElement = pubSubConfiguration.GetDataSetWriterElement(
' pubSubConnectionName, writerGroupName, dataSetWriterName)
Next dataSetWriterName
Next writerGroupName
Next pubSubConnectionName
Catch uaException As UAException
Console.WriteLine("*** Failure: {0}", uaException.GetBaseException.Message)
End Try
Console.WriteLine("Finished...")
End Sub
End Class
' Example output
'
'Loading the configuration...
'PubSub connection FixedLayoutConnection
' Writer group: FixedLayoutGroup
' Dataset writer: SimpleWriter
' Dataset writer: AllTypesWriter
' Dataset writer: MassTestWriter
'PubSub connection: DynamicLayoutConnection
' Writer group: DynamicLayoutGroup
' Dataset writer: SimpleWriter
' Dataset writer: MassTestWriter
' Dataset writer: AllTypes-DynamicWriter
' Dataset writer: EventSimpleWriter
'PubSub connection: FlexibleLayoutConnection
' Writer group: FlexibleLayoutGroup
' Dataset writer: SimpleWriter
' Dataset writer: MassTestWriter
' Dataset writer: AllTypes-DynamicWriter
'Finished.
End Namespace