Ampl export : extended exporter

ampl-converter/pom.xml

@@ -89,5 +89,9 @@
             <version>${project.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.powsybl</groupId>
+            <artifactId>powsybl-iidm-extensions</artifactId>
+        </dependency>
     </dependencies>
 </project>

ampl-converter/src/main/java/com/powsybl/ampl/converter/AmplConstants.java

@@ -9,14 +9,40 @@
 import java.util.Locale;
 
 /**
- *
  * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
  */
 public final class AmplConstants {
 
     private AmplConstants() {
     }
 
+    public static final String XNODE_COUNTRY_NAME = "XNODE";
+    public static final String FAULT = "fault";
+    public static final String DESCRIPTION = "description";
+    public static final String SUBSTATION = "substation";
+    public static final String TARGET_V = "targetV (pu)";
+    public static final String TARGET_Q = "targetQ (MVAr)";
+    public static final String CON_BUS = "con. bus";
+    public static final String MINP = "minP (MW)";
+    public static final String MAXP = "maxP (MW)";
+    public static final String V_REGUL = "v regul.";
+    public static final String V_REGUL_BUS = "v regul. bus";
+    public static final String ACTIVE_POWER = "P (MW)";
+    public static final String REACTIVE_POWER = "Q (MVAr)";
+    public static final String MIN_Q_MAX_P = "minQmaxP (MVAr)";
+    public static final String MIN_Q0 = "minQ0 (MVAr)";
+    public static final String MIN_Q_MIN_P = "minQminP (MVAr)";
+    public static final String MAX_Q_MAX_P = "maxQmaxP (MVAr)";
+    public static final String MAX_Q0 = "maxQ0 (MVAr)";
+    public static final String MAX_Q_MIN_P = "maxQminP (MVAr)";
+    public static final String NUM = "num";
+    public static final String BUS = "bus";
+    public static final String P0 = "p0 (MW)";
+    public static final String Q0 = "q0 (MW)";
+    public static final String ID = "id";
+    public static final String RATIO_TABLE = "_ratio_table";
+    public static final String PHASE_TABLE = "_phase_table";
+
     public static final float INVALID_FLOAT_VALUE = -99999f;
 
     public static final Locale LOCALE = Locale.US;

ampl-converter/src/main/java/com/powsybl/ampl/converter/AmplExportConfig.java

@@ -7,6 +7,9 @@
  */
 package com.powsybl.ampl.converter;
 
+import com.powsybl.ampl.converter.version.AmplExportVersion;
+import com.powsybl.ampl.converter.version.AmplExportVersionImpl;
+
 import java.util.Objects;
 
 /**
@@ -38,6 +41,8 @@ public String getLabel() {
 
     private ExportScope exportScope;
 
+    private AmplExportVersion version;
+
     private boolean exportXNodes;
 
     private ExportActionType actionType;
@@ -47,15 +52,24 @@ public String getLabel() {
     private boolean twtSplitShuntAdmittance;
 
     public AmplExportConfig(ExportScope exportScope, boolean exportXNodes, ExportActionType actionType) {
-        this(exportScope, exportXNodes, actionType, false, false);
+        this(exportScope, exportXNodes, actionType, false, false, AmplExportVersionImpl.V1_LEGACY);
     }
 
-    public AmplExportConfig(ExportScope exportScope, boolean exportXNodes, ExportActionType actionType, boolean exportRatioTapChangerVoltageTarget, boolean twtSplitShuntAdmittance) {
+    public AmplExportConfig(ExportScope exportScope, boolean exportXNodes, ExportActionType actionType,
+                            boolean exportRatioTapChangerVoltageTarget, boolean twtSplitShuntAdmittance) {
+        this(exportScope, exportXNodes, actionType, exportRatioTapChangerVoltageTarget, twtSplitShuntAdmittance,
+            AmplExportVersionImpl.V1_LEGACY);
+    }
+
+    public AmplExportConfig(ExportScope exportScope, boolean exportXNodes, ExportActionType actionType,
+                            boolean exportRatioTapChangerVoltageTarget, boolean twtSplitShuntAdmittance,
+                            AmplExportVersion version) {
         this.exportScope = Objects.requireNonNull(exportScope);
         this.exportXNodes = exportXNodes;
         this.actionType = Objects.requireNonNull(actionType);
         this.exportRatioTapChangerVoltageTarget = exportRatioTapChangerVoltageTarget;
         this.twtSplitShuntAdmittance = twtSplitShuntAdmittance;
+        this.version = Objects.requireNonNull(version);
     }
 
     public ExportScope getExportScope() {
@@ -103,4 +117,13 @@ public AmplExportConfig setTwtSplitShuntAdmittance(boolean twtSplitShuntAdmittan
         return this;
     }
 
+    public AmplExportVersion getVersion() {
+        return version;
+    }
+
+    public AmplExportConfig setVersion(AmplExportVersion version) {
+        this.version = Objects.requireNonNull(version);
+        return this;
+    }
+
 }

ampl-converter/src/main/java/com/powsybl/ampl/converter/AmplExporter.java

@@ -8,13 +8,15 @@
 package com.powsybl.ampl.converter;
 
 import com.google.auto.service.AutoService;
+import com.powsybl.ampl.converter.version.AmplExportVersion;
+import com.powsybl.ampl.converter.version.AmplExportVersionImpl;
 import com.powsybl.commons.config.PlatformConfig;
 import com.powsybl.commons.datasource.DataSource;
-import com.powsybl.iidm.network.Exporter;
-import com.powsybl.iidm.network.Network;
 import com.powsybl.commons.parameters.Parameter;
 import com.powsybl.commons.parameters.ParameterDefaultValueConfig;
 import com.powsybl.commons.parameters.ParameterType;
+import com.powsybl.iidm.network.Exporter;
+import com.powsybl.iidm.network.Network;
 
 import java.io.IOException;
 import java.io.UncheckedIOException;
@@ -36,22 +38,33 @@ public class AmplExporter implements Exporter {
     public static final String EXPORT_ACTION_TYPE = "iidm.export.ampl.action-type";
     public static final String EXPORT_RATIOTAPCHANGER_VT = "iidm.export.ampl.export-ratio-tap-changer-voltage-target";
     public static final String TWT_SPLIT_SHUNT_ADMITTANCE = "iidm.export.ampl.twt-split-shunt-admittance";
+    public static final String EXPORT_VERSION = "iidm.export.ampl.export-version";
 
     private static final Parameter EXPORT_SCOPE_PARAMETER = new Parameter(EXPORT_SCOPE, ParameterType.STRING, "Export scope",
             AmplExportConfig.ExportScope.ALL.name(),
-            Arrays.stream(AmplExportConfig.ExportScope.values()).map(Enum::name).collect(Collectors.toList()));
-    private static final Parameter EXPORT_XNODES_PARAMETER = new Parameter(EXPORT_XNODES, ParameterType.BOOLEAN, "Export Xnodes of tie-lines", Boolean.FALSE);
-    private static final Parameter EXPORT_ACTION_TYPE_PARAMETER = new Parameter(EXPORT_ACTION_TYPE, ParameterType.STRING, "Type of the remedial actions (preventive or curative)",
-            AmplExportConfig.ExportActionType.CURATIVE.name(),
-            Arrays.stream(AmplExportConfig.ExportActionType.values()).map(Enum::name).collect(Collectors.toList()));
-    private static final Parameter EXPORT_RATIOTAPCHANGER_VT_PARAMETER = new Parameter(EXPORT_RATIOTAPCHANGER_VT, ParameterType.BOOLEAN, "Export ratio tap changer voltage target", Boolean.FALSE)
-            .addAdditionalNames("iidm.export.ampl.exportRatioTapChangerVoltageTarget");
-    private static final Parameter TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER = new Parameter(TWT_SPLIT_SHUNT_ADMITTANCE, ParameterType.BOOLEAN, "Export twt split shunt admittance", Boolean.FALSE)
+        Arrays.stream(AmplExportConfig.ExportScope.values()).map(Enum::name).collect(Collectors.toList()));
+    private static final Parameter EXPORT_XNODES_PARAMETER = new Parameter(EXPORT_XNODES, ParameterType.BOOLEAN,
+        "Export Xnodes of tie-lines", Boolean.FALSE);
+    private static final Parameter EXPORT_ACTION_TYPE_PARAMETER = new Parameter(EXPORT_ACTION_TYPE,
+        ParameterType.STRING, "Type of the remedial actions (preventive or curative)",
+        AmplExportConfig.ExportActionType.CURATIVE.name(),
+        Arrays.stream(AmplExportConfig.ExportActionType.values()).map(Enum::name).collect(Collectors.toList()));
+    private static final Parameter EXPORT_RATIOTAPCHANGER_VT_PARAMETER = new Parameter(EXPORT_RATIOTAPCHANGER_VT,
+        ParameterType.BOOLEAN, "Export ratio tap changer voltage target", Boolean.FALSE)
+        .addAdditionalNames("iidm.export.ampl.exportRatioTapChangerVoltageTarget");
+    private static final Parameter TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER = new Parameter(TWT_SPLIT_SHUNT_ADMITTANCE,
+        ParameterType.BOOLEAN, "Export twt split shunt admittance", Boolean.FALSE)
         .addAdditionalNames("iidm.export.ampl.specific-compatibility")
         .addAdditionalNames("iidm.export.ampl.specificCompatibility");
 
-    private static final List<Parameter> STATIC_PARAMETERS = List.of(EXPORT_SCOPE_PARAMETER, EXPORT_XNODES_PARAMETER, EXPORT_ACTION_TYPE_PARAMETER,
-            EXPORT_RATIOTAPCHANGER_VT_PARAMETER, TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER);
+    private static final Parameter EXPORT_VERSION_PARAMETER = new Parameter(EXPORT_VERSION, ParameterType.STRING,
+        "The version of the export.",
+        AmplExportVersionImpl.V1_LEGACY.name(),
+        Arrays.stream(AmplExportVersionImpl.values()).map(Enum::name).collect(Collectors.toList()));
+
+    private static final List<Parameter> STATIC_PARAMETERS = List.of(EXPORT_SCOPE_PARAMETER, EXPORT_XNODES_PARAMETER,
+        EXPORT_ACTION_TYPE_PARAMETER,
+        EXPORT_RATIOTAPCHANGER_VT_PARAMETER, TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER, EXPORT_VERSION_PARAMETER);
 
     private final ParameterDefaultValueConfig defaultValueConfig;
 
@@ -82,9 +95,13 @@ public void export(Network network, Properties parameters, DataSource dataSource
             boolean exportXnodes = Parameter.readBoolean(getFormat(), parameters, EXPORT_XNODES_PARAMETER, defaultValueConfig);
             AmplExportConfig.ExportActionType actionType = AmplExportConfig.ExportActionType.valueOf(Parameter.readString(getFormat(), parameters, EXPORT_ACTION_TYPE_PARAMETER, defaultValueConfig));
             boolean exportRatioTapChangerVoltageTarget = Parameter.readBoolean(getFormat(), parameters, EXPORT_RATIOTAPCHANGER_VT_PARAMETER, defaultValueConfig);
-            boolean twtSplitShuntAdmittance = Parameter.readBoolean(getFormat(), parameters, TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER, defaultValueConfig);
+            boolean twtSplitShuntAdmittance = Parameter.readBoolean(getFormat(), parameters,
+                TWT_SPLIT_SHUNT_ADMITTANCE_PARAMETER, defaultValueConfig);
+            AmplExportVersion exportVersion = AmplExportVersionImpl.valueOf(
+                Parameter.readString(getFormat(), parameters, EXPORT_VERSION_PARAMETER, defaultValueConfig));
 
-            AmplExportConfig config = new AmplExportConfig(scope, exportXnodes, actionType, exportRatioTapChangerVoltageTarget, twtSplitShuntAdmittance);
+            AmplExportConfig config = new AmplExportConfig(scope, exportXnodes, actionType,
+                exportRatioTapChangerVoltageTarget, twtSplitShuntAdmittance, exportVersion);
 
             new AmplNetworkWriter(network, dataSource, config).write();
         } catch (IOException e) {