/usr/include/tango/attribute.h is in libtango8-dev 8.1.2c+dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 | ///=============================================================================
//
// file : Attribute.h
//
// description : Include file for the Attribute classes.
// Two classes are declared in this file :
// The Attribute class
// The WAttribute class
//
// project : TANGO
//
// author(s) : A.Gotz + E.Taurel
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011,2012,2013
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Tango is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Tango. If not, see <http://www.gnu.org/licenses/>.
//
// $Revision: 22370 $
//
//=============================================================================
#ifndef _ATTRIBUTE_H
#define _ATTRIBUTE_H
#include <tango.h>
#include <attrdesc.h>
#include <encoded_attribute.h>
#include <functional>
#include <time.h>
#include <iterator>
#ifdef _TG_WINDOWS_
#include <sys/types.h>
#include <sys/timeb.h>
#endif
namespace Tango
{
//
// Binary function objects to be used by the find_if algorithm.
// The find_if algo. want to have a predicate, this means that the return value
// must be a boolean (R is its name).
// The test is done between a AttrProperty object (name A1) and a string (name A2)
// The find_if algo. needs a unary predicate. This function object is a binary
// function object. It must be used with the bind2nd function adapter
//
template <typename A1, typename A2, typename R>
struct WantedProp : public binary_function<A1,A2,R>
{
R operator() (A1 att,A2 name_str) const
{
return att.get_name() == name_str;
}
};
template <typename A1, typename A2, typename R>
struct WantedAttr : public binary_function<A1,A2,R>
{
R operator() (A1 attr_ptr, A2 name) const
{
string st(name);
if (st.size() != attr_ptr->get_name_size())
return false;
transform(st.begin(),st.end(),st.begin(),::tolower);
return attr_ptr->get_name_lower() == st;
}
};
class AttrProperty;
class DeviceClass;
typedef union _Attr_CheckVal
{
short sh;
DevLong lg;
double db;
float fl;
unsigned short ush;
unsigned char uch;
DevLong64 lg64;
DevULong ulg;
DevULong64 ulg64;
DevState d_sta;
}Attr_CheckVal;
typedef union _Attr_Value
{
DevVarShortArray *sh_seq;
DevVarLongArray *lg_seq;
DevVarFloatArray *fl_seq;
DevVarDoubleArray *db_seq;
DevVarStringArray *str_seq;
DevVarUShortArray *ush_seq;
DevVarBooleanArray *boo_seq;
DevVarCharArray *cha_seq;
DevVarLong64Array *lg64_seq;
DevVarULongArray *ulg_seq;
DevVarULong64Array *ulg64_seq;
DevVarStateArray *state_seq;
DevVarEncodedArray *enc_seq;
}Attr_Value;
typedef struct last_attr_value
{
bool inited;
Tango::AttrQuality quality;
CORBA::Any value;
bool err;
DevFailed except;
AttrValUnion value_4;
} LastAttrValue;
typedef enum prop_type
{
MIN_VALUE = 0,
MAX_VALUE,
MIN_WARNING,
MAX_WARNING,
MIN_ALARM,
MAX_ALARM
} PropType;
class EventSupplier;
//=============================================================================
//
// The Attribute class
//
//
// description : There is one instance of this class for each attribute
// for each device. This class stores the attribute
// properties and the attribute value.
//
//=============================================================================
/**
* This class represents a Tango attribute.
*
* $Author: taurel $
* $Revision: 22370 $
*
* @headerfile tango.h
* @ingroup Server
*/
class Attribute
{
public:
/// @privatesection
enum alarm_flags
{
min_level,
max_level,
rds,
min_warn,
max_warn,
numFlags
};
/// @publicsection
/**@name Constructors
* Miscellaneous constructors */
//@{
/**
* Create a new Attribute object.
*
* @param prop_list The attribute properties list. Each property is an object
* of the AttrProperty class
* @param tmp_attr Temporary attribute object built from user parameters
* @param dev_name The device name
* @param idx The index of the related Attr object in the MultiClassAttribute
* vector of Attr object
*/
Attribute(vector<AttrProperty> &prop_list,Attr &tmp_attr,string &dev_name,long idx);
//@}
/**@name Destructor
* Only one desctructor is defined for this class
*/
//@{
/**
* The attribute desctructor.
*/
virtual ~Attribute() {try{delete ext;}catch(omni_thread_fatal &){}}
//@}
/**@name Check attribute methods
* Miscellaneous method returning boolean flag according to attribute state
*/
//@{
/**
* Check if the attribute has an associated writable attribute.
*
* This method returns a boolean set to true if the attribute has a writable
* attribute associated to it.
*
* @return A boolean set to true if there is an associated writable attribute
*/
bool is_writ_associated();
/**
* Check if the attribute is in minimum alarm condition .
*
* @return A boolean set to true if the attribute is in alarm condition (read
* value below the min. alarm).
*/
bool is_min_alarm() {return alarm.test(min_level);}
/**
* Check if the attribute is in maximum alarm condition .
*
* @return A boolean set to true if the attribute is in alarm condition (read
* value above the max. alarm).
*/
bool is_max_alarm() {return alarm.test(max_level);}
/**
* Check if the attribute is in minimum warning condition .
*
* @return A boolean set to true if the attribute is in warning condition (read
* value below the min. warning).
*/
bool is_min_warning() {return alarm.test(min_warn);}
/**
* Check if the attribute is in maximum warning condition .
*
* @return A boolean set to true if the attribute is in warning condition (read
* value above the max. warning).
*/
bool is_max_warning() {return alarm.test(max_warn);}
/**
* Check if the attribute is in RDS alarm condition .
*
* @return A boolean set to true if the attribute is in RDS condition (Read
* Different than Set).
*/
bool is_rds_alarm() {return alarm.test(rds);}
/**
* Check if the attribute has an alarm defined.
*
* This method returns a set of bits. Each alarm type is defined by one
* bit.
*
* @return A bitset. Each bit is set if the coresponding alarm is on
*/
bitset<numFlags> &is_alarmed() {return alarm_conf;}
/**
* Check if the attribute is polled .
*
* @return A boolean set to true if the attribute is polled.
*/
bool is_polled();
/**
* Check if the attribute read value is below/above the alarm level.
*
* @return A boolean set to true if the attribute is in alarm condition.
* @exception DevFailed If no alarm level is defined.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
bool check_alarm();
//@}
/**@name Get/Set object members.
* These methods allow the external world to get/set DeviceImpl instance
* data members
*/
//@{
/**
* Get the attribute writable type (RO/WO/RW).
*
* @return The attribute write type.
*/
Tango::AttrWriteType get_writable() {return writable;}
/**
* Get attribute name
*
* @return The attribute name
*/
string &get_name() {return name;}
/**
* Get attribute data type
*
* @return The attribute data type
*/
long get_data_type() {return data_type;}
/**
* Get attribute data format
*
* @return The attribute data format
*/
Tango::AttrDataFormat get_data_format() {return data_format;}
/**
* Get name of the associated writable attribute
*
* @return The associated writable attribute name
*/
string &get_assoc_name() {return writable_attr_name;}
/**
* Get index of the associated writable attribute
*
* @return The index in the main attribute vector of the associated writable
* attribute
*/
long get_assoc_ind() {return assoc_ind;}
/**
* Set index of the associated writable attribute
*
* @param val The new index in the main attribute vector of the associated writable
* attribute
*/
void set_assoc_ind(long val) {assoc_ind = val;}
/**
* Get attribute date
*
* @return The attribute date
*/
Tango::TimeVal &get_date() {return when;}
/**
* Set attribute date
*
* @param new_date The attribute date
*/
void set_date(Tango::TimeVal &new_date) {when = new_date;}
#ifdef _TG_WINDOWS_
/**
* Set attribute date
*
* @param The attribute date
*/
void set_date(struct _timeb &t) {when.tv_sec=(long)t.time;when.tv_usec=(t.millitm*1000);when.tv_nsec=0;}
#endif
/**
* Set attribute date
*
* @param t The attribute date
*/
void set_date(struct timeval &t) {when.tv_sec=t.tv_sec;when.tv_usec=t.tv_usec;when.tv_nsec=0;}
/**
* Set attribute date
*
* @param new_date The attribute date
*/
void set_date(time_t new_date) {when.tv_sec=(long)new_date;when.tv_usec=0;when.tv_nsec=0;}
/**
* Get attribute label property
*
* @return The attribute label
*/
string &get_label() {return label;}
/**
* Get attribute data quality
*
* @return The attribute data quality
*/
Tango::AttrQuality &get_quality() {return quality;}
/**
* Set attribute data quality
*
* @param qua The new attribute data quality
* @param send_event Boolean set to true if a change event should be sent
*/
void set_quality(Tango::AttrQuality qua, bool send_event=false);
/**
* Get attribute data size
*
* @return The attribute data size
*/
long get_data_size() {return data_size;}
/**
* Get attribute data size in x dimension
*
* @return The attribute data size in x dimension. Set to 1 for scalar attribute
*/
long get_x() {return dim_x;}
/**
* Get attribute maximum data size in x dimension
*
* @return The attribute maximum data size in x dimension. Set to 1 for scalar attribute
*/
long get_max_dim_x() {return max_x;}
/**
* Get attribute data size in y dimension
*
* @return The attribute data size in y dimension. Set to 0 for scalar and
* spectrum attribute
*/
long get_y() {return dim_y;}
/**
* Get attribute maximum data size in y dimension
*
* @return The attribute maximum data size in y dimension. Set to 0 for scalar and
* spectrum attribute
*/
long get_max_dim_y() {return max_y;}
/**
* Get attribute polling period
*
* @return The attribute polling period in mS. Set to 0 when the attribute is
* not polled
*/
long get_polling_period() {return ext->poll_period;}
/**
* Get all modifiable attribute properties in one call
*
* This method initializes the members of a MultiAttrProp object with the modifiable
* attribute properties values
*
* @param props A MultiAttrProp object.
*/
template <typename T>
void get_properties(Tango::MultiAttrProp<T> &props);
/**
* Set all modifiable attribute properties in one call
*
* This method sets the modifiable attribute properties with the values
* provided as members of MultiAttrProps object
*
* @param props A MultiAttrProp object.
*/
template <typename T>
void set_properties(Tango::MultiAttrProp<T> &props);
/**
* Set attribute serialization model
*
* This method allows the user to choose the attribute serialization
* model.
*
* @param ser_model The new serialisation model. The serialization model must be
* one of ATTR_BY_KERNEL, ATTR_BY_USER or ATTR_NO_SYNC
*/
void set_attr_serial_model(AttrSerialModel ser_model);
/**
* Get attribute serialization model
*
* Get the attribute serialization model
*
* @return The attribute serialization model
*/
AttrSerialModel get_attr_serial_model() {return ext->attr_serial_model;}
/**
* Set attribute user mutex
*
* This method allows the user to give to the attribute object the pointer to
* the omni_mutex used to protect its buffer. The mutex has to be locked when passed
* to this method. The Tango kernel will unlock it when the data will be transferred
* to the client.
*
* @param mut_ptr The user mutex pointer
*/
void set_user_attr_mutex(omni_mutex *mut_ptr) {ext->user_attr_mutex = mut_ptr;}
//@}
/**@name Set attribute value methods.
* These methods allows the external world to set attribute object internal
* value
*/
//@{
/**
* Set internal attribute value (for Tango::DevShort attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevShort *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevLong attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevLong *p_data,long x = 1, long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevLong64 attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevLong64 *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevFloat attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevFloat *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevDouble attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevDouble *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevString attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevString *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevBoolean attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevBoolean *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevUShort attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevUShort *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevUChar attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevUChar *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevULong attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevULong *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevULong64 attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevULong64 *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevState attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevState *p_data,long x = 1,long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevEncoded attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data The attribute read value
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevEncoded *p_data,long x = 1, long y = 0,bool release = false);
/**
* Set internal attribute value (for Tango::DevEncoded attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param p_data_str The attribute string part read value
* @param p_data The attribute raw data part read value
* @param size Size of the attribute raw data part
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::DevString *p_data_str,Tango::DevUChar *p_data,long size,bool release = false);
/**
* Set internal attribute value (for Tango::DevEncoded attribute data type).
*
* This method stores the attribute read value inside the object. This data will be
* returned to the caller. This method also stores the date when it is called
* and initialise the attribute quality factor.
*
* @param attr Handle to EncodedAttribute object
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value(Tango::EncodedAttribute *attr);
//---------------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevShort *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevShort *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevShort *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevLong *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevLong *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevLong *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevLong64 *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevLong64 *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevLong64 *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevFloat *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevFloat *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevFloat *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevDouble *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevDouble *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevDouble *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevString *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevString *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevString *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevBoolean *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevBoolean *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevBoolean *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevUShort *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevUShort *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevUShort *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevUChar *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevUChar *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevUChar *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevULong *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevULong *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevULong *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevULong64 *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevULong64 *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevULong64 *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevState *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevState *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevState *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
#endif
//-----------------------------------------------------------------------
/**
* Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevEncoded *p_data,
time_t t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
/**
* Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type
* when splitted in format and data).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* @param p_data_str The attribute coded format string
* @param p_data The attribute raw data
* @param size Size of the attribute raw data part
* @param t The date
* @param qual The attribute quality factor
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevString *p_data_str,
Tango::DevUChar *p_data,
long size,
time_t t,
Tango::AttrQuality qual,
bool release = false);
#ifdef _TG_WINDOWS_
void set_value_date_quality(Tango::DevEncoded *p_data,
struct _timeb &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
void set_value_date_quality(Tango::DevString *p_data_str,
Tango::DevUChar *p_data,
long size,
struct _timeb &t,
Tango::AttrQuality qual,
bool release = false);
#else
/**
* Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data The attribute read value
* @param t The date
* @param qual The attribute quality factor
* @param x The attribute x length. Default value is 1
* @param y The attribute y length. Default value is 0
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevEncoded *p_data,
struct timeval &t,
Tango::AttrQuality qual,
long x = 1,long y = 0,
bool release = false);
/**
* Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type
* when splitted in data format and data themselves).
*
* This method stores the attribute read value, the date and the attribute
* quality factor inside the object. This data will be
* returned to the caller.
*
* Please note that for Win32 user, the same method is defined using a
* "_timeb" structure instead of a "timeval" structure to set date.
*
* @param p_data_str The attribute format string
* @param p_data The attribute raw data
* @param size Size of the attribute raw data part
* @param t The date
* @param qual The attribute quality factor
* @param release The release flag. If true, memory pointed to by p_data will be
* freed after being send to the client. Default value is false.
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void set_value_date_quality(Tango::DevString *p_data_str,
Tango::DevUChar *p_data,
long size,
struct timeval &t,
Tango::AttrQuality qual,
bool release = false);
#endif
/**
* Fire a change event for the attribute value. The event is pushed to the notification
* daemon.
* The attibute data must be set with one of the Attribute::set_value or
* Attribute::setvalue_date_quality methods before fireing the event.
* The event is triggered with or without the change event criteria depending
* on the configuration choosen with set_change_event().
* ATTENTION: The couple set_value() and fire_change_event() needs to be protected
* against concurrent accesses to the same attribute. Such an access might happen during
* a synchronous read or by a reading from the polling thread.
* Inside all methods reading or writing commands and attributes this protection is
* automatically done by the Tango serialisation monitor.
* When fireing change events in your own code, you should use the push_change_event
* methods of the DeviceImpl class or protect your code with the
* Tango::AutoTangoMonitor on your device.
* Example:
*
* {
* Tango::AutoTangoMonitor synch(this);
* att_temp_seq.set_value (temp_seq, 100);
* att_temp_seq.fire_archive_event ();
* }
*
* @param except A pointer to a DevFailed exception to be thrown as archive event.
*/
void fire_change_event(DevFailed *except = NULL);
/**
* Set a flag to indicate that the server fires change events manually, without
* the polling to be started for the attribute.
* 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 fullfilled.
* If detect is set to false the event is fired without any value checking!
*
* @param implemented True when the server fires change events manually.
* @param detect Triggers the verification of the change event properties when set to true.
*/
void set_change_event(bool implemented, bool detect = true)
{ ext->change_event_implmented = implemented;
ext->check_change_event_criteria = detect;
if(detect==false){
ext->prev_change_event.err=false;
ext->prev_change_event.quality=Tango::ATTR_VALID;}}
/**
* Check if the change event is fired manually (without polling) for this attribute.
*
* @return A boolean set to true if a manual fire change event is implemented.
*/
bool is_change_event() {return ext->change_event_implmented;}
/**
* Check if the change event criteria should be checked when firing
* the event manually.
*
* @return A boolean set to true if a change event criteria will be checked.
*/
bool is_check_change_criteria() {return ext->check_change_event_criteria;}
/**
* Fire an archive event for the attribute value. The event is pushed to the notification
* daemon.
* The attibute data must be set with one of the Attribute::set_value or
* Attribute::setvalue_date_quality methods before fireing the event.
* The event is triggered with or without the archive event criteria depending
* on the configuration choosen with set_archive_event().
* ATTENTION: The couple set_value() and fire_archive_event() needs to be protected
* against concurrent accesses to the same attribute. Such an access might happen during
* a synchronous read or by a reading from the polling thread.
* Inside all methods reading or writing commands and attributes this protection is
* automatically done by the Tango serialisation monitor.
* When fireing archive events in your own code, you should use the push_archive_event
* methods of the DeviceImpl class or protect your code with the
* Tango::AutoTangoMonitor on your device.
* Example:
*
* {
* Tango::AutoTangoMonitor synch(this);
* att_temp_seq.set_value (temp_seq, 100);
* att_temp_seq.fire_archive_event ();
* }
*
* @param except A pointer to a DevFailed exception to be thrown as archive event.
*/
void fire_archive_event(DevFailed *except = NULL);
/**
* 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 fullfilled.
* If detect is set to false the event is fired without any value checking!
*
* @param implemented True when the server fires archive events manually.
* @param detect Triggers the verification of the archive event properties when set to true.
*/
void set_archive_event(bool implemented, bool detect = true)
{ext->archive_event_implmented = implemented;
ext->check_archive_event_criteria = detect;}
/**
* Check if the archive event is fired manually for this attribute.
*
* @return A boolean set to true if a manual fire archive event is implemented.
*/
bool is_archive_event() {return ext->archive_event_implmented;}
/**
* Check if the archive event criteria should be checked when firing
* the event manually.
*
* @return A boolean set to true if a archive event criteria will be checked.
*/
bool is_check_archive_criteria() {return ext->check_archive_event_criteria;}
/**
* Set a flag to indicate that the server fires data ready events
*
* @param implemented True when the server fires change events manually.
*/
void set_data_ready_event(bool implemented) {ext->dr_event_implmented = implemented;}
/**
* Check if the data ready event is fired for this attribute.
*
* @return A boolean set to true if a fire data ready event is implemented.
*/
bool is_data_ready_event() {return ext->dr_event_implmented;}
/**
* Fire a user event for the attribute value. The event is pushed to the notification
* daemon.
* The attibute data must be set with one of the Attribute::set_value or
* Attribute::setvalue_date_quality methods before fireing the event.
* ATTENTION: The couple set_value() and fire_event() needs to be protected
* against concurrent accesses to the same attribute. Such an access might happen during
* a synchronous read or by a reading from the polling thread.
* Inside all methods reading or writing commands and attributes this protection is
* automatically done by the Tango serialisation monitor.
* When fireing archive events in your own code, you should use the push_event
* methods of the DeviceImpl class or protect your code with the
* Tango::AutoTangoMonitor on your device.
* Example:
*
* {
* Tango::AutoTangoMonitor synch(this);
* att_temp_seq.set_value (temp_seq, 100);
* att_temp_seq.fire_event ();
* }
*
* @param filt_names The filterable fields name
* @param filt_vals The filterable fields value (as double)
* @param except A pointer to a DevFailed exception to be thrown as archive event.
*/
void fire_event(vector<string> &filt_names,vector<double> &filt_vals,DevFailed *except = NULL);
/**
* Remove the attribute configuration from the database.
* This method can be used to clean-up all the configuration of an attribute to come back to
* its default values or the remove all configuration of a dynamic attribute before deleting it.
*
* The method removes all configured attribute properties and removes the attribute from the
* list of polled attributes.
*
* @exception DevFailed In case of database access problems.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
void remove_configuration();
//@}
/**@name Set/Get attribute ranges (min_alarm, min_warning, max_warning, max_alarm) methods.
* These methods allow the external world to set attribute object min_alarm, min_warning,
* max_warning and max_alarm values
*/
//@{
/**
* Set attribute minimum alarm.
*
* This method sets the attribute minimum alarm.
*
* @param new_min_alarm The new attribute minimum alarm value
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
template <typename T>
void set_min_alarm(const T &new_min_alarm);
void set_min_alarm(char *new_min_alarm);
void set_min_alarm(const char *new_min_alarm);
/**
* Get attribute minimum alarm or throw an exception if the attribute
* does not have the minimum alarm
*
* @param min_al Reference to a variable which value will be set to the attribute's
* minimum alarm
*/
template <typename T>
void get_min_alarm(T &min_al);
/**
* Set attribute maximum alarm.
*
* This method sets the attribute maximum alarm.
*
* @param new_max_alarm The new attribute maximum alarm value
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
template <typename T>
void set_max_alarm(const T &new_max_alarm);
void set_max_alarm(char *new_max_alarm);
void set_max_alarm(const char *new_max_alarm);
/**
* Get attribute maximum alarm or throw an exception if the attribute
* does not have the maximum alarm set
*
* @param max_al Reference to a variable which value will be set to the attribute's
* maximum alarm
*/
template <typename T>
void get_max_alarm(T &max_al);
/**
* Set attribute minimum warning.
*
* This method sets the attribute minimum warning.
*
* @param new_min_warning The new attribute minimum warning value
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
template <typename T>
void set_min_warning(const T &new_min_warning);
void set_min_warning(char *new_min_warning);
void set_min_warning(const char *new_min_warning);
/**
* Get attribute minimum warning or throw an exception if the attribute
* does not have the minimum warning set
*
* @param min_war Reference to a variable which value will be set to the attribute's
* minimum warning
*/
template <typename T>
void get_min_warning(T &min_war);
/**
* Set attribute maximum warning.
*
* This method sets the attribute maximum warning.
*
* @param new_max_warning The new attribute maximum warning value
* @exception DevFailed If the attribute data type is not coherent.
* Click <a href="../../../tango_idl/idl_html/_Tango.html#DevFailed">here</a> to read
* <b>DevFailed</b> exception specification
*/
template <typename T>
void set_max_warning(const T &new_max_warning);
void set_max_warning(char *new_max_warning);
void set_max_warning(const char *new_max_warning);
/**
* Get attribute maximum warning or throw an exception if the attribute
* does not have the maximum warning set
*
* @param max_war Reference to a variable which value will be set to the attribute's
* maximum warning
*/
template <typename T>
void get_max_warning(T &max_war);
//@}
protected:
/**@name Class data members */
//@{
/**
* A flag set to true if the attribute value has been updated
*/
bool value_flag;
/**
* The date when attribute was read
*/
Tango::TimeVal when;
/**
* Flag set to true if the date must be set
*/
bool date;
/**
* The attribute quality factor
*/
Tango::AttrQuality quality;
/**
* The attribute name
*/
string name;
/**
* The attribute writable flag
*/
Tango::AttrWriteType writable;
/**
* The attribute data type.
*
* Eight types are suported. They are Tango::DevShort, Tango::DevLong,
* Tango::DevDouble, Tango::DevString, Tango::DevUShort, Tango::DevUChar,
* Tango::DevFloat and Tango::DevBoolean
*/
long data_type;
/**
* The attribute data format.
*
* Three data formats are supported. They are SCALAR, SPECTRUM and IMAGE
*/
Tango::AttrDataFormat data_format;
/**
* The attribute maximum x dimension.
*
* It is needed for SPECTRUM or IMAGE data format
*/
long max_x;
/**
* The attribute maximum y dimension.
*
* It is necessary only for IMAGE data format
*/
long max_y;
/**
* The attribute label
*/
string label;
/**
* The attribute description
*/
string description;
/**
* The attribute unit
*/
string unit;
/**
* The attribute standard unit
*/
string standard_unit;
/**
* The attribute display unit
*/
string display_unit;
/**
* The attribute format.
*
* This string specifies how an attribute value must be printed
*/
string format;
/**
* The name of the associated writable attribute
*/
string writable_attr_name;
/**
* The attribute minimum alarm level
*/
string min_alarm_str;
/**
* The attribute maximun alarm level
*/
string max_alarm_str;
/**
* The attribute minimum value
*/
string min_value_str;
/**
* The attribute maximum value
*/
string max_value_str;
/**
* The attribute minimun warning
*/
string min_warning_str;
/**
* The attribute maximum warning
*/
string max_warning_str;
/**
* The attribute delta value RDS alarm
*/
string delta_val_str;
/**
* The attribute delta time RDS alarm
*/
string delta_t_str;
/**
* Index in the main attribute vector of the associated writable attribute (if any)
*/
long assoc_ind;
/**
* The attribute minimum alarm in binary format
*/
Tango::Attr_CheckVal min_alarm;
/**
* The attribute maximum alarm in binary format
*/
Tango::Attr_CheckVal max_alarm;
/**
* The attribute minimum warning in binary format
*/
Tango::Attr_CheckVal min_warning;
/**
* The attribute maximum warning in binary format
*/
Tango::Attr_CheckVal max_warning;
/**
* The attribute minimum value in binary format
*/
Tango::Attr_CheckVal min_value;
/**
* The attribute maximum value in binary format
*/
Tango::Attr_CheckVal max_value;
/**
* The attribute value
*/
Tango::Attr_Value value;
/**
* The attribute data size
*/
long data_size;
/**
* Flag set to true if a minimum value is defined
*/
bool check_min_value;
/**
* Flag set to true if a maximum alarm is defined
*/
bool check_max_value;
/**
* Authorized delta between the last written value and the
* actual read. Used if the attribute has an alarm on
* Read Different Than Set (RDS)
*/
Tango::Attr_CheckVal delta_val;
/**
* Delta time after which the read value must be checked again the
* last written value if the attribute has an alarm on
* Read Different Than Set (RDS)
*/
long delta_t;
//@}
public:
/// @privatesection
//
// methods not usable for the external world (outside the lib)
//
void get_properties(Tango::AttributeConfig &conf);
void get_properties_2(Tango::AttributeConfig_2 &conf);
void get_properties_3(Tango::AttributeConfig_3 &conf);
void set_properties(const Tango::AttributeConfig_3 &conf);
void set_properties(const Tango::AttributeConfig &conf,Tango::DeviceImpl *dev);
void set_properties(const Tango::AttributeConfig_3 &conf,Tango::DeviceImpl *dev);
virtual void set_rvalue() {};
void delete_seq();
bool check_scalar_wattribute();
void wanted_date(bool flag) {date = flag;}
bool get_wanted_date() {return date;}
Tango::TimeVal &get_when() {return when;}
void set_time();
Tango::DevVarShortArray *get_short_value() {return value.sh_seq;}
Tango::DevVarLongArray *get_long_value() {return value.lg_seq;}
Tango::DevVarDoubleArray *get_double_value() {return value.db_seq;}
Tango::DevVarStringArray *get_string_value() {return value.str_seq;}
Tango::DevVarFloatArray *get_float_value() {return value.fl_seq;}
Tango::DevVarBooleanArray *get_boolean_value() {return value.boo_seq;}
Tango::DevVarUShortArray *get_ushort_value() {return value.ush_seq;}
Tango::DevVarCharArray *get_uchar_value() {return value.cha_seq;}
Tango::DevVarLong64Array *get_long64_value() {return value.lg64_seq;}
Tango::DevVarULongArray *get_ulong_value() {return value.ulg_seq;}
Tango::DevVarULong64Array *get_ulong64_value() {return value.ulg64_seq;}
Tango::DevVarStateArray *get_state_value() {return value.state_seq;}
Tango::DevVarEncodedArray *get_encoded_value() {return value.enc_seq;}
Tango::DevLong64 *get_tmp_scalar_long64() {return ext->tmp_lo64;}
Tango::DevULong *get_tmp_scalar_ulong() {return ext->tmp_ulo;}
Tango::DevULong64 *get_tmp_scalar_ulong64() {return ext->tmp_ulo64;}
Tango::DevState *get_tmp_scalar_state() {return ext->tmp_state;}
void add_write_value(Tango::DevVarShortArray *);
void add_write_value(Tango::DevVarLongArray *);
void add_write_value(Tango::DevVarDoubleArray *);
void add_write_value(Tango::DevVarStringArray *);
void add_write_value(Tango::DevVarFloatArray *);
void add_write_value(Tango::DevVarBooleanArray *);
void add_write_value(Tango::DevVarUShortArray *);
void add_write_value(Tango::DevVarCharArray *);
void add_write_value(Tango::DevVarLong64Array *);
void add_write_value(Tango::DevVarULongArray *);
void add_write_value(Tango::DevVarULong64Array *);
void add_write_value(Tango::DevVarStateArray *);
void add_write_value(Tango::DevEncoded &);
unsigned long get_name_size() {return name_size;}
string &get_name_lower() {return name_lower;}
void set_value_flag(bool val) {value_flag = val;}
bool get_value_flag() {return value_flag;}
DispLevel get_disp_level() {return ext->disp_level;}
omni_mutex *get_attr_mutex() {return &(ext->attr_mutex);}
omni_mutex *get_user_attr_mutex() {return ext->user_attr_mutex;}
void set_properties(const Tango::AttributeConfig &,string &);
void set_properties(const Tango::AttributeConfig_3 &,string &);
void upd_database(const Tango::AttributeConfig &,string &);
void upd_database(const Tango::AttributeConfig_3 &,string &);
void set_upd_properties(const Tango::AttributeConfig_3 &);
void set_upd_properties(const Tango::AttributeConfig_3 &,string &);
bool change_event_subscribed() {if (ext->event_change_subscription != 0)return true;else return false;}
bool periodic_event_subscribed() {if (ext->event_periodic_subscription != 0)return true;else return false;}
bool archive_event_subscribed() {if (ext->event_archive_subscription != 0)return true;else return false;}
bool quality_event_subscribed() {if (ext->event_quality_subscription != 0)return true;else return false;}
bool user_event_subscribed() {if (ext->event_user_subscription != 0)return true;else return false;}
bool use_notifd_event() {return ext->notifd_event;}
bool use_zmq_event() {return ext->zmq_event;}
void set_change_event_sub() {ext->event_change_subscription=time(NULL);}
void set_periodic_event_sub() {ext->event_periodic_subscription=time(NULL);}
void set_archive_event_sub() {ext->event_archive_subscription=time(NULL);}
void set_quality_event_sub() {ext->event_quality_subscription=time(NULL);}
void set_user_event_sub() {ext->event_user_subscription=time(NULL);}
void set_use_notifd_event() {ext->notifd_event = true;}
void set_use_zmq_event() {ext->zmq_event = true;}
long get_attr_idx() {return ext->idx_in_attr;}
void set_attr_idx(long new_idx) {ext->idx_in_attr=new_idx;}
DeviceImpl *get_att_device();
void Attribute_2_AttributeValue(Tango::AttributeValue_3 *,DeviceImpl *);
void Attribute_2_AttributeValue(Tango::AttributeValue_4 *,DeviceImpl *);
void AttributeValue_4_2_AttributeValue_3(const Tango::AttributeValue_4 *,Tango::AttributeValue_3 *);
void set_mcast_event(vector<string> &vs) {ext->mcast_event.clear();copy(vs.begin(),vs.end(),back_inserter(ext->mcast_event));}
bool is_polled(DeviceImpl *);
void set_polling_period(long per) {ext->poll_period = per;}
void save_alarm_quality() {ext->old_quality=quality;ext->old_alarm=alarm;}
bool is_startup_exception() {return ext->check_startup_exceptions;}
void throw_startup_exception(const char*);
bool is_mem_exception() {return ext->mem_exception;}
#ifndef TANGO_HAS_LOG4TANGO
friend ostream &operator<<(ostream &,Attribute &);
#endif // TANGO_HAS_LOG4TANGO
friend class EventSupplier;
friend class ZmqEventSupplier;
friend class DServer;
private:
void set_data_size();
void throw_min_max_value(string &,string &,MinMaxValueCheck);
void check_str_prop(const AttributeConfig &,DbData &,long &,DbData &,long &,vector<AttrProperty> &,vector<AttrProperty> &);
void log_quality();
void event_prop_db(const char *,vector<double> &,vector<double> &,DbData &,long &,DbData &,long &);
unsigned long name_size;
string name_lower;
DevEncoded enc_help;
protected:
/// @privatesection
//
// The extension class
//
class AttributeExt
{
public:
AttributeExt() : poll_period(0),event_period(0),archive_period(0),
last_periodic(0.0),archive_last_periodic(0.0),periodic_counter(0),
archive_periodic_counter(0),archive_last_event(0.0),
dev(NULL),change_event_implmented(false),archive_event_implmented(false),
check_change_event_criteria(true),check_archive_event_criteria(true),
event_periodic_client_3(false),event_change_client_3(false),event_archive_client_3(false),
event_user_client_3(false),user_attr_mutex(NULL),dr_event_implmented(false),
scalar_str_attr_release(false),notifd_event(false),zmq_event(false),
check_startup_exceptions(false), startup_exceptions_clear(true),
mem_exception(false)
{}
Tango::DispLevel disp_level; // Display level
long poll_period; // Polling period
double rel_change[2]; // Delta for relative change events in %
double abs_change[2]; // Delta for absolute change events
double archive_rel_change[2]; // Delta for relative archive change events in %
double archive_abs_change[2]; // Delta for absolute change events
int event_period; // Delta for periodic events in ms
int archive_period; // Delta for archive periodic events in ms
double last_periodic; // Last time a periodic event was detected
double archive_last_periodic; // Last time an archive periodic event was detected
long periodic_counter; // Number of periodic events sent so far
long archive_periodic_counter; // Number of periodic events sent so far
LastAttrValue prev_change_event; // Last change attribute
LastAttrValue prev_quality_event; // Last quality attribute
LastAttrValue prev_archive_event; // Last archive attribute
time_t event_change_subscription; // Last time() a subscription was made
time_t event_quality_subscription; // Last time() a subscription was made
time_t event_periodic_subscription; // Last time() a subscription was made
time_t event_archive_subscription; // Last time() a subscription was made
time_t event_user_subscription; // Last time() a subscription was made
time_t event_attr_conf_subscription; // Last time() a subscription was made
time_t event_data_ready_subscription; // Last time() a subscription was made
double archive_last_event; // Last time an archive event was detected (periodic or not)
long idx_in_attr; // Index in MultiClassAttribute vector
string d_name; // The device name
DeviceImpl *dev; // The device object
bool change_event_implmented; // Flag true if a manual fire change event is implemented.
bool archive_event_implmented; // Flag true if a manual fire archive event is implemented.
bool check_change_event_criteria; // True if change event criteria should be checked when sending the event
bool check_archive_event_criteria; // True if archive event criteria should be checked when sending the event
bool event_periodic_client_3; // True if at least one periodic event client is using IDL 3
bool event_change_client_3; // True if at least one periodic event client is using IDL 3
bool event_archive_client_3; // True if at least one periodic event client is using IDL 3
bool event_user_client_3; // True if at least one periodic event client is using IDL 3
Tango::DevLong64 tmp_lo64[2];
Tango::DevULong tmp_ulo[2];
Tango::DevULong64 tmp_ulo64[2];
Tango::DevState tmp_state[2];
omni_mutex attr_mutex; // Mutex to protect the attributes shared data buffer
omni_mutex *user_attr_mutex; // Ptr for user mutex in case he manages exclusion
AttrSerialModel attr_serial_model; // Flag for attribute serialization model
bool dr_event_implmented; // Flag true if fire data ready event is implemented
bool scalar_str_attr_release; // Need memory freeing (scalar string attr, R/W att)
bool notifd_event; // Set to true if event required using notifd
bool zmq_event; // Set to true if event required using ZMQ
vector<string> mcast_event; // In case of multicasting used for event transport
AttrQuality old_quality; // Previous attribute quality
bitset<numFlags> old_alarm; // Previous attribute alarm
map<string,const DevFailed> startup_exceptions; // Map containing exceptions related to attribute configuration raised during the server startup sequence
bool check_startup_exceptions; // Flag set to true if there is at least one exception in startup_exceptions map
bool startup_exceptions_clear; // Flag set to true when the cause for the device startup exceptions has been fixed
bool mem_exception; // Flag set to true if the attribute is writable and
// memorized and if it failed at init
};
AttributeExt *ext;
virtual void init_opt_prop(vector<AttrProperty> &prop_list,string &dev_name);
virtual void init_event_prop(vector<AttrProperty> &prop_list,const string &dev_name,Attr &att);
string &get_attr_value(vector<AttrProperty> &prop_list,const char *name);
long get_lg_attr_value(vector<AttrProperty> &prop_list,const char *name);
virtual bool check_rds_alarm() {return false;}
bool check_level_alarm();
bool check_warn_alarm();
void upd_att_prop_db(Tango::Attr_CheckVal &,const char *);
DeviceClass *get_att_device_class(string &);
template <typename T>
void check_hard_coded_properties(const T &);
void add_startup_exception(string,const DevFailed &);
void delete_startup_exception(string);
void throw_hard_coded_prop(const char *);
void throw_err_format(const char *,const string &,const char *);
void throw_incoherent_val_err(const char *,const char *,const string &,const char *);
void throw_err_data_type(const char *,const string &,const char *);
void validate_change_properties(const string &,const char *,string &,vector<double> &,vector<bool> &,vector<bool> &);
void validate_change_properties(const string &,const char *,string &,vector<double> &);
bool prop_in_list(const char *,string &,size_t,vector<AttrProperty> &);
void set_format_notspec();
bool is_format_notspec(const char *);
void def_format_in_dbdatum(DbDatum &);
void avns_in_db(const char *,string &);
void avns_in_att(prop_type);
bitset<numFlags> alarm_conf;
bitset<numFlags> alarm;
long dim_x;
long dim_y;
Tango::DevShort tmp_sh[2];
Tango::DevLong tmp_lo[2];
Tango::DevFloat tmp_fl[2];
Tango::DevDouble tmp_db[2];
Tango::DevString tmp_str[2];
Tango::DevUShort tmp_ush[2];
Tango::DevBoolean tmp_boo[2];
Tango::DevUChar tmp_cha[2];
Tango::DevEncoded tmp_enc[2];
vector<AttrProperty>::iterator pos_end;
};
//
// Some inline methods
//
//+-------------------------------------------------------------------------
//
// method : Attribute::throw_hard_coded_prop
//
// description : Throw a "Hard coded properties can't be changed" exception
//
// args: in : - prop_name : The name of the property which should be modified
//
//--------------------------------------------------------------------------
inline void Attribute::throw_hard_coded_prop(const char *prop_name)
{
TangoSys_OMemStream desc;
desc << "Attribute property " << prop_name << " is not changeable at run time" << ends;
Except::throw_exception((const char *)API_AttrNotAllowed,desc.str(),
(const char *)"Attribute::check_hard_coded_properties()");
}
//+-------------------------------------------------------------------------
//
// method : Attribute::throw_startup_exception
//
// description : Throw a startup exception
//
// args: in : - origin : The method name where this method is called from
//
//--------------------------------------------------------------------------
inline void Attribute::throw_startup_exception(const char* origin)
{
if(ext->check_startup_exceptions)
{
string err_msg;
vector<string> event_exceptions;
vector<string> opt_exceptions;
for(map<string,const DevFailed>::iterator it = ext->startup_exceptions.begin(); it != ext->startup_exceptions.end(); ++it)
{
if(it->first == "event_period" || it->first == "archive_period" || it->first == "rel_change" || it->first == "abs_change" || it->first == "archive_rel_change" || it->first == "archive_abs_change")
event_exceptions.push_back(it->first);
else
opt_exceptions.push_back(it->first);
for(CORBA::ULong i = 0 ; i < it->second.errors.length(); i++)
{
string tmp_msg = string(it->second.errors[i].desc);
size_t pos = tmp_msg.rfind('\n');
if(pos != string::npos)
tmp_msg.erase(0,pos+1);
err_msg += "\n" + tmp_msg;
}
}
err_msg = "\nDevice " + ext->d_name + "-> Attribute : " + name + err_msg;
if(event_exceptions.size() == ext->startup_exceptions.size())
{
if(event_exceptions.size() == 1)
err_msg += "\nSetting a valid value (also 'NaN', 'Not specified' and '' - empty string) for any property for this attribute will automatically bring the above-mentioned property to its library defaults";
else
err_msg += "\nSetting a valid value (also 'NaN', 'Not specified' and '' - empty string) for any property for this attribute will automatically bring the above-listed properties to their library defaults";
}
else if(event_exceptions.empty() == false)
{
if(opt_exceptions.size() == 1)
err_msg += "\nSetting valid value (also 'NaN', 'Not specified' and '' - empty string) for " + opt_exceptions[0] + " ";
else
{
err_msg += "\nSetting valid values (also 'NaN', 'Not specified' and '' - empty string) for ";
for(size_t i = 0; i < opt_exceptions.size(); i++)
err_msg += ((i == (opt_exceptions.size() - 1) && i != 0) ? "and " : "") + opt_exceptions[i] + ((i != (opt_exceptions.size() - 1) && i != (opt_exceptions.size() - 2)) ? "," : "") + " ";
}
err_msg += "will automatically bring ";
for(size_t i = 0; i < event_exceptions.size(); i++)
err_msg += ((i == (event_exceptions.size() - 1) && i != 0) ? "and " : "") + event_exceptions[i] + ((i != (event_exceptions.size() - 1) && i != (event_exceptions.size() - 2)) ? "," : "") + " ";
if(event_exceptions.size() == 1)
err_msg += "to its library defaults";
else
err_msg += "to their library defaults";
}
err_msg += "\nHint : Check also class level attribute properties";
Except::throw_exception(API_AttrConfig,err_msg,origin);
}
}
//+-------------------------------------------------------------------------
//
// method : Attribute::prop_in_list
//
// description : Search for a property in a list
//
// args: in : - prop_name : The property name
// - list_size : The size list
// - list : The list
// out : - prop_str : String initialized with prop. value (if found)
//
//--------------------------------------------------------------------------
inline bool Attribute::prop_in_list(const char *prop_name,string &prop_str,size_t list_size,vector<AttrProperty> &list)
{
bool ret = false;
if (list_size != 0)
{
size_t i;
for (i = 0;i < list_size;i++)
{
if (list[i].get_name() == prop_name)
break;
}
if (i != list_size)
{
prop_str = list[i].get_value();
ret = true;
}
}
return ret;
}
//
// Macro to help coding
//
#define MEM_STREAM_2_CORBA(A,B) \
if (true) \
{ \
string s = B.str(); \
A = CORBA::string_dup(s.c_str()); \
B.str(""); \
B.clear(); \
} \
else \
(void)0
//
// Throw exception if pointer is null
//
#define CHECK_PTR(A,B) \
if (A == NULL) \
{ \
TangoSys_OMemStream o; \
o << "Data pointer for attribute " << B << " is NULL!" << ends; \
Except::throw_exception((const char *)API_AttrOptProp,o.str(), \
(const char *)"Attribute::set_value()"); \
} \
else \
(void)0
//
// Define one macro to make code more readable
// but this macro is nearly unreadable !!!
//
// Arg list :
// A : property as a string
// B : stream
// C : device name
// D : DbData for db update
// E : DbData for db delete
// F : Number of prop to update
// G : Number of prop to delete
// H : Property name
// I : Default user properties vector ref
// J : Default class properties vector ref
//
// Too many parameters ?
//
// Comment 1: If the user input value is equal to user default value do not store it in
// the database.
//
// Comment 2: User default value (if defined) has to be converted to double before it is
// compared with the user input to determine if to store the new value in the database.
// String comparison is not appropriate in case of floating point numbers,
// e.g. "5.0" is numerically equal to "5.00" but the strings differ.
//
// Comment 3: If user defaults are defined - at first place the input string is converted
// to double to determine if it is a number. If so, the double value is cast to the type
// corresponding with the type of the attribute and further compared with the double
// representation of the user default value.
// The purpose of casting is as follows.
// Lets take an example of an attribute of DevShort data type with user default value for
// min_alarm set to 5. Now, if the user inputs "5.678" as a new value for min_alarm
// it would normally be cast to DevShort and stored in the database as "5" (this is the
// standard behaviour if the user inputs a floating point value for a property of
// non-floating point type). But now the outcome "5" is equal to the user default value 5
// and should not be stored in the database. This is why there is the cast of the user
// input value to the attribute data type before comparison with the user default value.
//
#define CHECK_PROP(A,B,C,D,E,F,G,H,I,J) \
{ \
size_t nb_user = I.size(); \
size_t nb_class = J.size(); \
string usr_def_val; \
string class_def_val; \
bool user_defaults = false; \
bool class_defaults = false; \
bool store_in_db = true; \
bool avns = false; \
bool user_val = false; \
double user_def_val_db; \
double class_def_val_db; \
bool equal_user_def = false; \
bool equal_class_def = false; \
\
user_defaults = prop_in_list(H,usr_def_val,nb_user,I); \
if (user_defaults) \
{ \
B.str(""); \
B.clear(); \
B << usr_def_val; \
B >> user_def_val_db; \
} \
class_defaults = prop_in_list(H,class_def_val,nb_class,J); \
if (class_defaults) \
{ \
B.str(""); \
B.clear(); \
B << class_def_val; \
B >> class_def_val_db; \
} \
\
if(user_defaults) \
{ \
double db; \
B.str(""); \
B.clear(); \
B << A; \
if (B >> db && B.eof()) \
{ \
switch (data_type) \
{ \
case Tango::DEV_SHORT: \
if((DevShort)db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_LONG: \
if((DevLong)db == user_def_val_db) \
equal_user_def = true; \
break;\
\
case Tango::DEV_LONG64: \
if((DevLong64)db == user_def_val_db) \
equal_user_def = true; \
break;\
\
case Tango::DEV_DOUBLE: \
if(db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_FLOAT: \
if(db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_USHORT: \
if((DevUShort)db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_UCHAR: \
if((DevUChar)db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_ULONG: \
if((DevULong)db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_ULONG64: \
if((DevULong64)db == user_def_val_db) \
equal_user_def = true; \
break; \
\
case Tango::DEV_ENCODED: \
if((DevUChar)db == user_def_val_db) \
equal_user_def = true; \
break; \
} \
}\
}\
\
if(class_defaults) \
{ \
double db; \
B.str(""); \
B.clear(); \
B << A; \
if (B >> db && B.eof()) \
{ \
switch (data_type) \
{ \
case Tango::DEV_SHORT: \
if((DevShort)db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_LONG: \
if((DevLong)db == class_def_val_db) \
equal_class_def = true; \
break;\
\
case Tango::DEV_LONG64: \
if((DevLong64)db == class_def_val_db) \
equal_class_def = true; \
break;\
\
case Tango::DEV_DOUBLE: \
if(db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_FLOAT: \
if(db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_USHORT: \
if((DevUShort)db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_UCHAR: \
if((DevUChar)db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_ULONG: \
if((DevULong)db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_ULONG64: \
if((DevULong64)db == class_def_val_db) \
equal_class_def = true; \
break; \
\
case Tango::DEV_ENCODED: \
if((DevUChar)db == class_def_val_db) \
equal_class_def = true; \
break; \
} \
}\
}\
\
if (TG_strcasecmp(A,AlrmValueNotSpec) == 0) \
{ \
if (user_defaults == true || class_defaults == true) \
{ \
store_in_db = true; \
avns = true; \
} \
else \
{ \
store_in_db = false; \
} \
} \
else if (strlen(A) == 0) \
{ \
if (class_defaults == true) \
{ \
store_in_db = true; \
if (user_defaults) \
user_val = true; \
else \
avns = true; \
} \
else \
{ \
store_in_db = false; \
} \
} \
else if (TG_strcasecmp(A,NotANumber) == 0) \
{ \
store_in_db = false; \
} \
else if (user_defaults == true && equal_user_def == true) \
{ \
if (class_defaults == true) \
{ \
store_in_db = true; \
user_val = true; \
} \
else \
{ \
store_in_db = false; \
} \
} \
else if (class_defaults == true && equal_class_def == true) \
{ \
store_in_db = false; \
} \
else \
{ \
store_in_db = true; \
} \
\
if(store_in_db) \
{ \
string tmp = A.in(); \
if(user_val == true) \
tmp = usr_def_val.c_str(); \
else if(avns == true) \
tmp = AlrmValueNotSpec; \
else \
{ \
if ((data_type != Tango::DEV_STRING) && \
(data_type != Tango::DEV_BOOLEAN) && \
(data_type != Tango::DEV_STATE)) \
{ \
double db; \
\
B.str(""); \
B.clear(); \
B << A; \
if (!(B >> db && B.eof())) \
{ \
throw_err_format(H,C,"Attribute::upd_database"); \
}\
switch (data_type) \
{ \
case Tango::DEV_SHORT: \
B.str(""); \
B.clear(); \
B << (DevShort)db; \
break; \
\
case Tango::DEV_LONG: \
B.str(""); \
B.clear(); \
B << (DevLong)db; \
break;\
\
case Tango::DEV_LONG64: \
B.str(""); \
B.clear(); \
B << (DevLong64)db; \
break;\
\
case Tango::DEV_DOUBLE: \
break; \
\
case Tango::DEV_FLOAT: \
break; \
\
case Tango::DEV_USHORT: \
B.str(""); \
B.clear(); \
(db < 0.0) ? B << (DevUShort)(-db) : B << (DevUShort)db; \
break; \
\
case Tango::DEV_UCHAR: \
B.str(""); \
B.clear(); \
(db < 0.0) ? B << (short)((DevUChar)(-db)) : B << (short)((DevUChar)db); \
break; \
\
case Tango::DEV_ULONG: \
B.str(""); \
B.clear(); \
(db < 0.0) ? B << (DevULong)(-db) : B << (DevULong)db; \
break; \
\
case Tango::DEV_ULONG64: \
B.str(""); \
B.clear(); \
(db < 0.0) ? B << (DevULong64)(-db) : B << (DevULong64)db; \
break; \
} \
if (data_type != Tango::DEV_FLOAT && data_type != Tango::DEV_DOUBLE) \
tmp = B.str(); \
} \
else \
{ \
throw_err_data_type(H,C,"Attribute::upd_database"); \
} \
} \
\
DbDatum dd(H); \
dd << tmp.c_str(); \
D.push_back(dd); \
F++; \
} \
else \
{ \
DbDatum del_dd(H); \
E.push_back(del_dd); \
G++; \
} \
} \
//
// Yet another macros !!
// Arg list : A : The sequence pointer
// B : Index in sequence
// C : Attribute reference
//
#define GIVE_ATT_MUTEX(A,B,C) \
if (true) \
{\
Tango::AttributeValue_4 *tmp_ptr = &((*A)[B]); \
(tmp_ptr)->set_attr_mutex(C.get_attr_mutex()); \
} \
else \
(void)0
#define GIVE_USER_ATT_MUTEX(A,B,C) \
if (true) \
{ \
Tango::AttributeValue_4 *tmp_ptr = &((*A)[B]); \
(tmp_ptr)->set_attr_mutex(C.get_user_attr_mutex()); \
} \
else \
(void)0
//
// Yet another macro !!
// Arg list : A : The sequence pointer
// B : Index in sequence
// C : Attribute reference
//
#define REL_ATT_MUTEX(A,B,C) \
if (C.get_attr_serial_model() != ATTR_NO_SYNC) \
{ \
Tango::AttributeValue_4 *tmp_ptr = &((*A)[B]); \
(tmp_ptr)->rel_attr_mutex(); \
} \
else \
(void)0
// Add template methods definitions
} // End of Tango namespace
#endif // _ATTRIBUTE_H
|