com.powsybl.dataframe.network.extensions.CoordinatedReactiveControlDataframeProvider Maven / Gradle / Ivy

Go to download
/**
 * 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.dataframe.network.extensions;

import com.google.auto.service.AutoService;
import com.powsybl.commons.PowsyblException;
import com.powsybl.dataframe.network.ExtensionInformation;
import com.powsybl.dataframe.network.NetworkDataframeMapper;
import com.powsybl.dataframe.network.NetworkDataframeMapperBuilder;
import com.powsybl.dataframe.network.adders.NetworkElementAdder;
import com.powsybl.iidm.network.Generator;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.network.extensions.CoordinatedReactiveControl;

import java.util.List;
import java.util.Objects;
import java.util.stream.Stream;

/**
 * @author Etienne Lesot {@literal }
 */
@AutoService(NetworkExtensionDataframeProvider.class)
public class CoordinatedReactiveControlDataframeProvider extends AbstractSingleDataframeNetworkExtension {
    @Override
    public String getExtensionName() {
        return CoordinatedReactiveControl.NAME;
    }

    @Override
    public ExtensionInformation getExtensionInformation() {
        return new ExtensionInformation(CoordinatedReactiveControl.NAME, "it allow to specify the percent of " +
                "the coordinated reactive control that comes from a generator",
                "index : generator_id (str), q_percent (float)");
    }

    private Stream itemsStream(Network network) {
        return network.getGeneratorStream().filter(Objects::nonNull)
                .map(generator -> (CoordinatedReactiveControl) generator.getExtension(CoordinatedReactiveControl.class))
                .filter(Objects::nonNull);
    }

    private CoordinatedReactiveControl getOrThrow(Network network, String id) {
        Generator generator = network.getGenerator(id);
        if (generator == null) {
            throw new PowsyblException("Invalid generator id : could not find " + id);
        }
        return generator.getExtension(CoordinatedReactiveControl.class);
    }

    @Override
    public NetworkDataframeMapper createMapper() {
        return NetworkDataframeMapperBuilder.ofStream(this::itemsStream, this::getOrThrow)
                .stringsIndex("generator_id", coordinatedReactiveControl -> coordinatedReactiveControl.getExtendable().getId())
                .doubles("q_percent", (crc, context) -> crc.getQPercent(), (crc, qPercent, context) -> crc.setQPercent(qPercent))
                .build();
    }

    @Override
    public void removeExtensions(Network network, List ids) {
        ids.stream().filter(Objects::nonNull)
                .map(network::getGenerator)
                .filter(Objects::nonNull)
                .forEach(generator -> generator.removeExtension(CoordinatedReactiveControl.class));
    }

    @Override
    public NetworkElementAdder createAdder() {
        return new CoordinatedReactiveControlDataframeAdder();
    }
}