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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
162
163
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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
/*
* SPDX-FileCopyrightText: All Contributors to the PyTango project
*
* SPDX-License-Identifier: LGPL-3.0-or-later
*/
#ifndef _ATTR_H_
#define _ATTR_H_
#include <boost/python.hpp>
#include <tango/tango.h>
#include "exception.h"
#include "pytgutils.h"
#include "server/device_impl.h"
class PyAttr
{
public:
/**
* Constructor
*/
PyAttr() { }
/**
* Desctructor
*/
virtual ~PyAttr() { }
/**
* Read one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be read
* @param[in, out] att the attribute
*/
void read(Tango::DeviceImpl *dev, Tango::Attribute &att);
/**
* Write one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be written
* @param[in, out] att the attribute
*/
void write(Tango::DeviceImpl *dev, Tango::WAttribute &att);
/**
* Decide if it is allowed to read/write the attribute
*
* @param[in] dev The device on which the attribute has to be read/written
* @param[in] ty The requets type (read or write)
*
* @return a boolean set to true if it is allowed to execute
* the command. Otherwise, returns false
*/
bool is_allowed(Tango::DeviceImpl *dev, Tango::AttReqType ty);
/**
* Sets the is_allowed method name for this attribute
*
* @param[in] name the is_allowed method name
*/
inline void set_allowed_name(const std::string &name)
{
py_allowed_name = name;
}
/**
* Sets the read method name for this attribute
*
* @param[in] name the read method name
*/
inline void set_read_name(const std::string &name)
{
read_name = name;
}
/**
* Sets the write method name for this attribute
*
* @param[in] name the write method name
*/
inline void set_write_name(const std::string &name)
{
write_name = name;
}
/**
* Transfer user property from a vector of AttrProperty
* to a UserDefaultAttrProp
*
* @param[in] user_prop the AttrProperty vector
* @param[out] def_prop the UserDefaultAttrProp instance
*/
void set_user_prop(std::vector<Tango::AttrProperty> &user_prop, Tango::UserDefaultAttrProp &def_prop);
bool _is_method(Tango::DeviceImpl *dev, const std::string &name);
private:
/** the name of the is allowed python method */
std::string py_allowed_name;
/** the name of the read attribute python method */
std::string read_name;
/** the name of the write attribute python method */
std::string write_name;
};
/**
* The python class representing a scalar attribute
*/
class PyScaAttr : public Tango::Attr, public PyAttr
{
public:
/**
* Python Scalar Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
*/
PyScaAttr(const std::string &na, long _type, Tango::AttrWriteType w) :
Tango::Attr(na.c_str(), _type, w)
{
}
/**
* Python Scalar Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
* @param[in] ww The attribute max dim x
* @param[in] user_prop The attribute user default properties
*/
PyScaAttr(const std::string &na, long _type, Tango::AttrWriteType w, std::vector<Tango::AttrProperty> &user_prop) :
Tango::Attr(na.c_str(), _type, w)
{
if(user_prop.size() == 0)
{
return;
}
Tango::UserDefaultAttrProp def_prop;
set_user_prop(user_prop, def_prop);
set_default_properties(def_prop);
}
/**
* Python Scalar Attribute destructor
*/
~PyScaAttr(){};
/**
* Decide if it is allowed to read/write the attribute
*
* @param[in] dev The device on which the attribute has to be read/written
* @param[in] ty The requets type (read or write)
*
* @return a boolean set to true if it is allowed to execute
* the command. Otherwise, returns false
*/
inline virtual bool is_allowed(Tango::DeviceImpl *dev, Tango::AttReqType ty)
{
return PyAttr::is_allowed(dev, ty);
}
/**
* Read one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be read
* @param[in, out] att the attribute
*/
inline virtual void read(Tango::DeviceImpl *dev, Tango::Attribute &att)
{
return PyAttr::read(dev, att);
}
/**
* Write one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be written
* @param[in, out] att the attribute
*/
virtual void write(Tango::DeviceImpl *dev, Tango::WAttribute &att)
{
return PyAttr::write(dev, att);
}
};
//------------------------------------------------------------------------------------------------
class PySpecAttr : public Tango::SpectrumAttr, public PyAttr
{
public:
/**
* Python Spectrum Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
* @param[in] xx The attribute max dim x
*/
PySpecAttr(const std::string &na, long _type, Tango::AttrWriteType w, long xx) :
Tango::SpectrumAttr(na.c_str(), _type, w, xx)
{
}
/**
* Python Spectrum Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
* @param[in] xx The attribute max dim x
* @param[in] user_prop The attribute user default properties
*/
PySpecAttr(const std::string &na,
long _type,
Tango::AttrWriteType w,
long xx,
std::vector<Tango::AttrProperty> &user_prop) :
Tango::SpectrumAttr(na.c_str(), _type, w, xx)
{
if(user_prop.size() == 0)
{
return;
}
Tango::UserDefaultAttrProp def_prop;
set_user_prop(user_prop, def_prop);
set_default_properties(def_prop);
}
/**
* Python Spectrum Attribute destructor
*/
~PySpecAttr() { }
/**
* Decide if it is allowed to read/write the attribute
*
* @param[in] dev The device on which the attribute has to be read/written
* @param[in] ty The requets type (read or write)
*
* @return a boolean set to true if it is allowed to execute
* the command. Otherwise, returns false
*/
inline virtual bool is_allowed(Tango::DeviceImpl *dev, Tango::AttReqType ty)
{
return PyAttr::is_allowed(dev, ty);
}
/**
* Read one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be read
* @param[in, out] att the attribute
*/
inline virtual void read(Tango::DeviceImpl *dev, Tango::Attribute &att)
{
return PyAttr::read(dev, att);
}
/**
* Write one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be written
* @param[in, out] att the attribute
*/
virtual void write(Tango::DeviceImpl *dev, Tango::WAttribute &att)
{
return PyAttr::write(dev, att);
}
};
//------------------------------------------------------------------------------------------------
class PyImaAttr : public Tango::ImageAttr, public PyAttr
{
public:
/**
* Python Image Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
* @param[in] xx The attribute max dim x
* @param[in] yy The attribute max dim y
*/
PyImaAttr(const std::string &na, long _type, Tango::AttrWriteType w, long xx, long yy) :
Tango::ImageAttr(na.c_str(), _type, w, xx, yy)
{
}
/**
* Python Image Attribute constructor
*
* @param[in] na The attribute name
* @param[in] _type The attribute data type
* @param[in] w The attribute writable type
* @param[in] xx The attribute max dim x
* @param[in] yy The attribute max dim y
* @param[in] user_prop The attribute user default properties
*/
PyImaAttr(const std::string &na,
long _type,
Tango::AttrWriteType w,
long xx,
long yy,
std::vector<Tango::AttrProperty> &user_prop) :
Tango::ImageAttr(na.c_str(), _type, w, xx, yy)
{
if(user_prop.size() == 0)
{
return;
}
Tango::UserDefaultAttrProp def_prop;
set_user_prop(user_prop, def_prop);
set_default_properties(def_prop);
}
/**
* Python Image Attribute destructor
*/
~PyImaAttr() { }
/**
* Decide if it is allowed to read/write the attribute
*
* @param[in] dev The device on which the attribute has to be read/written
* @param[in] ty The requets type (read or write)
*
* @return a boolean set to true if it is allowed to execute
* the command. Otherwise, returns false
*/
inline virtual bool is_allowed(Tango::DeviceImpl *dev, Tango::AttReqType ty)
{
return PyAttr::is_allowed(dev, ty);
}
/**
* Read one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be read
* @param[in, out] att the attribute
*/
inline virtual void read(Tango::DeviceImpl *dev, Tango::Attribute &att)
{
return PyAttr::read(dev, att);
}
/**
* Write one attribute. This method forward the action to the python method.
*
* @param[in] dev The device on which the attribute has to be written
* @param[in, out] att the attribute
*/
virtual void write(Tango::DeviceImpl *dev, Tango::WAttribute &att)
{
return PyAttr::write(dev, att);
}
};
#endif
|
