/
IllegalActionExceptions.py
98 lines (67 loc) · 2.94 KB
/
IllegalActionExceptions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# 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
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
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
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
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
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
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
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
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.
class UnitCommitorRedispachingNotAvailable(IllegalAction):
"""
attempt to use redispatching or unit commit method in an environment not set up.
"""
pass