param.py 7.1 KB
Newer Older
Daniel Brown's avatar
Daniel Brown committed
1
2
import abc
import pykat.exceptions as pkex
3
4
import weakref
    
Daniel Brown's avatar
Daniel Brown committed
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
class putable(object):
    """
    Objects that inherit this should be able to have something `put` to it.
    Essentially this means you could write Finesse commands like
    
    put this parameter value
    """
    __metaclass__ = abc.ABCMeta
    
    def __init__(self, component_name, parameter_name, isPutable=True):
        self._parameter_name = parameter_name
        self._component_name = component_name
        self._putter = None
        self._isPutable  = isPutable
    
    @property
    def isPutable(self): return self._isPutable
    
    def put(self, var):
    
        if not isinstance(var, putter):
            raise pkex.BasePyKatException("var was not something that can be `put` as a value")
        
        if self._putter != None:
            self._putter.put_count -= 1
30
            self._putter.putees.remove(self)
Daniel Brown's avatar
Daniel Brown committed
31
32
        
        self._putter = var
33
34
35
36
        
        if var != None:
            self._putter.put_count += 1
            self._putter.putees.append(self)
Daniel Brown's avatar
Daniel Brown committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
        
    def _getPutFinesseText(self):
        rtn = []
        # if something is being put to this 
        if self._putter != None:
            rtn.append("put {comp} {param} ${value}".format(comp=self._component_name, param=self._parameter_name, value=self._putter.put_name()))
        
        return rtn
            
class putter(object):
    """
    If an object can be put to something that is putable it should inherit this
    object.
    """
    
    def __init__(self, put_name, isPutter=True):
        self._put_name = put_name
        self.put_count = 0
        self._isPutter = isPutter
56
        self.putees = [] # list of params that this puts to
Daniel Brown's avatar
Daniel Brown committed
57
58
59
60
61
62
63
64
65
    
    @property
    def isPutter(self): return self._isPutter
    
    def put_name(self): return self._put_name
    
        
class Param(putable, putter):

66
    def __init__(self, name, owner, value, canFsig=False, fsig_name=None, isPutable=True, isPutter=True, isTunable=True, var_name=None):
Daniel Brown's avatar
Daniel Brown committed
67
        self._name = name
68
        self._owner = weakref.ref(owner)
Daniel Brown's avatar
Daniel Brown committed
69
70
71
        self._value = value
        self._isPutter = isPutter
        self._isTunable = isTunable
72
        self._owner()._register_param(self)
73
74
75
76
77
78
79
80
81
        self._canFsig = False
        
        if canFsig:
            self._canFsig = True

            if fsig_name == None:
                raise pkex.BasePyKatException("If parameter is a possible fsig target the fsig_name argument must be set")

            self.__fsig_name = fsig_name
Daniel Brown's avatar
Daniel Brown committed
82
83
84
85
86
        
        if isPutter:
            if var_name == None:
                var_name = "var_{0}_{1}".format(owner.name, name)
                
87
        putter.__init__(self, var_name, isPutter)
Daniel Brown's avatar
Daniel Brown committed
88
            
89
90
        putable.__init__(self, owner.name, name, isPutable)
        
91
92
93
    @property
    def canFsig(self): return self._canFsig
    
94
95
96
    @property
    def owner(self): return self._owner()
    
97
98
99
    @property
    def fsig_name(self): return self.__fsig_name
    
Daniel Brown's avatar
Daniel Brown committed
100
101
102
103
104
105
106
    @property
    def name(self): return self._name
    
    @property
    def isTuneable(self): return self._isTunable
    
    @property
107
108
109
110
111
112
    def value(self):
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))
        else:
            return self._value
    
Daniel Brown's avatar
Daniel Brown committed
113
114
    @value.setter
    def value(self, value):
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))
        else:
            self._value = value
    
    def __str__(self):
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))
        else:
            return str(self.value)
            
    def __float__(self):
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))
        else:
            return self.value
Daniel Brown's avatar
Daniel Brown committed
131
132
        
    def getFinesseText(self):
133
134
135
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))
            
Daniel Brown's avatar
Daniel Brown committed
136
137
138
139
140
141
142
        rtn = []
        
        if self.isPutable: rtn.extend(self._getPutFinesseText())
        
        # if this parameter is being put somewhere then we need to
        # set it as a variable
        if self.isPutter and self.put_count > 0:
143
            rtn.append("set {put_name} {comp} {param}".format(put_name=self.put_name(), comp=self._owner().name, param=self.name))
Daniel Brown's avatar
Daniel Brown committed
144
145
        
        return rtn
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    
    def _onOwnerRemoved(self):
        #if this param can be put somewhere we need to check if it is
        if self.isPutable:
            for a in self.putees:
                print "Removing put from {0} {1} to {2} {3}".format(self.owner.name, self.name, a.owner.name, a.name)
                a._putter = None
                self.put_count -= 1
                
            # delete any references left over
            del self.putees[:]
        
        # check if we have anything being put to us
        if self.isPutter:
            if self._putter != None:
                print "Removing put from {0} {1} to {2} {3}".format(self._putter.owner.name, self._putter.name, self.owner.name, self.name)
                self._putter.put_count -= 1
                self._putter.putees.remove(self)
                self._putter = None
       
       
Daniel Brown's avatar
Daniel Brown committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
    def __mul__(self, a):
        return self.value * a
    
    def __imul__(self, a):
        return self.value * (a)
        
    __rmul__ = __mul__
    
    def __add__(self, a):
        return self.value + (a)
    
    def __iadd__(self, a):
        return self.value + (a)
        
    __radd__ = __add__
    
    def __sub__(self, a):
        return self.value - (a)
    
    def __isub__(self, a):
        return self.value - (a)
        
189
190
    def __rsub__(self, a):
        return (a) - self.value
Daniel Brown's avatar
Daniel Brown committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
    
    def __div__(self, a):
        return self.value / (a)
    
    def __idiv__(self, a):
        return self.value / complex(a)
        
    def __pow__(self, q):
        return  self.value**q

    def __neg__(self):
        return -self.value
        
    def __eq__(self, q):
        return (q) == self.value
    def __ne__(self, q):
        return (q) != self.value
    def __lt__(self, q):
        return (q) > self.value
    def __gt__(self, q):
        return (q) < self.value        
        
class AttrParam(Param):
    """
    Certain parameters of a component are set using the Finesse `attr` command.
    
    This inherits directly from a Param object so can be set whether this attribute
    is putable or a putter.
    
    If the value pf the parameter is not 0 the attr command will be printed.
    """
    def getFinesseText(self):
223
224
225
        if self._owner().removed:
            raise pkex.BasePyKatException("{0} has been removed from the simulation".format(self._owner().name))

Daniel Brown's avatar
Daniel Brown committed
226
227
        rtn = []
        
228
        if self.value != None:
229
            rtn.append("attr {0} {1} {2}".format(self._owner().name, self.name, self.value))
Daniel Brown's avatar
Daniel Brown committed
230
231
232
            
        rtn.extend(super(AttrParam, self).getFinesseText())
        
233
        return rtn
234
235