FlowCnecSerializer.java

/*
 * Copyright (c) 2020, 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.crac.io.json.serializers;

import com.powsybl.contingency.Contingency;
import com.powsybl.openrao.data.crac.io.json.ExtensionsHandler;
import com.powsybl.openrao.data.crac.io.json.JsonSerializationConstants;
import com.powsybl.openrao.data.crac.api.cnec.FlowCnec;
import com.powsybl.iidm.network.TwoSides;
import com.powsybl.openrao.data.crac.api.threshold.BranchThreshold;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.powsybl.commons.json.JsonUtil;

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

/**
 * @author Joris Mancini {@literal <joris.mancini at rte-france.com>}
 */
public class FlowCnecSerializer<I extends FlowCnec> extends AbstractJsonSerializer<I> {

    @Override
    public void serialize(I flowCnec, JsonGenerator gen, SerializerProvider serializerProvider) throws IOException {
        gen.writeStartObject();
        gen.writeStringField(JsonSerializationConstants.ID, flowCnec.getId());
        gen.writeStringField(JsonSerializationConstants.NAME, flowCnec.getName());
        gen.writeStringField(JsonSerializationConstants.NETWORK_ELEMENT_ID, flowCnec.getNetworkElement().getId());
        gen.writeStringField(JsonSerializationConstants.OPERATOR, flowCnec.getOperator());
        gen.writeStringField(JsonSerializationConstants.BORDER, flowCnec.getBorder());
        gen.writeStringField(JsonSerializationConstants.INSTANT, flowCnec.getState().getInstant().getId());
        Optional<Contingency> optContingency = flowCnec.getState().getContingency();
        if (optContingency.isPresent()) {
            gen.writeStringField(JsonSerializationConstants.CONTINGENCY_ID, optContingency.get().getId());
        }
        gen.writeObjectField(JsonSerializationConstants.OPTIMIZED, flowCnec.isOptimized());
        gen.writeObjectField(JsonSerializationConstants.MONITORED, flowCnec.isMonitored());
        gen.writeNumberField(JsonSerializationConstants.RELIABILITY_MARGIN, flowCnec.getReliabilityMargin());

        serializeIMax(flowCnec, gen);
        serializeNominalVoltage(flowCnec, gen);
        serializeThresholds(flowCnec, gen);

        JsonUtil.writeExtensions(flowCnec, gen, serializerProvider, ExtensionsHandler.getExtensionsSerializers());

        gen.writeEndObject();
    }

    private void serializeIMax(FlowCnec flowCnec, JsonGenerator gen) throws IOException {
        serializeDoubleValuesOnBothSide(gen, flowCnec.getIMax(TwoSides.ONE), flowCnec.getIMax(TwoSides.TWO), JsonSerializationConstants.I_MAX);
    }

    private void serializeNominalVoltage(FlowCnec flowCnec, JsonGenerator gen) throws IOException {
        serializeDoubleValuesOnBothSide(gen, flowCnec.getNominalVoltage(TwoSides.ONE), flowCnec.getNominalVoltage(TwoSides.TWO), JsonSerializationConstants.NOMINAL_VOLTAGE);
    }

    private void serializeDoubleValuesOnBothSide(JsonGenerator gen, Double valueSideLeft, Double valueSideRight, String fieldName) throws IOException {

        if (valueSideLeft == null && valueSideRight == null) {
            return;
        }

        gen.writeArrayFieldStart(fieldName);
        if (valueSideLeft != null && valueSideLeft.equals(valueSideRight)) {
            gen.writeNumber(valueSideLeft);
        } else {
            gen.writeNumber(valueSideLeft != null ? valueSideLeft : Double.NaN);
            gen.writeNumber(valueSideRight != null ? valueSideRight : Double.NaN);
        }
        gen.writeEndArray();
    }

    private void serializeThresholds(FlowCnec flowCnec, JsonGenerator gen) throws IOException {
        gen.writeArrayFieldStart(JsonSerializationConstants.THRESHOLDS);
        List<BranchThreshold> sortedListOfThresholds = flowCnec.getThresholds().stream()
            .sorted(new JsonSerializationConstants.ThresholdComparator())
            .toList();
        for (BranchThreshold threshold : sortedListOfThresholds) {
            gen.writeObject(threshold);
        }
        gen.writeEndArray();
    }
}