forked from tango-controls/cppTango-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassTango_1_1Attr.html
739 lines (690 loc) · 36.8 KB
/
classTango_1_1Attr.html
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Tango Core Classes Reference: Tango::Attr Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.jpg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Tango Core Classes Reference
 <span id="projectnumber">9.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classTango_1_1Attr.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="classTango_1_1Attr-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Tango::Attr Class Reference<div class="ingroups"><a class="el" href="group__Server.html">Server classes</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>User class to create a no dimension attribute object.
<a href="classTango_1_1Attr.html#details">More...</a></p>
<p><code>#include "tango.h"</code></p>
<div class="dynheader">
Inheritance diagram for Tango::Attr:</div>
<div class="dyncontent">
<div class="center"><img src="classTango_1_1Attr__inherit__graph.png" border="0" usemap="#Tango_1_1Attr_inherit__map" alt="Inheritance graph"/></div>
<map name="Tango_1_1Attr_inherit__map" id="Tango_1_1Attr_inherit__map">
<area shape="rect" title="User class to create a no dimension attribute object." alt="" coords="33,5,120,32"/>
<area shape="rect" href="classTango_1_1SpectrumAttr.html" title="User class to create a one dimension attribute object." alt="" coords="5,80,148,107"/>
<area shape="rect" href="classTango_1_1ImageAttr.html" title="User class to create a two dimensions attribute object." alt="" coords="15,155,138,181"/>
<area shape="rect" href="classTango_1_1FwdAttr.html" title="User class to create a forwarded attribute object." alt="" coords="21,229,133,256"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Two constructors are defined for this class </p>
</div></td></tr>
<tr class="memitem:a7333f0eab1956673be866f4c7a2d44e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a7333f0eab1956673be866f4c7a2d44e8">Attr</a> (const char *name, long data_type, Tango::AttrWriteType w_type=Tango::READ, const char *assoc=AssocWritNotSpec)</td></tr>
<tr class="memdesc:a7333f0eab1956673be866f4c7a2d44e8"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. <a href="#a7333f0eab1956673be866f4c7a2d44e8">More...</a><br /></td></tr>
<tr class="separator:a7333f0eab1956673be866f4c7a2d44e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad03a6014aeefda86d8ee4d52659a6c39"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#ad03a6014aeefda86d8ee4d52659a6c39">Attr</a> (const char *name, long data_type, Tango::DispLevel disp, Tango::AttrWriteType w_type=Tango::READ, const char *assoc=AssocWritNotSpec)</td></tr>
<tr class="memdesc:ad03a6014aeefda86d8ee4d52659a6c39"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. <a href="#ad03a6014aeefda86d8ee4d52659a6c39">More...</a><br /></td></tr>
<tr class="separator:ad03a6014aeefda86d8ee4d52659a6c39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad69e9aa5dcd4c22be0509ed72a01cd0d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#ad69e9aa5dcd4c22be0509ed72a01cd0d">Attr</a> (const char *name, Tango::DispLevel disp=Tango::OPERATOR)</td></tr>
<tr class="memdesc:ad69e9aa5dcd4c22be0509ed72a01cd0d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. <a href="#ad69e9aa5dcd4c22be0509ed72a01cd0d">More...</a><br /></td></tr>
<tr class="separator:ad69e9aa5dcd4c22be0509ed72a01cd0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Only one destructor is defined for this class </p>
</div></td></tr>
<tr class="memitem:af280714a1ec4254e7ad7009eb0e8feda"><td class="memItemLeft" align="right" valign="top"><a id="af280714a1ec4254e7ad7009eb0e8feda"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#af280714a1ec4254e7ad7009eb0e8feda">~Attr</a> ()</td></tr>
<tr class="memdesc:af280714a1ec4254e7ad7009eb0e8feda"><td class="mdescLeft"> </td><td class="mdescRight">The object destructor. <br /></td></tr>
<tr class="separator:af280714a1ec4254e7ad7009eb0e8feda"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Miscellaneous methods</div></td></tr>
<tr class="memitem:acca03caaac31c20e746a276ab033c174"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#acca03caaac31c20e746a276ab033c174">set_default_properties</a> (<a class="el" href="classTango_1_1UserDefaultAttrProp.html">UserDefaultAttrProp</a> &prop)</td></tr>
<tr class="memdesc:acca03caaac31c20e746a276ab033c174"><td class="mdescLeft"> </td><td class="mdescRight">Set default attribute properties. <a href="#acca03caaac31c20e746a276ab033c174">More...</a><br /></td></tr>
<tr class="separator:acca03caaac31c20e746a276ab033c174"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f841afb6effc8384e49730550261378"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a8f841afb6effc8384e49730550261378">set_disp_level</a> (Tango::DispLevel level)</td></tr>
<tr class="memdesc:a8f841afb6effc8384e49730550261378"><td class="mdescLeft"> </td><td class="mdescRight">Set the attribute display level. <a href="#a8f841afb6effc8384e49730550261378">More...</a><br /></td></tr>
<tr class="separator:a8f841afb6effc8384e49730550261378"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d0e17f5a1ce7263482bb3df5090f91d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a5d0e17f5a1ce7263482bb3df5090f91d">set_polling_period</a> (long update)</td></tr>
<tr class="memdesc:a5d0e17f5a1ce7263482bb3df5090f91d"><td class="mdescLeft"> </td><td class="mdescRight">Set the attribute polling update period. <a href="#a5d0e17f5a1ce7263482bb3df5090f91d">More...</a><br /></td></tr>
<tr class="separator:a5d0e17f5a1ce7263482bb3df5090f91d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac89c07e2033c13abf2222fd6cd089dc"><td class="memItemLeft" align="right" valign="top"><a id="aac89c07e2033c13abf2222fd6cd089dc"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#aac89c07e2033c13abf2222fd6cd089dc">set_memorized</a> ()</td></tr>
<tr class="memdesc:aac89c07e2033c13abf2222fd6cd089dc"><td class="mdescLeft"> </td><td class="mdescRight">Set the attribute as memorized in database (only for scalar and writable attribute) By default the setpoint will be written to the attribute during initialisation! Use method <a class="el" href="classTango_1_1Attr.html#a5c1d94ccc3bacb8d728cf836df737889" title="Set the initialisation flag for memorized attributes true = the setpoint value will be written to the...">set_memorized_init()</a> with false as argument if you don't want this feature. <br /></td></tr>
<tr class="separator:aac89c07e2033c13abf2222fd6cd089dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c1d94ccc3bacb8d728cf836df737889"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a5c1d94ccc3bacb8d728cf836df737889">set_memorized_init</a> (bool write_on_init)</td></tr>
<tr class="memdesc:a5c1d94ccc3bacb8d728cf836df737889"><td class="mdescLeft"> </td><td class="mdescRight">Set the initialisation flag for memorized attributes true = the setpoint value will be written to the attribute on initialisation false = only the attribute setpoint is initialised. <a href="#a5c1d94ccc3bacb8d728cf836df737889">More...</a><br /></td></tr>
<tr class="separator:a5c1d94ccc3bacb8d728cf836df737889"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68801b4629667565b9cceb6fefa413d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a68801b4629667565b9cceb6fefa413d7">set_change_event</a> (bool implemented, bool detect)</td></tr>
<tr class="memdesc:a68801b4629667565b9cceb6fefa413d7"><td class="mdescLeft"> </td><td class="mdescRight">Set a flag to indicate that the server fires change events manually without the polling to be started for the attribute. <a href="#a68801b4629667565b9cceb6fefa413d7">More...</a><br /></td></tr>
<tr class="separator:a68801b4629667565b9cceb6fefa413d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9269546f4b25a6395efe8b93bdb8d07f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a9269546f4b25a6395efe8b93bdb8d07f">is_change_event</a> ()</td></tr>
<tr class="memdesc:a9269546f4b25a6395efe8b93bdb8d07f"><td class="mdescLeft"> </td><td class="mdescRight">Check if the change event is fired manually for this attribute. <a href="#a9269546f4b25a6395efe8b93bdb8d07f">More...</a><br /></td></tr>
<tr class="separator:a9269546f4b25a6395efe8b93bdb8d07f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3001dc4d14cbdc62a914a15ff3a86e49"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a3001dc4d14cbdc62a914a15ff3a86e49">is_check_change_criteria</a> ()</td></tr>
<tr class="memdesc:a3001dc4d14cbdc62a914a15ff3a86e49"><td class="mdescLeft"> </td><td class="mdescRight">Check if the change event criteria should be checked when firing the event manually. <a href="#a3001dc4d14cbdc62a914a15ff3a86e49">More...</a><br /></td></tr>
<tr class="separator:a3001dc4d14cbdc62a914a15ff3a86e49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ba7dd409514e938cb2f530b767aa98c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a6ba7dd409514e938cb2f530b767aa98c">set_archive_event</a> (bool implemented, bool detect)</td></tr>
<tr class="memdesc:a6ba7dd409514e938cb2f530b767aa98c"><td class="mdescLeft"> </td><td class="mdescRight">Set a flag to indicate that the server fires archive events manually without the polling to be started for the attribute If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fulfilled. <a href="#a6ba7dd409514e938cb2f530b767aa98c">More...</a><br /></td></tr>
<tr class="separator:a6ba7dd409514e938cb2f530b767aa98c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff00859f5da6a7f48e7abe079491f12c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#aff00859f5da6a7f48e7abe079491f12c">is_archive_event</a> ()</td></tr>
<tr class="memdesc:aff00859f5da6a7f48e7abe079491f12c"><td class="mdescLeft"> </td><td class="mdescRight">Check if the archive event is fired manually for this attribute. <a href="#aff00859f5da6a7f48e7abe079491f12c">More...</a><br /></td></tr>
<tr class="separator:aff00859f5da6a7f48e7abe079491f12c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8aa3318fe49d403969a59fe000352be8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a8aa3318fe49d403969a59fe000352be8">is_check_archive_criteria</a> ()</td></tr>
<tr class="memdesc:a8aa3318fe49d403969a59fe000352be8"><td class="mdescLeft"> </td><td class="mdescRight">Check if the archive event criteria should be checked when firing the event manually. <a href="#a8aa3318fe49d403969a59fe000352be8">More...</a><br /></td></tr>
<tr class="separator:a8aa3318fe49d403969a59fe000352be8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e18250ed88d997b603b308212eb7362"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#a7e18250ed88d997b603b308212eb7362">set_data_ready_event</a> (bool implemented)</td></tr>
<tr class="memdesc:a7e18250ed88d997b603b308212eb7362"><td class="mdescLeft"> </td><td class="mdescRight">Set a flag to indicate that the server fires data ready events. <a href="#a7e18250ed88d997b603b308212eb7362">More...</a><br /></td></tr>
<tr class="separator:a7e18250ed88d997b603b308212eb7362"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff3b774c27e61c3c2ae97ec81c30fcea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTango_1_1Attr.html#aff3b774c27e61c3c2ae97ec81c30fcea">is_data_ready_event</a> ()</td></tr>
<tr class="memdesc:aff3b774c27e61c3c2ae97ec81c30fcea"><td class="mdescLeft"> </td><td class="mdescRight">Check if the data ready event is fired for this attribute. <a href="#aff3b774c27e61c3c2ae97ec81c30fcea">More...</a><br /></td></tr>
<tr class="separator:aff3b774c27e61c3c2ae97ec81c30fcea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>User class to create a no dimension attribute object. </p>
<p>Information from this class and information fetched out from the Tango database allows the Tango core software to create the <a class="el" href="classTango_1_1Attribute.html" title="This class represents a Tango attribute.">Attribute</a> object for the attribute created by the user.</p>
<p>$Author$ $Revision$ </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7333f0eab1956673be866f4c7a2d44e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7333f0eab1956673be866f4c7a2d44e8">◆ </a></span>Attr() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tango::Attr::Attr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>data_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tango::AttrWriteType </td>
<td class="paramname"><em>w_type</em> = <code>Tango::READ</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>assoc</em> = <code>AssocWritNotSpec</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. </p>
<p>The attribute display level is set to OPERATOR.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The attribute name </td></tr>
<tr><td class="paramname">data_type</td><td>The attribute data type </td></tr>
<tr><td class="paramname">w_type</td><td>The attribute type (read, write, read with write ...) </td></tr>
<tr><td class="paramname">assoc</td><td>Name of the associated writable attribute. This is used only the read with write attribute </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad03a6014aeefda86d8ee4d52659a6c39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad03a6014aeefda86d8ee4d52659a6c39">◆ </a></span>Attr() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tango::Attr::Attr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>data_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tango::DispLevel </td>
<td class="paramname"><em>disp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tango::AttrWriteType </td>
<td class="paramname"><em>w_type</em> = <code>Tango::READ</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>assoc</em> = <code>AssocWritNotSpec</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The attribute name </td></tr>
<tr><td class="paramname">data_type</td><td>The attribute data type </td></tr>
<tr><td class="paramname">disp</td><td>The attribute display level </td></tr>
<tr><td class="paramname">w_type</td><td>The attribute type (read, write, read with write ...) </td></tr>
<tr><td class="paramname">assoc</td><td>Name of the associated writable attribute. This is used only the read with write attribute </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad69e9aa5dcd4c22be0509ed72a01cd0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad69e9aa5dcd4c22be0509ed72a01cd0d">◆ </a></span>Attr() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tango::Attr::Attr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tango::DispLevel </td>
<td class="paramname"><em>disp</em> = <code>Tango::OPERATOR</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a newly allocated <a class="el" href="classTango_1_1Attr.html" title="User class to create a no dimension attribute object.">Attr</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The attribute name </td></tr>
<tr><td class="paramname">disp</td><td>The attribute display level </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aff00859f5da6a7f48e7abe079491f12c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff00859f5da6a7f48e7abe079491f12c">◆ </a></span>is_archive_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Tango::Attr::is_archive_event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the archive event is fired manually for this attribute. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean set to true if a manual fire archive event is implemented. </dd></dl>
</div>
</div>
<a id="a9269546f4b25a6395efe8b93bdb8d07f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9269546f4b25a6395efe8b93bdb8d07f">◆ </a></span>is_change_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Tango::Attr::is_change_event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the change event is fired manually for this attribute. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean set to true if a manual fire change event is implemented. </dd></dl>
</div>
</div>
<a id="a8aa3318fe49d403969a59fe000352be8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8aa3318fe49d403969a59fe000352be8">◆ </a></span>is_check_archive_criteria()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Tango::Attr::is_check_archive_criteria </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the archive event criteria should be checked when firing the event manually. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean set to true if a archive event criteria will be checked. </dd></dl>
</div>
</div>
<a id="a3001dc4d14cbdc62a914a15ff3a86e49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3001dc4d14cbdc62a914a15ff3a86e49">◆ </a></span>is_check_change_criteria()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Tango::Attr::is_check_change_criteria </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the change event criteria should be checked when firing the event manually. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean set to true if a change event criteria will be checked. </dd></dl>
</div>
</div>
<a id="aff3b774c27e61c3c2ae97ec81c30fcea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff3b774c27e61c3c2ae97ec81c30fcea">◆ </a></span>is_data_ready_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Tango::Attr::is_data_ready_event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the data ready event is fired for this attribute. </p>
<dl class="section return"><dt>Returns</dt><dd>A boolean set to true if firing data ready event is implemented. </dd></dl>
</div>
</div>
<a id="a6ba7dd409514e938cb2f530b767aa98c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ba7dd409514e938cb2f530b767aa98c">◆ </a></span>set_archive_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_archive_event </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>implemented</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>detect</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a flag to indicate that the server fires archive events manually without the polling to be started for the attribute If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fulfilled. </p>
<p>If detect is set to false the event is fired without checking!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">implemented</td><td>True when the server fires archive events manually. </td></tr>
<tr><td class="paramname">detect</td><td>Triggers the verification of the archive event properties when set to true. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a68801b4629667565b9cceb6fefa413d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68801b4629667565b9cceb6fefa413d7">◆ </a></span>set_change_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_change_event </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>implemented</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>detect</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a flag to indicate that the server fires change events manually without the polling to be started for the attribute. </p>
<p>If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fulfilled. If detect is set to false the event is fired without checking!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">implemented</td><td>True when the server fires change events manually. </td></tr>
<tr><td class="paramname">detect</td><td>Triggers the verification of the change event properties when set to true. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7e18250ed88d997b603b308212eb7362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e18250ed88d997b603b308212eb7362">◆ </a></span>set_data_ready_event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_data_ready_event </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>implemented</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a flag to indicate that the server fires data ready events. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">implemented</td><td>True when the server fires data ready events </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acca03caaac31c20e746a276ab033c174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acca03caaac31c20e746a276ab033c174">◆ </a></span>set_default_properties()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_default_properties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTango_1_1UserDefaultAttrProp.html">UserDefaultAttrProp</a> & </td>
<td class="paramname"><em>prop</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set default attribute properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prop</td><td>The user default property class </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8f841afb6effc8384e49730550261378"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f841afb6effc8384e49730550261378">◆ </a></span>set_disp_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_disp_level </td>
<td>(</td>
<td class="paramtype">Tango::DispLevel </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the attribute display level. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>The attribute display level </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5c1d94ccc3bacb8d728cf836df737889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c1d94ccc3bacb8d728cf836df737889">◆ </a></span>set_memorized_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_memorized_init </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>write_on_init</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the initialisation flag for memorized attributes true = the setpoint value will be written to the attribute on initialisation false = only the attribute setpoint is initialised. </p>
<p>No action is taken on the attribute</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">write_on_init</td><td>If true the setpoint value will be written to the attribute on initialisation </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5d0e17f5a1ce7263482bb3df5090f91d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d0e17f5a1ce7263482bb3df5090f91d">◆ </a></span>set_polling_period()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Tango::Attr::set_polling_period </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>update</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the attribute polling update period. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">update</td><td>The attribute polling period (in mS) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>attrdesc.h</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Tango</b></li><li class="navelem"><a class="el" href="classTango_1_1Attr.html">Attr</a></li>
<li class="footer">Generated on Fri Mar 29 2019 16:53:16 for Tango Core Classes Reference by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>