Package org.lfenergy.compas.sct.commons.dto

Interface ControlBlockNetworkSettings

All Known Implementing Classes:

ControlBlockNetworkSettingsCsvHelper

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ControlBlockNetworkSettings

This interface has a single method which provides network settings for a ControlBlock. These are used to create: - the Communication/SubNetwork/ConnectedAP/GSE element, which is the network configuration of a GSEControl block - the Communication/SubNetwork/ConnectedAP/SMV element, which is the network configuration of a SampledValueControl block It is a FunctionalInterface, so it can be implemented with a lambda expression.

See Also:

• ControlBlockNetworkSettingsCsvHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ControlBlockNetworkSettings.NetworkRanges	Range of APPID and range of MAC-Address
static final record	ControlBlockNetworkSettings.RangesPerCbType	NetworkRanges for GSEControl and SampledValueControl
static final record	ControlBlockNetworkSettings.Settings	Network settings for ControlBlock communication
static final record	ControlBlockNetworkSettings.SettingsOrError	Network settings for ControlBlock communication or Error message

Method Summary

Modifier and Type	Method	Description
ControlBlockNetworkSettings.SettingsOrError	getNetworkSettings(ControlBlockAdapter controlBlockAdapter)	This method provides a vlanId, vlanPriority, minTime, maxTime for this ControlBlock.

Method Details

getNetworkSettings

ControlBlockNetworkSettings.SettingsOrError getNetworkSettings(ControlBlockAdapter controlBlockAdapter)

This method provides a vlanId, vlanPriority, minTime, maxTime for this ControlBlock. vlanPriority will be ignored when vlanId is null.

Parameters:

controlBlockAdapter - ControlBlock for which we want to configure the communication section

Returns:

network settings to use for configuring Communication section for this ControlBlock. An error message can be provided (i.e. errorMessage not null) or a null settings, in order to avoid configuring the ControlBlock.