annotate components/lockable.py @ 91:d2451ecb1433

Added saveable_fields to FifeAgent component.
author KarstenBock@gmx.net
date Tue, 27 Sep 2011 15:38:24 +0200
parents 939984cff702
children
rev   line source
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
1 # This program is free software: you can redistribute it and/or modify
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
2 # it under the terms of the GNU General Public License as published by
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
3 # the Free Software Foundation, either version 3 of the License, or
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
4 # (at your option) any later version.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
5 #
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
6 # This program is distributed in the hope that it will be useful,
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
9 # GNU General Public License for more details.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
10 #
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
11 # You should have received a copy of the GNU General Public License
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
12 # along with this program. If not, see <http://www.gnu.org/licenses/>.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
13
89
939984cff702 Added Base component, which has a saveable_fields property. It is supposed to be derived from, thus it is not in the components list.
KarstenBock@gmx.net
parents: 65
diff changeset
14 from base import Base
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
15
89
939984cff702 Added Base component, which has a saveable_fields property. It is supposed to be derived from, thus it is not in the components list.
KarstenBock@gmx.net
parents: 65
diff changeset
16 class Lockable(Base):
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
17 """Component that stores the data of a lock"""
25
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
18
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
19 def __init__(self):
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
20 """Constructor"""
89
939984cff702 Added Base component, which has a saveable_fields property. It is supposed to be derived from, thus it is not in the components list.
KarstenBock@gmx.net
parents: 65
diff changeset
21 Base.__init__(self, closed=bool, locked=bool)
25
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
22
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
23 class LockedError(Exception):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
24
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
25 def __str__(self):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
26 return "Is locked"
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
27
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
28 class OpenError(Exception):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
29
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
30 def __str__(self):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
31 return "Is open"
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
32
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
33 def lock(lock):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
34 if not lock.closed:
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
35 raise OpenError
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
36 lock.locked = True
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
37
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
38 def unlock(lock):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
39 lock.locked = False
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
40
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
41 def open(lock):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
42 if lock.locked:
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
43 raise LockedError
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
44 lock.closed = False
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
45
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
46 def close(lock):
d13924109572 Added functions for Lockable
KarstenBock@gmx.net
parents: 21
diff changeset
47 lock.closed = True