com.farao_community.farao.rao_api.json.RaoParametersSerializer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2018, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package com.farao_community.farao.rao_api.json;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.rao_api.parameters.RaoParameters;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
import com.powsybl.commons.json.JsonUtil;

import java.io.IOException;

/**
 * @author Baptiste Seguinot {@literal }
 */
public class RaoParametersSerializer extends StdSerializer {

    RaoParametersSerializer() {
        super(RaoParameters.class);
    }

    @Override
    public void serialize(RaoParameters parameters, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeStartObject();
        jsonGenerator.writeStringField("version", RaoParameters.VERSION);
        jsonGenerator.writeObjectField("objective-function", parameters.getObjectiveFunction());
        jsonGenerator.writeNumberField("max-number-of-iterations", parameters.getMaxIterations());
        jsonGenerator.writeNumberField("pst-penalty-cost", parameters.getPstPenaltyCost());
        jsonGenerator.writeNumberField("pst-sensitivity-threshold", parameters.getPstSensitivityThreshold());
        jsonGenerator.writeNumberField("hvdc-penalty-cost", parameters.getHvdcPenaltyCost());
        jsonGenerator.writeNumberField("hvdc-sensitivity-threshold", parameters.getHvdcSensitivityThreshold());
        jsonGenerator.writeNumberField("injection-ra-penalty-cost", parameters.getInjectionRaPenaltyCost());
        jsonGenerator.writeNumberField("injection-ra-sensitivity-threshold", parameters.getInjectionRaSensitivityThreshold());
        jsonGenerator.writeNumberField("sensitivity-fallback-over-cost", parameters.getFallbackOverCost());
        jsonGenerator.writeBooleanField("rao-with-loop-flow-limitation", parameters.isRaoWithLoopFlowLimitation());
        jsonGenerator.writeNumberField("loop-flow-acceptable-augmentation", parameters.getLoopFlowAcceptableAugmentation());
        jsonGenerator.writeObjectField("loop-flow-approximation", parameters.getLoopFlowApproximationLevel());
        jsonGenerator.writeNumberField("loop-flow-constraint-adjustment-coefficient", parameters.getLoopFlowConstraintAdjustmentCoefficient());
        jsonGenerator.writeNumberField("loop-flow-violation-cost", parameters.getLoopFlowViolationCost());
        jsonGenerator.writeFieldName("loop-flow-countries");
        jsonGenerator.writeStartArray();
        parameters.getLoopflowCountries().stream().map(Enum::toString).sorted().forEach(s -> {
            try {
                jsonGenerator.writeString(s);
            } catch (IOException e) {
                throw new FaraoException("error while serializing loopflow countries", e);
            }
        });
        jsonGenerator.writeEndArray();
        jsonGenerator.writeBooleanField("rao-with-mnec-limitation", parameters.isRaoWithMnecLimitation());
        jsonGenerator.writeNumberField("mnec-acceptable-margin-diminution", parameters.getMnecAcceptableMarginDiminution());
        jsonGenerator.writeNumberField("mnec-violation-cost", parameters.getMnecViolationCost());
        jsonGenerator.writeNumberField("mnec-constraint-adjustment-coefficient", parameters.getMnecConstraintAdjustmentCoefficient());
        jsonGenerator.writeArrayFieldStart("relative-margin-ptdf-boundaries");
        for (String countryPair : parameters.getRelativeMarginPtdfBoundariesAsString()) {
            jsonGenerator.writeString(countryPair);
        }
        jsonGenerator.writeEndArray();
        jsonGenerator.writeNumberField("ptdf-sum-lower-bound", parameters.getPtdfSumLowerBound());
        jsonGenerator.writeNumberField("perimeters-in-parallel", parameters.getPerimetersInParallel());
        jsonGenerator.writeObjectField("optimization-solver", parameters.getSolver());
        jsonGenerator.writeNumberField("relative-mip-gap", parameters.getRelativeMipGap());
        jsonGenerator.writeStringField("solver-specific-parameters", parameters.getSolverSpecificParameters());
        jsonGenerator.writeObjectField("pst-optimization-approximation", parameters.getPstOptimizationApproximation());
        jsonGenerator.writeBooleanField("forbid-cost-increase", parameters.getForbidCostIncrease());
        jsonGenerator.writeStringField("load-flow-provider", parameters.getLoadFlowProvider());
        jsonGenerator.writeStringField("sensitivity-provider", parameters.getSensitivityProvider());
        jsonGenerator.writeFieldName("sensitivity-parameters");
        serializerProvider.defaultSerializeValue(parameters.getDefaultSensitivityAnalysisParameters(), jsonGenerator);
        if (parameters.getFallbackSensitivityAnalysisParameters() != null) {
            jsonGenerator.writeFieldName("fallback-sensitivity-parameters");
            serializerProvider.defaultSerializeValue(parameters.getFallbackSensitivityAnalysisParameters(), jsonGenerator);
        }
        JsonUtil.writeExtensions(parameters, jsonGenerator, serializerProvider, JsonRaoParameters.getExtensionSerializers());
        jsonGenerator.writeEndObject();
    }
}