com.powsybl.iidm.modification.topology.RemoveHvdcLineBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-modification Show documentation

The network modification API and a set of classes implementing it

There is a newer version: 6.5.0-RC1

Show newest version

/**
 * Copyright (c) 2023, 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.iidm.modification.topology;

import java.util.*;

/**
 * @author Anis Touri {@literal }
 */

public class RemoveHvdcLineBuilder {

    private String hvdcLineId;

    private final List shuntCompensatorIds = new ArrayList<>();

    public RemoveHvdcLine build() {
        Objects.requireNonNull(hvdcLineId);
        return new RemoveHvdcLine(hvdcLineId, shuntCompensatorIds);
    }

    /**
     * @param hvdcLineId the non-null ID of the Hvdc line
     */
    public RemoveHvdcLineBuilder withHvdcLineId(String hvdcLineId) {
        this.hvdcLineId = hvdcLineId;
        return this;
    }

    /**
     * If we remove an hvdc line with lcc converter stations, each converter stations can be associated, in the same
     * voltage level to a series of shunt compensators (also called filters).
     *
     * @param shuntCompensatorIds IDs of the shunt compensators that must be deleted.
     */
    public RemoveHvdcLineBuilder withShuntCompensatorIds(List shuntCompensatorIds) {
        this.shuntCompensatorIds.clear();
        this.shuntCompensatorIds.addAll(Objects.requireNonNull(shuntCompensatorIds));
        return this;
    }

    public RemoveHvdcLineBuilder withShuntCompensatorIds(String... shuntCompensatorIds) {
        this.shuntCompensatorIds.clear();
        this.shuntCompensatorIds.addAll(Arrays.asList(shuntCompensatorIds));
        return this;
    }
}