SweCneUtil.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.cne.swe;

import com.powsybl.iidm.network.Branch;
import com.powsybl.iidm.network.Country;
import com.powsybl.iidm.network.Substation;
import com.powsybl.iidm.network.TwoSides;
import com.powsybl.openrao.commons.OpenRaoException;
import com.powsybl.openrao.data.raoresult.io.cne.swe.xsd.AreaIDString;
import com.powsybl.openrao.data.raoresult.io.cne.swe.xsd.ESMPDateTimeInterval;
import com.powsybl.openrao.data.raoresult.io.cne.swe.xsd.PartyIDString;
import com.powsybl.openrao.data.raoresult.io.cne.swe.xsd.ResourceIDString;
import org.threeten.extra.Interval;

import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;

import static com.powsybl.openrao.data.raoresult.io.cne.commons.CneUtil.cutString;

/**
 * Auxiliary methods
 *
 * @author Viktor Terrier {@literal <viktor.terrier at rte-france.com>}
 * @author Peter Mitri {@literal <peter.mitri at rte-france.com>}
 */
public final class SweCneUtil {
    private SweCneUtil() {
    }

    public static final int DEFAULT_DECIMALS_FOR_ROUNDING_ANGLES = 1;
    public static final int DEFAULT_DECIMALS_FOR_ROUNDING_FLOWS = 1;
    public static final int DEFAULT_DECIMALS_FOR_ROUNDING_THRESHOLDS = 0;
    public static final String SWE_CNE_EXPORT_PROPERTIES_PREFIX = "rao-result.export.swe-cne.";

    // Creation of time interval
    public static ESMPDateTimeInterval createEsmpDateTimeInterval(OffsetDateTime offsetDateTime) {
        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm'Z'");

        ESMPDateTimeInterval timeInterval = new ESMPDateTimeInterval();

        OffsetDateTime utcDateTime = offsetDateTime.withOffsetSameInstant(ZoneOffset.UTC);
        timeInterval.setStart(dateFormat.format(utcDateTime));
        timeInterval.setEnd(dateFormat.format(utcDateTime.plusHours(1)));
        return timeInterval;

    }

    // Creation of time interval
    public static ESMPDateTimeInterval createEsmpDateTimeIntervalForWholeDay(String intervalString) {
        Interval interval = Interval.parse(intervalString);
        DateTimeFormatter dateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm'Z'").withZone(ZoneId.from(ZoneOffset.UTC));
        ESMPDateTimeInterval timeInterval = new ESMPDateTimeInterval();
        timeInterval.setStart(dateFormat.format(interval.getStart()));
        timeInterval.setEnd(dateFormat.format(interval.getEnd()));
        return timeInterval;
    }

    // Creation of ID with code scheme
    public static ResourceIDString createResourceIDString(String codingScheme, String value) {
        ResourceIDString resourceMRID = new ResourceIDString();
        resourceMRID.setCodingScheme(codingScheme);
        resourceMRID.setValue(cutString(value, 60));
        return resourceMRID;
    }

    // Creation of ID with code scheme
    public static PartyIDString createPartyIDString(String codingScheme, String value) {
        PartyIDString marketParticipantMRID = new PartyIDString();
        marketParticipantMRID.setCodingScheme(codingScheme);
        marketParticipantMRID.setValue(cutString(value, 16));
        return marketParticipantMRID;
    }

    // Creation of area ID with code scheme
    public static AreaIDString createAreaIDString(String codingScheme, String value) {
        AreaIDString areaIDString = new AreaIDString();
        areaIDString.setCodingScheme(codingScheme);
        areaIDString.setValue(cutString(value, 16));
        return areaIDString;
    }

    public static Country getOperatorCountry(String operator) {
        return switch (operator) {
            case "RTE" -> Country.FR;
            case "REE" -> Country.ES;
            case "REN" -> Country.PT;
            default -> throw new OpenRaoException(String.format("Unknown operator in SWE region: \"%s\"", operator));
        };
    }

    public static Country getBranchCountry(Branch<?> branch, TwoSides side) {
        return branch.getTerminal(side).getVoltageLevel().getSubstation()
            .flatMap(Substation::getCountry)
            .orElseThrow(() -> new OpenRaoException(String.format("Cannot figure out country of branch \"%s\" on side %s", branch.getId(), side)));
    }
}