com.powsybl.dataframe.network.adders.NetworkElementAdder 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) 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.adders;

import com.powsybl.commons.report.ReportNode;
import com.powsybl.dataframe.SeriesMetadata;
import com.powsybl.dataframe.update.UpdatingDataframe;
import com.powsybl.iidm.network.Network;

import java.util.List;

/**
 * @author Sylvain Leclerc {@literal }
 */
public interface NetworkElementAdder {

    /**
     * Get the list of metadata: one list of columns metadata for each input dataframe.
     */
    List> getMetadata();

    /**
     * Adds elements to the network, based on a list of dataframes.
     * The first dataframe is considered the "primary" dataframe, other dataframes
     * can provide additional data (think steps for the tap changers).
     */
    void addElements(Network network, List dataframes);

    default void addElementsWithBay(Network network, List dataframe, boolean throwException, ReportNode reportNode) {
        throw new UnsupportedOperationException();
    }
}