Skip to content

Commit

Permalink
feat(#259): add criteria iedSystemVersionInstance in ControlBlockNetw…
Browse files Browse the repository at this point in the history 
…orkSettingsCsvHelper

Signed-off-by: massifben <105049157+massifben@users.noreply.github.com>
  • Loading branch information
@massifben
massifben committed Mar 16, 2023
1 parent 62aeade commit d25cbe7
Show file tree
Hide file tree
Showing 7 changed files with 167 additions and 81 deletions.
15 changes: 12 additions & 3 deletions ...ommons/src/main/java/org/lfenergy/compas/sct/commons/dto/ControlBlockNetworkSettings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ public interface ControlBlockNetworkSettings {
* vlanPriority will be ignored when vlanId is null.
*
* @param controlBlockAdapter ControlBlock for which we want to configure the communication section
* @return network settings : All fields are optional (meaning fields can be null).
* When the return value itself is null, the communication section will not be configured for this ControlBlock.
* @return network settings to use to configure Communication section for this ControlBlock.
* An error message can be provided (i.e. errorMessage not null) or a null settings, in order not to configure the ControlBlock.
*/
Settings getNetworkSettings(ControlBlockAdapter controlBlockAdapter);
SettingsOrError getNetworkSettings(ControlBlockAdapter controlBlockAdapter);

/**
* Network settings for ControlBlock communication
Expand All @@ -40,6 +40,15 @@ public interface ControlBlockNetworkSettings {
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
*/
record SettingsOrError(Settings settings, String errorMessage) {
}

/**
* NetworkRanges for GSEControl and SampledValueControl
*
Expand Down
12 changes: 7 additions & 5 deletions sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ExtRefService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
import org.lfenergy.compas.scl2007b4.model.TCompasICDHeader;
import org.lfenergy.compas.scl2007b4.model.TIED;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.Settings;
import org.lfenergy.compas.sct.commons.dto.SclReport;
import org.lfenergy.compas.sct.commons.dto.SclReportItem;
import org.lfenergy.compas.sct.commons.exception.ScdException;
Expand All @@ -27,8 +26,7 @@
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.NetworkRanges;
import static org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.RangesPerCbType;
import static org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings.*;

@UtilityClass
public class ExtRefService {
Expand Down Expand Up @@ -202,8 +200,12 @@ private static List<SclReportItem> configureNetworkForControlBlocks(SCL scd, Con
}

private static Optional<SclReportItem> configureControlBlockNetwork(ControlBlockNetworkSettings controlBlockNetworkSettings, PrimitiveIterator.OfLong appIdIterator, Iterator<String> macAddressIterator, ControlBlockAdapter controlBlockAdapter) {
Settings settings = controlBlockNetworkSettings.getNetworkSettings(controlBlockAdapter);

SettingsOrError settingsOrError = controlBlockNetworkSettings.getNetworkSettings(controlBlockAdapter);
if (settingsOrError.errorMessage() != null){
return Optional.of(controlBlockAdapter.buildFatalReportItem(
"Cannot configure network 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"));
Expand Down
83 changes: 47 additions & 36 deletions .../main/java/org/lfenergy/compas/sct/commons/util/ControlBlockNetworkSettingsCsvHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,18 @@
package org.lfenergy.compas.sct.commons.util;

import com.opencsv.bean.CsvBindByPosition;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import org.apache.commons.lang3.StringUtils;
import org.lfenergy.compas.scl2007b4.model.TCompasICDHeader;
import org.lfenergy.compas.scl2007b4.model.TCompasIEDRedundancy;
import org.lfenergy.compas.scl2007b4.model.TCompasIEDType;
import org.lfenergy.compas.scl2007b4.model.TDurationInMilliSec;
import org.lfenergy.compas.scl2007b4.model.*;
import org.lfenergy.compas.sct.commons.dto.ControlBlockNetworkSettings;
import org.lfenergy.compas.sct.commons.scl.ied.ControlBlockAdapter;
import org.lfenergy.compas.sct.commons.scl.ied.IEDAdapter;

import java.io.Reader;
import java.math.BigInteger;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;

/**
Expand All @@ -38,7 +34,7 @@ public class ControlBlockNetworkSettingsCsvHelper implements ControlBlockNetwork
private static final int MAX_VLAN_PRIORITY = 7;
private static final String NONE = "none";

private final Map<Criteria, Settings> settings;
private final Map<Criteria, Settings> allSettings;

/**
* Constructor
Expand All @@ -48,7 +44,7 @@ public class ControlBlockNetworkSettingsCsvHelper implements ControlBlockNetwork
* @param csvSource a reader that provides the data as CSV. For example :
*/
public ControlBlockNetworkSettingsCsvHelper(Reader csvSource) {
settings = readCsvFile(csvSource);
allSettings = readCsvFile(csvSource);
}

private Map<Criteria, Settings> readCsvFile(Reader csvSource) {
Expand All @@ -61,48 +57,62 @@ private Map<Criteria, Settings> readCsvFile(Reader csvSource) {
}

@Override
public Settings getNetworkSettings(ControlBlockAdapter controlBlockAdapter) {
public SettingsOrError getNetworkSettings(ControlBlockAdapter controlBlockAdapter) {
ControlBlockEnum controlBlockEnum = controlBlockAdapter.getControlBlockEnum();
IEDAdapter iedAdapter = controlBlockAdapter.getParentIedAdapter();
String systemVersion = iedAdapter.getCompasSystemVersion()
.map(version -> version.getMainSystemVersion() + "." + version.getMinorSystemVersion())
.orElse(null);
String systemVersionWithoutV = removeVFromSystemVersion(systemVersion);
TCompasIEDType iedType = iedAdapter.getCompasICDHeader().map(TCompasICDHeader::getIEDType).orElse(null);
TCompasIEDRedundancy iedRedundancy = iedAdapter.getCompasICDHeader().map(TCompasICDHeader::getIEDredundancy).orElse(null);
Optional<TCompasSystemVersion> compasSystemVersion = iedAdapter.getCompasSystemVersion();
if (compasSystemVersion.isEmpty()) {
return new SettingsOrError(null, "No private COMPAS-SystemVersion found in this IED");
}
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");
}
TCompasIEDType iedType = compasICDHeader.get().getIEDType();
TCompasIEDRedundancy iedRedundancy = compasICDHeader.get().getIEDredundancy();
BigInteger iedSystemVersionInstance = compasICDHeader.get().getIEDSystemVersioninstance();
boolean isBayInternal = controlBlockAdapter.getName().endsWith("I");
return findSettings(new Criteria(controlBlockEnum, systemVersionWithoutV, iedType, iedRedundancy, isBayInternal));

Criteria criteria = new Criteria(controlBlockEnum, systemVersionWithoutV, iedType, iedRedundancy, iedSystemVersionInstance, isBayInternal);
Settings settings = findSettings(criteria);
return settings != null ?
new SettingsOrError(settings, null) :
new SettingsOrError(null, "No row found with these criteria " + criteria);
}

private Settings findSettings(Criteria criteria) {
Objects.requireNonNull(criteria);
if (criteria.systemVersionWithoutV() == null
|| criteria.iedType() == null
|| criteria.iedRedundancy() == null) {
|| criteria.iedRedundancy() == null
|| criteria.iedSystemVersionInstance == null) {
return null;
}
return settings.get(criteria);
return allSettings.get(criteria);
}

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

private static Criteria rowToCriteria(Row row) {
if (StringUtils.isBlank(row.cbType)
|| StringUtils.isBlank(row.xy)
|| StringUtils.isBlank(row.zw)
|| StringUtils.isBlank(row.iedType)
|| StringUtils.isBlank(row.iedRedundancy)
|| StringUtils.isBlank(row.iedSystemVersionInstance)
|| StringUtils.isBlank(row.bindingType)
) {
throw new IllegalArgumentException("At least one criteria (cbType, xy, zw, iedType, bindingType) is blank");
throw new IllegalArgumentException("At least one criteria is null in row " + row);
}
ControlBlockEnum controlBlockEnum = switch (row.cbType) {
case "GOOSE" -> ControlBlockEnum.GSE;
Expand All @@ -114,6 +124,7 @@ private static Criteria rowToCriteria(Row row) {
row.xy + "." + row.zw,
TCompasIEDType.fromValue(row.iedType),
TCompasIEDRedundancy.fromValue(row.iedRedundancy),
new BigInteger(row.iedSystemVersionInstance),
row.bindingType.equals("BAY_INTERNAL")
);
}
Expand Down Expand Up @@ -160,13 +171,11 @@ private record Criteria(
String systemVersionWithoutV,
TCompasIEDType iedType,
TCompasIEDRedundancy iedRedundancy,
BigInteger iedSystemVersionInstance,
boolean isBayInternal) {
}

@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode
@ToString
public static class Row {
@CsvBindByPosition(position = 0)
private String cbType;
Expand All @@ -179,14 +188,16 @@ public static class Row {
@CsvBindByPosition(position = 4)
private String iedRedundancy;
@CsvBindByPosition(position = 5)
private String bindingType;
private String iedSystemVersionInstance;
@CsvBindByPosition(position = 6)
private String vlanId;
private String bindingType;
@CsvBindByPosition(position = 7)
private String vlanPriority;
private String vlanId;
@CsvBindByPosition(position = 8)
private String minTime;
private String vlanPriority;
@CsvBindByPosition(position = 9)
private String minTime;
@CsvBindByPosition(position = 10)
private String maxTime;
}

Expand Down
Loading

0 comments on commit d25cbe7

Please sign in to comment.