ShuntCompensatorAdder.java

/**
 * Copyright (c) 2016, All partners of the iTesla project (http://www.itesla-project.eu/consortium)
 * 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.iidm.network;

/**
 * To create a shunt compensator, from a <code>VoltageLevel</code> instance call
 * the {@link VoltageLevel#newShuntCompensator()} method to get a shunt compensator builder
 * instance.
 * <p>
 * Example:
 *<pre>
 *    VoltageLevel vl = ...
 *    ShuntCompensator s = vl.newShunt()
 *            .setId("s1")
 *            ...
 *        .add();
 *</pre>
 *
 * @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
 * @see ShuntCompensator
 * @see VoltageLevel
 */
public interface ShuntCompensatorAdder extends InjectionAdder<ShuntCompensator, ShuntCompensatorAdder> {

    ShuntCompensatorLinearModelAdder newLinearModel();

    ShuntCompensatorNonLinearModelAdder newNonLinearModel();

    ShuntCompensatorAdder setSectionCount(int sectionCount);

    default ShuntCompensatorAdder setRegulatingTerminal(Terminal regulatingTerminal) {
        throw new UnsupportedOperationException();
    }

    default ShuntCompensatorAdder setVoltageRegulatorOn(boolean voltageRegulatorOn) {
        throw new UnsupportedOperationException();
    }

    default ShuntCompensatorAdder setTargetV(double targetV) {
        throw new UnsupportedOperationException();
    }

    default ShuntCompensatorAdder setTargetDeadband(double targetDeadband) {
        throw new UnsupportedOperationException();
    }

    @Override
    ShuntCompensator add();

}