Source code for grid2op.Exceptions.IllegalActionExceptions

# Copyright (c) 2019-2020, RTE (https://www.rte-france.com)
# See AUTHORS.txt
# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
# you can obtain one at http://mozilla.org/MPL/2.0/.
# SPDX-License-Identifier: MPL-2.0
# This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems.

from grid2op.Exceptions.Grid2OpException import Grid2OpException


# exception bad actions
[docs]class IllegalAction(Grid2OpException): """ This exception indicate that the :class:`grid2op.BaseAction` is illegal. It is for example thrown when an :class:`grid2op.BaseAgent` tries to perform an action against the rule. This is handled in :func:`grid2op.Environment.Environment.step` An :class:`grid2op.BaseAction` is said to be **illegal** depending on some rules implemented in :func:`grid2op.BaseAction.ActionSpace.is_legal` method. An action can be legal in some context, but illegal in others. """ pass
[docs]class OnProduction(IllegalAction): """ This is a more precise exception than :class:`IllegalAction` indicating that the action is illegal due to setting wrong values to generators. """ pass
[docs]class VSetpointModified(OnProduction): """ This is a more precise exception than :class:`OnProduction` indicating that the action is illegal because the setpoint voltage magnitude of a production has been changed. """ pass
[docs]class ActiveSetPointAbovePmax(OnProduction): """ This is a more precise exception than :class:`OnProduction` indicating that the action is illegal because the setpoint active power of a production is set to be higher than Pmax. """ pass
[docs]class ActiveSetPointBelowPmin(OnProduction): """ This is a more precise exception than :class:`OnProduction` indicating that the action is illegal because the setpoint active power of a production is set to be lower than Pmin. """ pass
[docs]class OnLoad(IllegalAction): """ This is a more precise exception than :class:`IllegalAction` indicating that the action is illegal due to setting wrong values to loads. """ pass
[docs]class OnLines(IllegalAction): """ This is a more precise exception than :class:`IllegalAction` indicating that the action is illegal due to setting wrong values to lines (reconnection impossible, disconnection impossible etc). """ pass
[docs]class InvalidReconnection(OnLines): """ This is a more precise exception than :class:`OnLines` indicating that the :class:`grid2op.BaseAgent` tried to reconnect a powerline illegally. """ pass
# attempt to use redispatching or unit commit method in an environment not set up.
[docs]class UnitCommitorRedispachingNotAvailable(IllegalAction): """ attempt to use redispatching or unit commit method in an environment not set up. """ pass