com.powsybl.openrao.data.cracio.commons.cgmes.CgmesBranchHelper Maven / Gradle / Ivy

Go to download
/*
 * 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.cracio.commons.cgmes;

import com.powsybl.openrao.data.cracio.commons.ElementHelper;
import com.powsybl.iidm.network.*;

import java.util.Objects;

/**
 * @author Philippe Edwards{@literal }
 */
public class CgmesBranchHelper implements ElementHelper {

    private final String mrId;

    private TwoSides tieLineSide = null;
    private boolean isHalfLine = false;

    private Branch branch = null;

    /**
     * Constructor.
     *
     * @param mrId,                 CGMES-id of the branch
     * @param network,              powsybl iidm network object
     *
     */
    public CgmesBranchHelper(String mrId, Network network) {
        this.mrId = mrId;
        interpret(network);
    }

    public boolean isHalfLine() {
        return isHalfLine;
    }

    public TwoSides getTieLineSide() {
        return tieLineSide;
    }

    public Branch getBranch() {
        return branch;
    }

    protected void interpret(Network network) {
        branch = network.getBranch(mrId);
        if (Objects.isNull(branch)) {
            // check if it's a half line
            for (TieLine tieLine : network.getTieLines()) {
                if (tieLine.getDanglingLine1().getId().equals(mrId)) {
                    isHalfLine = true;
                    tieLineSide = TwoSides.ONE;
                    branch = tieLine;
                    return;
                } else if (tieLine.getDanglingLine2().getId().equals(mrId)) {
                    isHalfLine = true;
                    tieLineSide = TwoSides.TWO;
                    branch = tieLine;
                    return;
                }
            }
        }
    }

    @Override
    public boolean isValid() {
        return Objects.nonNull(branch);
    }

    @Override
    public String getInvalidReason() {
        return String.format("Branch with id %s was not found in network.", mrId);
    }

    @Override
    public String getIdInNetwork() {
        return branch.getId();
    }
}