param.py 6.06 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
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
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
        
        self._putter = var
        self._putter.put_count += 1
        
    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
    
    @property
    def isPutter(self): return self._isPutter
    
    def put_name(self): return self._put_name
    
        
class Param(putable, putter):

61
    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
62
        self._name = name
63
        self._owner = weakref.ref(owner)
Daniel Brown's avatar
Daniel Brown committed
64
65
66
        self._value = value
        self._isPutter = isPutter
        self._isTunable = isTunable
67
        self._owner()._register_param(self)
68
69
70
71
72
73
74
75
76
        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
77
78
79
80
81
82
83
84
85
        
        if isPutter:
            if var_name == None:
                var_name = "var_{0}_{1}".format(owner.name, name)
                
            putter.__init__(self, var_name, isPutter)
            
        if isPutable:
            putable.__init__(self, owner.name, name, isPutable)
86
87
88
89
90
91
92
    
    @property
    def canFsig(self): return self._canFsig
    
    @property
    def fsig_name(self): return self.__fsig_name
    
Daniel Brown's avatar
Daniel Brown committed
93
94
95
96
97
98
99
    @property
    def name(self): return self._name
    
    @property
    def isTuneable(self): return self._isTunable
    
    @property
100
101
102
103
104
105
    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
106
107
    @value.setter
    def value(self, value):
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
        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
124
125
        
    def getFinesseText(self):
126
127
128
        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
129
130
131
132
133
134
135
        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:
136
            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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
        
        return rtn
        
    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)
        
162
163
    def __rsub__(self, a):
        return (a) - self.value
Daniel Brown's avatar
Daniel Brown committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
    
    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):
196
197
198
        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
199
200
        rtn = []
        
201
        if self.value != None:
202
            rtn.append("attr {0} {1} {2}".format(self._owner().name, self.name, self.value))
Daniel Brown's avatar
Daniel Brown committed
203
204
205
            
        rtn.extend(super(AttrParam, self).getFinesseText())
        
206
        return rtn
207
208