com.powsybl.openrao.searchtreerao.commons.marginevaluator.BasicRelativeMarginEvaluator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of open-rao-search-tree-rao Show documentation

Implementation of search tree remedial action optimisation with modular approach

The newest version!

/*
 * 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.searchtreerao.commons.marginevaluator;

import com.powsybl.openrao.commons.Unit;
import com.powsybl.openrao.data.crac.api.cnec.FlowCnec;
import com.powsybl.iidm.network.TwoSides;
import com.powsybl.openrao.searchtreerao.result.api.FlowResult;

/**
 * It enables to evaluate the relative margin of a FlowCnec
 *
 * @author Godelaine de Montmorillon {@literal }
 */
public class BasicRelativeMarginEvaluator implements MarginEvaluator {

    public BasicRelativeMarginEvaluator() {
        // do nothing : only getMargin is useful in this class
    }

    @Override
    public double getMargin(FlowResult flowResult, FlowCnec flowCnec, Unit unit) {
        return flowResult.getRelativeMargin(flowCnec, unit);
    }

    @Override
    public double getMargin(FlowResult flowResult, FlowCnec flowCnec, TwoSides side, Unit unit) {
        return flowResult.getRelativeMargin(flowCnec, side, unit);
    }
}