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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pypowsybl Show documentation
A C interface to powsybl, for pypowsybl implementation
The newest version!
/**
 * Copyright (c) 2021-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.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.Load;
import com.powsybl.iidm.network.Network;
import com.powsybl.iidm.network.extensions.LoadDetail;

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

/**
 * @author Etienne Lesot {@literal }
 */
@AutoService(NetworkExtensionDataframeProvider.class)
public class LoadDetailDataframeProvider extends AbstractSingleDataframeNetworkExtension {

    static final String FIXED_P = "fixed_p0";
    static final String VARIABLE_P = "variable_p0";
    static final String FIXED_Q = "fixed_q0";
    static final String VARIABLE_Q = "variable_q0";

    @Override
    public String getExtensionName() {
        return LoadDetail.NAME;
    }

    @Override
    public ExtensionInformation getExtensionInformation() {
        return new ExtensionInformation(LoadDetail.NAME, "Provides active power setpoint and reactive power setpoint for a load",
                "index : id (str), fixed_p (float), variable_p (float), fixed_q (float), variable_q (float)");
    }

    private Stream itemsStream(Network network) {
        return network.getLoadStream()
                .map(l -> (LoadDetail) l.getExtension(LoadDetail.class))
                .filter(Objects::nonNull);
    }

    private LoadDetail getOrThrow(Network network, String id) {
        Load load = network.getLoad(id);
        if (load == null) {
            throw new PowsyblException("Load '" + id + "' not found");
        }
        LoadDetail loadDetail = load.getExtension(LoadDetail.class);
        if (loadDetail == null) {
            throw new PowsyblException("Load '" + id + "' has no LoadDetail extension");
        }
        return loadDetail;
    }

    @Override
    public NetworkDataframeMapper createMapper() {
        return NetworkDataframeMapperBuilder.ofStream(this::itemsStream, this::getOrThrow)
                .stringsIndex("id", ext -> ext.getExtendable().getId())
                .doubles(FIXED_P, (ld, context) -> ld.getFixedActivePower(), (ld, fap, context) -> ld.setFixedActivePower(fap))
                .doubles(VARIABLE_P, (ld, context) -> ld.getVariableActivePower(), (ld, vap, context) -> ld.setVariableActivePower(vap))
                .doubles(FIXED_Q, (ld, context) -> ld.getFixedReactivePower(), (ld, frp, context) -> ld.setFixedReactivePower(frp))
                .doubles(VARIABLE_Q, (ld, context) -> ld.getVariableReactivePower(), (ld, vrp, context) -> ld.setVariableReactivePower(vrp))
                .build();
    }

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

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