Files
UA-.NETStandard/Libraries/Opc.Ua.Di.Server/Builders/WellKnownFunctionalGroups.cs
Marc Schier 4756e7c245 DI (OPC 10000-100) with samples (Pump, SW Update), fluent API gap closures and model dependency implementation (#3808)
This PR implements the **OPC UA Device Integration (DI, OPC 10000-100)**
companion-spec library trio (`Opc.Ua.Di` / `Opc.Ua.Di.Server` /
`Opc.Ua.Di.Client`) plus a worked example
(`Applications/MinimalPumpServer`) demonstrating the OPC 40223 Pumps
companion specification end-to-end with full simulation. It also closes
11 fluent-API gaps in `Opc.Ua.Server.Fluent`, three source-generator
bugs, integrates the DI layer into the unified `services.AddOpcUa()`
Microsoft.Extensions DI hosting pattern, and adds 250+ new tests.

**Worked example — `Applications/MinimalPumpServer/`**
- AOT-compatible console host using `Host.CreateApplicationBuilder` +
`AddOpcUa()`.
- `PumpNodeManager` inherits from `DiNodeManager`; multi-namespace (DI +
Machinery + Pumps) via runtime NodeSet2 loading and
`ModelLoaderBuilder`.
- Demonstrates declarative second-pump creation via
`.ConfigureDevicesFor<PumpNodeManager>(...)` and software-package
seeding from the same configurator.
- Full simulation: pressure, temperatures, power, flow, efficiency,
level, cavitation/overheat fault injection, alarm setup, NAMUR-style
supervision.

**Documentation**
- `Docs/Opc.Ua.Di/` — README, DeviceBuilder, Hosting, LockService,
SoftwareUpdate, ClientHelpers (6 new developer guides).
- `Docs/Opc.Ua.Di/ComplianceMatrix.md` — every DI declaration mapped to
In-v1 / Generated / Deferred / Excluded.
- `Docs/CompanionSpecLibraries.md` — packaging guide for new
companion-spec libraries.
- `Docs/FluentApiGaps.md` — historical record of G1–G11.
- `Docs/SourceGeneratedNodeManagers.md` updated for richer node
managers.
- `Docs/plans/StateMachineBuilder.md` — deferred state-machine builder
design.
2026-06-04 05:57:57 +02:00

89 lines
3.5 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
namespace Opc.Ua.Di.Server.Builders
{
/// <summary>
/// Well-known DI <c>FunctionalGroupType</c> instance names defined by
/// OPC 10000-100 §5.6. These names appear as <c>BrowseName</c>s on
/// <c>DeviceType</c> (and subtypes) and aggregate references to the
/// device's parameters/measurements by topic.
/// </summary>
/// <remarks>
/// Use these constants with
/// <see cref="IDeviceBuilder{TDevice}.WithFunctionalGroup(QualifiedName, System.Action{IFunctionalGroupBuilder})"/>
/// to ensure spec-compliant browse names. The typed convenience
/// methods on <see cref="IDeviceBuilder{TDevice}"/> (e.g.
/// <see cref="IDeviceBuilder{TDevice}.WithConfigurationGroup"/>) use
/// these constants internally.
/// </remarks>
public static class WellKnownFunctionalGroups
{
/// <summary>
/// Spec-defined name for the Identification group.
/// </summary>
public const string Identification = "Identification";
/// <summary>
/// Spec-defined name for the Configuration group.
/// </summary>
public const string Configuration = "Configuration";
/// <summary>
/// Spec-defined name for the Maintenance group.
/// </summary>
public const string Maintenance = "Maintenance";
/// <summary>
/// Spec-defined name for the Diagnostics group.
/// </summary>
public const string Diagnostics = "Diagnostics";
/// <summary>
/// Spec-defined name for the Status group.
/// </summary>
public const string Status = "Status";
/// <summary>
/// Spec-defined name for the Operational group.
/// </summary>
public const string Operational = "Operational";
/// <summary>
/// Spec-defined name for the Statistics group.
/// </summary>
public const string Statistics = "Statistics";
/// <summary>
/// Spec-defined name for the OperationCounters group.
/// </summary>
public const string OperationCounters = "OperationCounters";
}
}