com.powsybl.action.PhaseTapChangerTapPositionAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-action-api Show documentation

Powsybl action API

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/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.action;

import com.powsybl.iidm.modification.NetworkModification;
import com.powsybl.iidm.modification.tapchanger.PhaseTapPositionModification;
import com.powsybl.iidm.network.ThreeSides;

/**
 * An action changing the tap position of a phase-shifting transformer.
 *
 * @author Hadrien Godard {@literal }
 */
public class PhaseTapChangerTapPositionAction extends AbstractTapChangerTapPositionAction {

    public static final String NAME = "PHASE_TAP_CHANGER_TAP_POSITION";

    public PhaseTapChangerTapPositionAction(String id, String transformerId, boolean relativeValue, int tapPosition) {
        super(id, transformerId, relativeValue, tapPosition, null);
    }

    public PhaseTapChangerTapPositionAction(String id, String transformerId, boolean relativeValue, int tapPosition, ThreeSides side) {
        super(id, transformerId, relativeValue, tapPosition, side);
    }

    @Override
    public String getType() {
        return NAME;
    }

    @Override
    public NetworkModification toModification() {
        return getSide().map(side -> new PhaseTapPositionModification(getTransformerId(), getTapPosition(), side, isRelativeValue()))
                        .orElse(new PhaseTapPositionModification(getTransformerId(), getTapPosition(), isRelativeValue()));
    }
}