Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history 
Signed-off-by: massifben <105049157+massifben@users.noreply.github.com>
  • Loading branch information
@massifben
massifben committed Dec 4, 2023
1 parent bdf537c commit 5c839d3
Show file tree
Hide file tree
Showing 9 changed files with 349 additions and 523 deletions.
194 changes: 173 additions & 21 deletions sct-commons/src/main/java/org/lfenergy/compas/sct/commons/ControlBlockService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,33 @@

import org.apache.commons.lang3.StringUtils;
import org.lfenergy.compas.scl2007b4.model.SCL;
import org.lfenergy.compas.scl2007b4.model.TCompasICDHeader;
import org.lfenergy.compas.scl2007b4.model.TCompasSystemVersion;
import org.lfenergy.compas.scl2007b4.model.TDurationInMilliSec;
import org.lfenergy.compas.sct.commons.api.ControlBlockEditor;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.NetworkRanges;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.RangesPerCbType;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.Settings;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.SettingsOrError;
import org.lfenergy.compas.sct.commons.dto.FcdaForDataSetsCreation;
import org.lfenergy.compas.sct.commons.dto.SclReportItem;
import org.lfenergy.compas.sct.commons.exception.ScdException;
import org.lfenergy.compas.sct.commons.model.cbcom.*;
import org.lfenergy.compas.sct.commons.scl.SclRootAdapter;
import org.lfenergy.compas.sct.commons.scl.ied.ControlBlockAdapter;
import org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter;
import org.lfenergy.compas.sct.commons.scl.ldevice.LDeviceAdapter;
import org.lfenergy.compas.sct.commons.scl.ln.LNAdapter;
import org.lfenergy.compas.sct.commons.util.ControlBlockEnum;
import org.lfenergy.compas.sct.commons.util.SclConstructorHelper;
import org.lfenergy.compas.sct.commons.util.Utils;

import java.math.BigInteger;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class ControlBlockService implements ControlBlockEditor {

private static final int MAX_VLAN_ID = 0x0FFF;
private static final int MAX_VLAN_PRIORITY = 7;
private static final String NONE = "none";

@Override
public List<SclReportItem> analyzeDataGroups(SCL scd) {
Expand Down Expand Up @@ -84,11 +89,10 @@ private List<SclReportItem> createDataSetAndControlBlocks(Stream<LDeviceAdapter>
}

@Override
public List<SclReportItem> configureNetworkForAllControlBlocks(SCL scd, ControlBlockNetworkSettings controlBlockNetworkSettings,
RangesPerCbType rangesPerCbType) {
public List<SclReportItem> configureNetworkForAllControlBlocks(SCL scd, CBCom cbCom) {
List<SclReportItem> sclReportItems = new ArrayList<>();
sclReportItems.addAll(configureNetworkForControlBlocks(scd, controlBlockNetworkSettings, rangesPerCbType.gse(), ControlBlockEnum.GSE));
sclReportItems.addAll(configureNetworkForControlBlocks(scd, controlBlockNetworkSettings, rangesPerCbType.sampledValue(), ControlBlockEnum.SAMPLED_VALUE));
sclReportItems.addAll(configureNetworkForControlBlocks(scd, cbCom, TCBType.GOOSE));
sclReportItems.addAll(configureNetworkForControlBlocks(scd, cbCom, TCBType.SV));
return sclReportItems;
}

Expand All @@ -110,11 +114,35 @@ public void removeAllControlBlocksAndDatasetsAndExtRefSrcBindings(final SCL scl)
.forEach(LNAdapter::removeAllControlBlocksAndDatasets);
}

private List<SclReportItem> configureNetworkForControlBlocks(SCL scd, CBCom cbCom, TCBType tcbType) {
TRange appIdRange = Optional.ofNullable(cbCom.getAppIdRanges()).map(AppIdRanges::getAppIdRange).stream()
.flatMap(Collection::stream)
.filter(tRange -> tcbType.equals(tRange.getCBType()))
.findFirst()
.orElseThrow(() -> new ScdException("Control Block Communication setting files does not contain AppIdRange for cbType " + tcbType.value()));

private List<SclReportItem> configureNetworkForControlBlocks(SCL scd, ControlBlockNetworkSettings controlBlockNetworkSettings,
NetworkRanges networkRanges, ControlBlockEnum controlBlockEnum) {
PrimitiveIterator.OfLong appIdIterator = Utils.sequence(networkRanges.appIdStart(), networkRanges.appIdEnd());
Iterator<String> macAddressIterator = Utils.macAddressSequence(networkRanges.macAddressStart(), networkRanges.macAddressEnd());
TRange macRange = Optional.ofNullable(cbCom.getMacRanges()).map(MacRanges::getMacRange).stream()
.flatMap(Collection::stream)
.filter(tRange -> tcbType.equals(tRange.getCBType()))
.findFirst()
.orElseThrow(() -> new ScdException("Control Block Communication setting files does not contain MacRange for cbType " + tcbType.value()));

PrimitiveIterator.OfLong appIdIterator = Utils.sequence(Long.parseLong(appIdRange.getStart(), 16), Long.parseLong(appIdRange.getEnd(), 16));
Iterator<String> macAddressIterator = Utils.macAddressSequence(macRange.getStart(), macRange.getEnd());

ControlBlockEnum controlBlockEnum = switch (tcbType) {
case GOOSE -> ControlBlockEnum.GSE;
case SV -> ControlBlockEnum.SAMPLED_VALUE;
default -> throw new ScdException("Control Block type not supported by communication configuration process : " + tcbType.value());
};

Map<Criteria, Settings> comSettingsByCriteria = Optional.ofNullable(cbCom.getVlans()).map(Vlans::getVlan).stream()
.flatMap(Collection::stream)
.filter(vlan -> tcbType.equals(vlan.getCBType()))
.collect(Collectors.toMap(
this::vlanToCriteria,
this::vlanToSetting
));

SclRootAdapter sclRootAdapter = new SclRootAdapter(scd);
return sclRootAdapter.streamIEDAdapters()
Expand All @@ -123,37 +151,161 @@ private List<SclReportItem> configureNetworkForControlBlocks(SCL scd, ControlBlo
.filter(LDeviceAdapter::hasLN0)
.map(LDeviceAdapter::getLN0Adapter)
.flatMap(ln0Adapter -> ln0Adapter.streamControlBlocks(controlBlockEnum))
.map(controlBlockAdapter -> configureControlBlockNetwork(controlBlockNetworkSettings, appIdIterator, macAddressIterator, controlBlockAdapter)))
.map(controlBlockAdapter -> configureControlBlockNetwork(comSettingsByCriteria, appIdIterator, macAddressIterator, controlBlockAdapter)))
.flatMap(Optional::stream)
.toList();
}

private Optional<SclReportItem> configureControlBlockNetwork(ControlBlockNetworkSettings controlBlockNetworkSettings, PrimitiveIterator.OfLong appIdIterator, Iterator<String> macAddressIterator, ControlBlockAdapter controlBlockAdapter) {
SettingsOrError settingsOrError = controlBlockNetworkSettings.getNetworkSettings(controlBlockAdapter);
private Optional<SclReportItem> configureControlBlockNetwork(Map<Criteria, Settings> comSettingsByCriteria, PrimitiveIterator.OfLong appIdIterator, Iterator<String> macAddressIterator, ControlBlockAdapter controlBlockAdapter) {
SettingsOrError settingsOrError = getNetworkSettings(controlBlockAdapter, comSettingsByCriteria);
if (settingsOrError.errorMessage() != null) {
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network for this ControlBlock because: " + settingsOrError.errorMessage()));
"Cannot configure communication for this ControlBlock because: " + settingsOrError.errorMessage()));
}
Settings settings = settingsOrError.settings();
if (settings == null) {
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network for this ControlBlock because no settings was provided"));
"Cannot configure communication for this ControlBlock because no settings was provided"));
}
if (settings.vlanId() == null) {
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network for this ControlBlock because no Vlan Id was provided in the settings"));
"Cannot configure communication for this ControlBlock because no Vlan Id was provided in the settings"));
}
if (!appIdIterator.hasNext()) {
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network for this ControlBlock because range of appId is exhausted"));
"Cannot configure communication for this ControlBlock because range of appId is exhausted"));
}
if (!macAddressIterator.hasNext()) {
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network for this ControlBlock because range of MAC Address is exhausted"));
"Cannot configure communication for this ControlBlock because range of MAC Address is exhausted"));
}

return controlBlockAdapter.configureNetwork(appIdIterator.nextLong(), macAddressIterator.next(), settings.vlanId(), settings.vlanPriority(),
settings.minTime(), settings.maxTime());
}

public SettingsOrError getNetworkSettings(ControlBlockAdapter controlBlockAdapter, Map<Criteria, Settings> comSettingsByCriteria) {
IEDAdapter iedAdapter = controlBlockAdapter.getParentIedAdapter();
Optional<TCompasSystemVersion> compasSystemVersion = iedAdapter.getCompasSystemVersion();
if (compasSystemVersion.isEmpty()) {
return new SettingsOrError(null, "No private COMPAS-SystemVersion found in this IED");
}
if (StringUtils.isBlank(compasSystemVersion.get().getMainSystemVersion())
|| (StringUtils.isBlank(compasSystemVersion.get().getMinorSystemVersion()))) {
return new SettingsOrError(null, "No communication setting found for this Control Block");
}
String systemVersionWithoutV = removeVFromSystemVersion(compasSystemVersion.get());
Optional<TCompasICDHeader> compasICDHeader = iedAdapter.getCompasICDHeader();
if (compasICDHeader.isEmpty()) {
return new SettingsOrError(null, "No private COMPAS-ICDHeader found in this IED");
}
if (compasICDHeader.get().getIEDSystemVersioninstance() == null) {
return new SettingsOrError(null, "No IEDSystemVersioninstance in the COMPAS-ICDHeader of this IED");
}
TCBType cbType = switch (controlBlockAdapter.getControlBlockEnum()) {
case GSE -> TCBType.GOOSE;
case SAMPLED_VALUE -> TCBType.SV;
default -> throw new ScdException("Unsupported Control Block type " + controlBlockAdapter.getControlBlockEnum());
};
TBayIntOrExt bayIntOrExt = controlBlockAdapter.getName().endsWith("I") ? TBayIntOrExt.BAY_INTERNAL : TBayIntOrExt.BAY_EXTERNAL;

Criteria criteria = new Criteria(cbType,
systemVersionWithoutV,
TIEDType.fromValue(compasICDHeader.get().getIEDType().value()),
TIEDRedundancy.fromValue(compasICDHeader.get().getIEDredundancy().value()),
compasICDHeader.get().getIEDSystemVersioninstance(),
bayIntOrExt);
Settings settings = comSettingsByCriteria.get(criteria);
return new SettingsOrError(settings, settings != null ? null : "No controlBlock communication configuration found for this these criteria " + criteria);
}

private String removeVFromSystemVersion(TCompasSystemVersion compasSystemVersion) {
if (StringUtils.isBlank(compasSystemVersion.getMainSystemVersion())
|| (StringUtils.isBlank(compasSystemVersion.getMinorSystemVersion()))) {
return null;
}
String[] minorVersionParts = compasSystemVersion.getMinorSystemVersion().split("\\.");
return (minorVersionParts.length == 3) ?
compasSystemVersion.getMainSystemVersion() + "." + minorVersionParts[0] + "." + minorVersionParts[1]
: null;
}

private Criteria vlanToCriteria(TVlan vlan) {
if (Objects.isNull(vlan.getCBType())
|| StringUtils.isBlank(vlan.getXY())
|| StringUtils.isBlank(vlan.getZW())
|| Objects.isNull(vlan.getIEDType())
|| Objects.isNull(vlan.getIEDRedundancy())
|| StringUtils.isBlank(vlan.getIEDSystemVersionInstance())
|| Objects.isNull(vlan.getBayIntOrExt())
) {
throw new ScdException("At least one criteria is missing in vlan " + vlan);
}
return new Criteria(
vlan.getCBType(),
vlan.getXY() + "." + vlan.getZW(),
vlan.getIEDType(),
vlan.getIEDRedundancy(),
new BigInteger(vlan.getIEDSystemVersionInstance()),
vlan.getBayIntOrExt()
);
}

private Settings vlanToSetting(TVlan vlan) {
return new Settings(toVLanId(vlan.getVlanId()), toVlanPriority(vlan.getVlanPriority()), toDurationInMilliSec(vlan.getMinTime()), toDurationInMilliSec(vlan.getMaxTime()));
}

private Integer toVLanId(String strVlanId) {
if (StringUtils.isBlank(strVlanId) || NONE.equalsIgnoreCase(strVlanId)) {
return null;
}
int vlanId = Integer.parseInt(strVlanId);
if (vlanId < 0 || vlanId > MAX_VLAN_ID) {
throw new ScdException("VLAN ID must be between 0 and %d, but got : %d".formatted(MAX_VLAN_ID, vlanId));
}
return vlanId;
}

private static Byte toVlanPriority(String strVlanPriority) {
if (StringUtils.isBlank(strVlanPriority) || NONE.equalsIgnoreCase(strVlanPriority)) {
return null;
}
byte vlanPriority = Byte.parseByte(strVlanPriority);
if (vlanPriority < 0 || vlanPriority > MAX_VLAN_PRIORITY) {
throw new ScdException("VLAN PRIORITY must be between 0 and %d, but got : %d".formatted(MAX_VLAN_PRIORITY, vlanPriority));
}
return vlanPriority;
}

private TDurationInMilliSec toDurationInMilliSec(String duration) {
if (StringUtils.isBlank(duration) || NONE.equalsIgnoreCase(duration)) {
return null;
}
return SclConstructorHelper.newDurationInMilliSec(Long.parseLong(duration));
}

/**
* Network settings for ControlBlock communication
*
* @param vlanId id of the vlan
* @param vlanPriority priority for the vlan
* @param minTime minTime for GSE communication element
* @param maxTime maxTime for GSE communication element
*/
public record Settings(Integer vlanId, Byte vlanPriority, TDurationInMilliSec minTime, TDurationInMilliSec maxTime) {
}

/**
* Network settings for ControlBlock communication or Error message
*
* @param settings Network settings for ControlBlock communication. Can be null when errorMessage is provided
* @param errorMessage should be null if settings is provided
*/
public record SettingsOrError(Settings settings, String errorMessage) {
}

public record Criteria(TCBType cbType, String systemVersionWithoutV, TIEDType iedType, TIEDRedundancy iedRedundancy, BigInteger iedSystemVersionInstance, TBayIntOrExt bayIntOrExt) {
}


}
10 changes: 4 additions & 6 deletions sct-commons/src/main/java/org/lfenergy/compas/sct/commons/api/ControlBlockEditor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings;
import org.lfenergy.compas.sct.commons.dto.FcdaForDataSetsCreation;
import org.lfenergy.compas.sct.commons.dto.SclReportItem;
import org.lfenergy.compas.sct.commons.model.cbcom.CBCom;
import org.lfenergy.compas.sct.commons.util.Utils;

import java.util.List;
Expand Down Expand Up @@ -85,17 +86,14 @@ public interface ControlBlockEditor {
* - the Communication/SubNetwork/ConnectedAP/GSE element, for the GSEControl blocks
* - the Communication/SubNetwork/ConnectedAP/SMV element, for the SampledValueControl blocks
*
* @param scd input SCD object. The object will be modified with the new DataGSESet and SMV elements
* @param controlBlockNetworkSettings a method tha gives the network configuration information for a given ControlBlock
* @param rangesPerCbType provide NetworkRanges for GSEControl and SampledValueControl. NetworkRanges contains :
* start-end app APPID range (long value), start-end MAC-Addresses (Mac-Addresses values: Ex: "01-0C-CD-01-01-FF")
* @param scd input SCD object. The object will be modified with the new DataGSESet and SMV elements
* @param cbCom
* @return list of encountered errors
* @see Utils#macAddressToLong(String) for the expected MAC address format
* @see ControlBlockNetworkSettings
* @see ControlBlockNetworkSettings.RangesPerCbType
* @see ControlBlockNetworkSettings.NetworkRanges
*/
List<SclReportItem> configureNetworkForAllControlBlocks(SCL scd, ControlBlockNetworkSettings controlBlockNetworkSettings,
ControlBlockNetworkSettings.RangesPerCbType rangesPerCbType);
List<SclReportItem> configureNetworkForAllControlBlocks(SCL scd, CBCom cbCom);

}
Loading

0 comments on commit 5c839d3

Please sign in to comment.