com.powsybl.shortcircuit.converter.ShortCircuitAnalysisResultExporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-shortcircuit-api Show documentation

An API to run three-phase short-circuit analysis

There is a newer version: 6.5.0-RC1

Show newest version

/**
 * Copyright (c) 2021, 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.shortcircuit.converter;

import com.powsybl.iidm.network.Network;
import com.powsybl.shortcircuit.ShortCircuitAnalysisResult;

import java.io.IOException;
import java.io.Writer;

/**
 * Implementations provide a method to write down the content of a {@link ShortCircuitAnalysisResult}.
 *
 * @author Boubakeur Brahimi
 */
public interface ShortCircuitAnalysisResultExporter {

    String getFormat();

    String getComment();

    void export(ShortCircuitAnalysisResult result, Writer writer, Network network) throws IOException;

}