Action.java

/**
 * Copyright (c) 2017, 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.action.ial.dsl;

import com.powsybl.commons.report.ReportNode;
import com.powsybl.computation.ComputationManager;
import com.powsybl.iidm.modification.NetworkModification;
import com.powsybl.iidm.network.Network;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * @author Geoffroy Jamgotchian {@literal <geoffroy.jamgotchian at rte-france.com>}
 */
public class Action {

    private final String id;

    private String description;

    private final List<NetworkModification> modifications;

    public Action(String id) {
        this(id, new ArrayList<>());
    }

    public Action(String id, List<NetworkModification> modifications) {
        this.id = Objects.requireNonNull(id);
        this.modifications = Objects.requireNonNull(modifications);
    }

    public String getId() {
        return id;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public List<NetworkModification> getModifications() {
        return modifications;
    }

    public void run(Network network, boolean throwException, ComputationManager computationManager) {
        for (NetworkModification task : modifications) {
            task.apply(network, throwException, computationManager, ReportNode.NO_OP);
        }
    }

    public void run(Network network, ComputationManager computationManager) {
        run(network, true, computationManager);
    }

    public void run(Network network) {
        for (NetworkModification task : modifications) {
            task.apply(network, true, ReportNode.NO_OP);
        }
    }

    public void run(Network network, boolean throwException) {
        for (NetworkModification task : modifications) {
            task.apply(network, throwException, ReportNode.NO_OP);
        }
    }
}