com.powsybl.iidm.modification.NetworkModificationImpact Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-modification Show documentation

The network modification API and a set of classes implementing it

There is a newer version: 6.5.0-RC1

Show newest version

/*
 * Copyright (c) 2024, 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.iidm.modification;

/**
 * This enum represents the potential impact of a network modification on a network.
 * 
 *     The possible values for the enum are:
 *     

 *         {@code CANNOT_BE_APPLIED}: the network modification cannot be applied on this network. If it applied,
 *         an exception will be thrown.
 *         {@code NO_IMPACT_ON_NETWORK}: the network modification can be applied to the network but, once the
 *         network modification is applied, the network will still be the same as before.
 *         {@code HAS_IMPACT_ON_NETWORK}: the network modification can be applied to the network and, once the
 *         network modification is applied, the network will be different in its topology, steady states hypothesis
 *         or physical characteristics.
 *     
 * 
 *
 * @author Nicolas Rol {@literal }
 */
public enum NetworkModificationImpact {
    CANNOT_BE_APPLIED,
    NO_IMPACT_ON_NETWORK,
    HAS_IMPACT_ON_NETWORK
}