AngleCnecResultArraySerializer.java

/*
 *  Copyright (c) 2022, 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.powsybl.openrao.data.raoresult.io.json.serializers;

import com.powsybl.openrao.commons.OpenRaoException;
import com.powsybl.openrao.commons.Unit;
import com.powsybl.openrao.data.crac.api.Crac;
import com.powsybl.openrao.data.crac.api.Instant;
import com.powsybl.openrao.data.crac.api.InstantKind;
import com.powsybl.openrao.data.crac.api.cnec.AngleCnec;
import com.powsybl.openrao.data.raoresult.api.RaoResult;
import com.fasterxml.jackson.core.JsonGenerator;
import com.powsybl.openrao.data.raoresult.io.json.RaoResultJsonConstants;

import java.io.IOException;
import java.util.Comparator;
import java.util.List;

import static com.powsybl.openrao.commons.MeasurementRounding.roundValueBasedOnMargin;

/**
 * @author Philippe Edwards {@literal <philippe.edwards at rte-france.com>}
 */
final class AngleCnecResultArraySerializer {

    private AngleCnecResultArraySerializer() {
    }

    static void serialize(RaoResult raoResult, Crac crac, JsonGenerator jsonGenerator) throws IOException {

        List<AngleCnec> sortedListOfAngleCnecs = crac.getAngleCnecs().stream()
            .sorted(Comparator.comparing(AngleCnec::getId))
            .toList();

        jsonGenerator.writeArrayFieldStart(RaoResultJsonConstants.ANGLECNEC_RESULTS);
        for (AngleCnec angleCnec : sortedListOfAngleCnecs) {
            serializeAngleCnecResult(angleCnec, raoResult, crac, jsonGenerator);
        }
        jsonGenerator.writeEndArray();
    }

    private static void serializeAngleCnecResult(AngleCnec angleCnec, RaoResult raoResult, Crac crac, JsonGenerator jsonGenerator) throws IOException {

        if (containsAnyResultForAngleCnec(angleCnec, raoResult, crac)) {
            jsonGenerator.writeStartObject();
            jsonGenerator.writeStringField(RaoResultJsonConstants.ANGLECNEC_ID, angleCnec.getId());

            serializeAngleCnecResultForOptimizationState(null, angleCnec, raoResult, jsonGenerator);
            serializeAngleCnecResultForOptimizationState(crac.getPreventiveInstant(), angleCnec, raoResult, jsonGenerator);

            if (!angleCnec.getState().isPreventive()) {
                serializeAngleCnecResultForOptimizationState(crac.getInstant(InstantKind.AUTO), angleCnec, raoResult, jsonGenerator);
                crac.getInstants(InstantKind.CURATIVE).stream().sorted(Comparator.comparingInt(Instant::getOrder)).forEach(
                    curativeInstant -> {
                        try {
                            serializeAngleCnecResultForOptimizationState(curativeInstant, angleCnec, raoResult, jsonGenerator);
                        } catch (IOException e) {
                            throw new OpenRaoException("An error occured when serializing Angle Cnec results", e);
                        }
                    }
                );
            }
            jsonGenerator.writeEndObject();
        }
    }

    private static void serializeAngleCnecResultForOptimizationState(Instant optInstant, AngleCnec angleCnec, RaoResult raoResult, JsonGenerator jsonGenerator) throws IOException {

        if (containsAnyResultForOptimizationState(raoResult, angleCnec, optInstant)) {
            jsonGenerator.writeObjectFieldStart(RaoResultJsonConstants.serializeInstantId(optInstant));
            serializeAngleCnecResultForOptimizationStateAndUnit(optInstant, Unit.DEGREE, angleCnec, raoResult, jsonGenerator);
            jsonGenerator.writeEndObject();
        }
    }

    private static void serializeAngleCnecResultForOptimizationStateAndUnit(Instant optInstant, Unit unit, AngleCnec angleCnec, RaoResult raoResult, JsonGenerator jsonGenerator) throws IOException {

        double angle = safeGetAngle(raoResult, angleCnec, optInstant, unit);
        double margin = safeGetMargin(raoResult, angleCnec, optInstant, unit);

        if (Double.isNaN(angle) && Double.isNaN(margin)) {
            return;
        }

        jsonGenerator.writeObjectFieldStart(RaoResultJsonConstants.serializeUnit(unit));
        if (!Double.isNaN(angle)) {
            jsonGenerator.writeNumberField(RaoResultJsonConstants.ANGLE, roundValueBasedOnMargin(angle, margin, 2));
        }
        if (!Double.isNaN(margin)) {
            jsonGenerator.writeNumberField(RaoResultJsonConstants.MARGIN, roundValueBasedOnMargin(margin, margin, 2));
        }
        jsonGenerator.writeEndObject();
    }

    private static boolean containsAnyResultForAngleCnec(AngleCnec angleCnec, RaoResult raoResult, Crac crac) {

        if (angleCnec.getState().isPreventive()) {
            return containsAnyResultForOptimizationState(raoResult, angleCnec, null) ||
                containsAnyResultForOptimizationState(raoResult, angleCnec, angleCnec.getState().getInstant());
        } else {
            return containsAnyResultForOptimizationState(raoResult, angleCnec, null) ||
                containsAnyResultForOptimizationState(raoResult, angleCnec, crac.getPreventiveInstant()) ||
                containsAnyResultForOptimizationState(raoResult, angleCnec, crac.getInstant(InstantKind.AUTO)) ||
                crac.getInstants(InstantKind.CURATIVE).stream().anyMatch(curativeInstant -> containsAnyResultForOptimizationState(raoResult, angleCnec, curativeInstant));
        }
    }

    private static boolean containsAnyResultForOptimizationState(RaoResult raoResult, AngleCnec angleCnec, Instant optInstant) {
        return !Double.isNaN(safeGetAngle(raoResult, angleCnec, optInstant, Unit.DEGREE)) ||
            !Double.isNaN(safeGetMargin(raoResult, angleCnec, optInstant, Unit.DEGREE));
    }

    private static double safeGetAngle(RaoResult raoResult, AngleCnec angleCnec, Instant optInstant, Unit unit) {
        // methods getAngle can return an exception if RAO is executed on one state only
        try {
            return raoResult.getAngle(optInstant, angleCnec, unit);
        } catch (OpenRaoException e) {
            return Double.NaN;
        }
    }

    private static double safeGetMargin(RaoResult raoResult, AngleCnec angleCnec, Instant optInstant, Unit unit) {
        // methods getMargin can return an exception if RAO is executed on one state only
        try {
            return raoResult.getMargin(optInstant, angleCnec, unit);
        } catch (OpenRaoException e) {
            return Double.NaN;
        }
    }
}