/usr/lib/python2.7/dist-packages/pyvisa/attributes.py is in python-pyvisa 1.8-2.
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 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 | # -*- coding: utf-8 -*-
"""
pyvisa.attributes
~~~~~~~~~~~~~~~~~
Comprehensive of all properties.
This file is part of PyVISA.
:copyright: 2014 by PyVISA Authors, see AUTHORS for more details.
:license: MIT, see LICENSE for more details.
"""
from __future__ import division, unicode_literals, print_function, absolute_import
from collections import defaultdict
from .compat import with_metaclass
from . import constants
#: Not available value.
NotAvailable = object()
#: Attribute for all session types.
AllSessionTypes = object()
#: Map resource to attribute
AttributesPerResource = defaultdict(set)
AttributesByID = dict()
class AttributeType(type):
"""Base Type for Attributes
Assigns the `attribute_id` and improves the documentation.
"""
def __init__(cls, name, bases, dct):
super(AttributeType, cls).__init__(name, bases, dct)
if not name.startswith('AttrVI_'):
return
cls.attribute_id = getattr(constants, cls.visa_name)
cls.redoc()
if cls.resources is AllSessionTypes:
AttributesPerResource[AllSessionTypes].add(cls)
else:
for res in cls.resources:
AttributesPerResource[res].add(cls)
AttributesByID[cls.attribute_id] = cls
class Attribute(with_metaclass(AttributeType)):
"""Base class for Attributes to be used as Properties.
"""
#: List of resource types with this attribute.
#: each element is a tuple (constants.InterfaceType, str)
resources = []
#: Name of the Python property to be matched to this attribute.
py_name = 'To be specified'
#: Name of the VISA Attribute
visa_name = 'To be specified'
#: Numeric constant of the VISA Attribute
attribute_id = 0
#: Default value fo the VISA Attribute
default = 'N/A'
#: Access
read, write, local = False, False, False
@classmethod
def redoc(cls):
cls.__doc__ += '\n:VISA Attribute: %s (%s)' % (cls.visa_name,
cls.attribute_id)
def post_get(self, value):
"""Override this method to check or modify the value returned by the VISA function.
:param value: the value returned by the VISA library.
:return: the equivalent python value.
"""
return value
def pre_set(self, value):
"""Override this method to check or modify the value to be passed to the VISA function.
:param value: the python value to be passed to VISA library.
:return: the equivalent value.
"""
return value
def __get__(self, instance, owner):
if instance is None:
return self
if not self.read:
raise AttributeError("can't read attribute")
return self.post_get(instance.get_visa_attribute(self.attribute_id))
def __set__(self, instance, value):
if not self.write:
raise AttributeError("can't write attribute")
instance.set_visa_attribute(self.attribute_id, self.pre_set(value))
@classmethod
def in_resource(cls, session_type):
"""Returns True if the attribute is part of a given session type.
The session_type is a tuple with the interface type and resource_class
:type session_type: (constants.InterfaceType, str)
:rtype: bool
"""
if cls.resources is AllSessionTypes:
return True
return session_type in cls.resources
class EnumAttribute(Attribute):
"""Class for attributes with values that map to a PyVISA Enum.
"""
#: Enum type with valid values.
enum_type = None
@classmethod
def redoc(cls):
super(EnumAttribute, cls).redoc()
cls.__doc__ += '\n:type: :class:%s.%s' % (cls.enum_type.__module__,
cls.enum_type.__name__)
def post_get(self, value):
return self.enum_type(value)
def pre_set(self, value):
if value not in self.enum_type:
raise ValueError('%r is an invalid value for attribute %s, '
'should be a %r' % (value,
self.visa_name,
self.enum_type))
return value
class IntAttribute(Attribute):
"""Class for attributes with integers values.
"""
@classmethod
def redoc(cls):
super(IntAttribute, cls).redoc()
cls.__doc__ += '\n:type: int'
def post_get(self, value):
return int(value)
class RangeAttribute(IntAttribute):
"""Class for integer attributes with values within a range.
"""
#: Range for the value, and iterable of extra values.
min_value, max_value, values = None, None, []
@classmethod
def redoc(cls):
super(RangeAttribute, cls).redoc()
cls.__doc__ += '\n:range: %s <= value <= %s' % (cls.min_value,
cls.max_value)
if cls.values:
cls.__doc__ += ' or in %s' % cls.values
def pre_set(self, value):
if not self.min_value <= value <= self.max_value:
if not self.values:
raise ValueError('%r is an invalid value for attribute %s, '
'should be between %r and %r' % (
value,
self.visa_name,
self.min_value,
self.max_value))
elif value not in self.values:
raise ValueError('%r is an invalid value for attribute %s, '
'should be between %r and %r or %r' % (
value,
self.visa_name,
self.min_value,
self.max_value,
self.values))
return value
class ValuesAttribute(Attribute):
"""Class for attributes with values in a list.
"""
#: Valid values
values = []
@classmethod
def redoc(cls):
super(ValuesAttribute, cls).redoc()
cls.__doc__ += '\n:values: %s' % cls.values
def pre_set(self, value):
if value not in self.values:
raise ValueError('%r is an invalid value for attribute %s, '
'should be in %s' % (value,
self.visa_name,
self.values))
return value
class BooleanAttribute(Attribute):
"""Class for attributes with boolean values.
"""
@classmethod
def redoc(cls):
super(BooleanAttribute, cls).redoc()
cls.__doc__ += '\n:type: bool'
def post_get(self, value):
return value == constants.VI_TRUE
def pre_set(self, value):
return constants.VI_TRUE if value else constants.VI_FALSE
class CharAttribute(Attribute):
"""Class for attributes with char values.
"""
@classmethod
def redoc(cls):
super(CharAttribute, cls).redoc()
cls.__doc__ += '\n:range: 0 <= x <= 255\n:type: int'
def post_get(self, value):
return chr(value)
def pre_set(self, value):
return ord(value)
# noinspection PyPep8Naming
class AttrVI_ATTR_4882_COMPLIANT(BooleanAttribute):
"""VI_ATTR_4882_COMPLIANT specifies whether the device is 488.2
compliant.
"""
resources = [(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = 'is_4882_compliant'
visa_name = 'VI_ATTR_4882_COMPLIANT'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_ALLOW_TRANSMIT(BooleanAttribute):
"""If set to VI_FALSE, it suspends transmission as if an XOFF character
has been received. If set to VI_TRUE, it resumes transmission as
if an XON character has been received.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'allow_transmit'
visa_name = 'VI_ATTR_ASRL_ALLOW_TRANSMIT'
visa_type = 'ViBoolean'
default = True
read, write, local = True, True, False
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_AVAIL_NUM(RangeAttribute):
"""VI_ATTR_ASRL_AVAIL_NUM shows the number of bytes available in the low-
level I/O receive buffer.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'bytes_in_buffer'
visa_name = 'VI_ATTR_ASRL_AVAIL_NUM'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFFFFFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_BAUD(RangeAttribute):
"""VI_ATTR_ASRL_BAUD is the baud rate of the interface. It is represented
as an unsigned 32-bit integer so that any baud rate can be used,
but it usually requires a commonly used rate such as 300, 1200,
2400, or 9600 baud.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'baud_rate'
visa_name = 'VI_ATTR_ASRL_BAUD'
visa_type = 'ViUInt32'
default = 9600
read, write, local = True, True, False
min_value, max_value, values = 0, 0xFFFFFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_BREAK_LEN(RangeAttribute):
"""This controls the duration (in milliseconds) of the break signal
asserted when VI_ATTR_ASRL_END_OUT is set to VI_ASRL_END_BREAK. If
you want to control the assertion state and length of a break
signal manually, use the VI_ATTR_ASRL_BREAK_STATE attribute
instead.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'break_length'
visa_name = 'VI_ATTR_ASRL_BREAK_LEN'
visa_type = 'ViInt16'
default = 250
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_BREAK_STATE(EnumAttribute):
"""If set to VI_STATE_ASSERTED, it suspends character transmission and
places the transmission line in a break state until this attribute
is reset to VI_STATE_UNASSERTED. This attribute lets you manually
control the assertion state and length of a break signal. If you
want VISA to send a break signal after each write operation
automatically, use the VI_ATTR_ASRL_BREAK_LEN and
VI_ATTR_ASRL_END_OUT attributes instead.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'break_state'
visa_name = 'VI_ATTR_ASRL_BREAK_STATE'
visa_type = 'ViInt16'
default = constants.LineState.unasserted
read, write, local = True, True, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_CONNECTED(BooleanAttribute):
"""VI_ATTR_ASRL_CONNECTED indicates whether the port is properly
connected to another port or device. This attribute is valid only
with serial drivers developed by National Instruments and
documented to support this feature with the corresponding National
Instruments hardware.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_CONNECTED'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_CTS_STATE(EnumAttribute):
"""VI_ATTR_ASRL_CTS_STATE shows the current state of the Clear To Send
(CTS) input signal.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_CTS_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_DATA_BITS(RangeAttribute):
"""VI_ATTR_ASRL_DATA_BITS is the number of data bits contained in each
frame (from 5 to 8). The data bits for each frame are located in
the low-order bits of every byte stored in memory.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'data_bits'
visa_name = 'VI_ATTR_ASRL_DATA_BITS'
visa_type = 'ViUInt16'
default = 8
read, write, local = True, True, False
min_value, max_value, values = 5, 8, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_DCD_STATE(EnumAttribute):
"""VI_ATTR_ASRL_DCD_STATE represents the current state of the Data
Carrier Detect (DCD) input signal. The DCD signal is often used by
modems to indicate the detection of a carrier (remote modem) on
the telephone line. The DCD signal is also known as Receive Line
Signal Detect (RLSD). This attribute is Read Only except when the
VI_ATTR_ASRL_WIRE_MODE attribute is set to VI_ASRL_WIRE_232_DCE,
or VI_ASRL_WIRE_232_AUTO with the hardware currently in the DCE
state.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_DCD_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_DISCARD_NULL(BooleanAttribute):
"""If set to VI_TRUE, NUL characters are discarded. Otherwise, they are
treated as normal data characters. For binary transfers, set this
attribute to VI_FALSE.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'discard_null'
visa_name = 'VI_ATTR_ASRL_DISCARD_NULL'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, False
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_DSR_STATE(EnumAttribute):
"""VI_ATTR_ASRL_DSR_STATE shows the current state of the Data Set Ready
(DSR) input signal.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_DSR_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_DTR_STATE(EnumAttribute):
"""VI_ATTR_ASRL_DTR_STATE shows the current state of the Data Terminal
Ready (DTR) input signal.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_DTR_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_END_IN(EnumAttribute):
"""VI_ATTR_ASRL_END_IN indicates the method used to terminate read
operations.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'end_input'
visa_name = 'VI_ATTR_ASRL_END_IN'
visa_type = 'ViUInt16'
default = constants.SerialTermination.termination_char
read, write, local = True, True, True
enum_type = constants.SerialTermination
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_END_OUT(EnumAttribute):
"""VI_ATTR_ASRL_END_OUT indicates the method used to terminate write
operations.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_END_OUT'
visa_type = 'ViUInt16'
default = constants.SerialTermination.none
read, write, local = True, True, True
enum_type = constants.SerialTermination
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_FLOW_CNTRL(RangeAttribute):
"""VI_ATTR_ASRL_FLOW_CNTRL indicates the type of flow control used by the
transfer mechanism.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'flow_control'
visa_name = 'VI_ATTR_ASRL_FLOW_CNTRL'
visa_type = 'ViUInt16'
default = constants.VI_ASRL_FLOW_NONE
read, write, local = True, True, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_PARITY(EnumAttribute):
"""VI_ATTR_ASRL_PARITY is the parity used with every frame transmitted
and received.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'parity'
visa_name = 'VI_ATTR_ASRL_PARITY'
visa_type = 'ViUInt16'
default = constants.Parity.none
read, write, local = True, True, False
enum_type = constants.Parity
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_REPLACE_CHAR(RangeAttribute):
"""VI_ATTR_ASRL_REPLACE_CHAR specifies the character to be used to
replace incoming characters that arrive with errors (such as
parity error).
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'replace_char'
visa_name = 'VI_ATTR_ASRL_REPLACE_CHAR'
visa_type = 'ViUInt8'
default = 0
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_RI_STATE(EnumAttribute):
"""VI_ATTR_ASRL_RI_STATE represents the current state of the Ring
Indicator (RI) input signal. The RI signal is often used by modems
to indicate that the telephone line is ringing. This attribute is
Read Only except when the VI_ATTR_ASRL_WIRE_MODE attribute is set
to VI_ASRL_WIRE_232_DCE, or VI_ASRL_WIRE_232_AUTO with the
hardware currently in the DCE state.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_RI_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_RTS_STATE(EnumAttribute):
"""VI_ATTR_ASRL_RTS_STATE is used to manually assert or unassert the
Request To Send (RTS) output signal.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_RTS_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_STOP_BITS(EnumAttribute):
"""VI_ATTR_ASRL_STOP_BITS is the number of stop bits used to indicate the
end of a frame. The value VI_ASRL_STOP_ONE5 indicates one-and-one-
half (1.5) stop bits.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'stop_bits'
visa_name = 'VI_ATTR_ASRL_STOP_BITS'
visa_type = 'ViUInt16'
default = constants.StopBits.one
read, write, local = True, True, False
enum_type = constants.StopBits
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_WIRE_MODE(RangeAttribute):
"""
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_ASRL_WIRE_MODE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_XOFF_CHAR(RangeAttribute):
"""VI_ATTR_ASRL_XOFF_CHAR specifies the value of the XOFF character used
for XON/XOFF flow control (both directions). If XON/XOFF flow
control (software handshaking) is not being used, the value of
this attribute is ignored.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'xoff_char'
visa_name = 'VI_ATTR_ASRL_XOFF_CHAR'
visa_type = 'ViUInt8'
default = 0x13
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_ASRL_XON_CHAR(RangeAttribute):
"""VI_ATTR_ASRL_XON_CHAR specifies the value of the XON character used
for XON/XOFF flow control (both directions). If XON/XOFF flow
control (software handshaking) is not being used, the value of
this attribute is ignored.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR')]
py_name = 'xon_char'
visa_name = 'VI_ATTR_ASRL_XON_CHAR'
visa_type = 'ViUInt8'
default = 0x11
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFF, []
# Could not generate class for VI_ATTR_BUFFER.html
# Exception:
"""
'list' object has no attribute 'startswith'
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_CMDR_LA(RangeAttribute):
"""VI_ATTR_CMDR_LA is the unique logical address of the commander of the
VXI device used by the given session.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_CMDR_LA'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 255, [constants.VI_UNKNOWN_LA]
# noinspection PyPep8Naming
class AttrVI_ATTR_DEST_ACCESS_PRIV(RangeAttribute):
"""VI_ATTR_DEST_ACCESS_PRIV specifies the address modifier to be used in
high-level access operations, such as viOutXX() and viMoveOutXX(),
when writing to the destination.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_DEST_ACCESS_PRIV'
visa_type = 'ViUInt16'
default = constants.VI_DATA_PRIV
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_DEST_BYTE_ORDER(RangeAttribute):
"""VI_ATTR_DEST_BYTE_ORDER specifies the byte order to be used in high-
level access operations, such as viOutXX() and viMoveOutXX(), when
writing to the destination.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_DEST_BYTE_ORDER'
visa_type = 'ViUInt16'
default = constants.VI_BIG_ENDIAN
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_DEST_INCREMENT(RangeAttribute):
"""VI_ATTR_DEST_INCREMENT is used in the viMoveOutXX() operations to
specify by how many elements the destination offset is to be
incremented after every transfer. The default value of this
attribute is 1 (that is, the destination address will be
incremented by 1 after each transfer), and the viMoveOutXX()
operations move into consecutive elements. If this attribute is
set to 0, the viMoveOutXX() operations will always write to the
same element, essentially treating the destination as a FIFO
register.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'MEMACC'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = 'destination_increment'
visa_name = 'VI_ATTR_DEST_INCREMENT'
visa_type = 'ViInt32'
default = 1
read, write, local = True, True, True
min_value, max_value, values = 0, 1, []
# noinspection PyPep8Naming
class AttrVI_ATTR_DEV_STATUS_BYTE(RangeAttribute):
"""This attribute specifies the 488-style status byte of the local
controller or device associated with this session.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_DEV_STATUS_BYTE'
visa_type = 'ViUInt8'
default = NotAvailable
read, write, local = True, True, False
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_DMA_ALLOW_EN(BooleanAttribute):
"""This attribute specifies whether I/O accesses should use DMA (VI_TRUE)
or Programmed I/O (VI_FALSE). In some implementations, this
attribute may have global effects even though it is documented to
be a local attribute. Since this affects performance and not
functionality, that behavior is acceptable.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = 'allow_dma'
visa_name = 'VI_ATTR_DMA_ALLOW_EN'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, True, True
# Could not generate class for VI_ATTR_EVENT_TYPE.html
# Exception:
"""
Unknown type: ViEventType. Range: [u'0h to FFFFFFFFh']
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_FDC_CHNL(RangeAttribute):
"""VI_ATTR_FDC_CHNL determines which Fast Data Channel (FDC) will be used
to transfer the buffer.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_FDC_CHNL'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = 0, 7, []
# noinspection PyPep8Naming
class AttrVI_ATTR_FDC_MODE(RangeAttribute):
"""VI_ATTR_FDC_MODE specifies which Fast Data Channel (FDC) mode to use
(either normal or stream mode).
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_FDC_MODE'
visa_type = 'ViUInt16'
default = constants.VI_FDC_NORMAL
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_FDC_USE_PAIR(BooleanAttribute):
"""Setting VI_ATTR_FDC_USE_PAIR to VI_TRUE specifies to use a channel
pair for transferring data. Otherwise, only one channel will be
used.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_FDC_USE_PAIR'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_FILE_APPEND_EN(BooleanAttribute):
"""This attribute specifies whether viReadToFile() will overwrite
(truncate) or append when opening a file.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_FILE_APPEND_EN'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_ADDR_STATE(EnumAttribute):
"""This attribute shows whether the specified GPIB interface is currently
addressed to talk or listen, or is not addressed.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'address_state'
visa_name = 'VI_ATTR_GPIB_ADDR_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.AddressState
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_ATN_STATE(EnumAttribute):
"""This attribute shows the current state of the GPIB ATN (ATtentioN)
interface line.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'atn_state'
visa_name = 'VI_ATTR_GPIB_ATN_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_CIC_STATE(BooleanAttribute):
"""This attribute shows whether the specified GPIB interface is currently
CIC (Controller In Charge).
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'is_controller_in_charge'
visa_name = 'VI_ATTR_GPIB_CIC_STATE'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_HS488_CBL_LEN(RangeAttribute):
"""This attribute specifies the total number of meters of GPIB cable used
in the specified GPIB interface.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = ''
visa_name = 'VI_ATTR_GPIB_HS488_CBL_LEN'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, False
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_NDAC_STATE(EnumAttribute):
"""This attribute shows the current state of the GPIB NDAC (Not Data
ACcepted) interface line.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'ndac_state'
visa_name = 'VI_ATTR_GPIB_NDAC_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_PRIMARY_ADDR(RangeAttribute):
"""VI_ATTR_GPIB_PRIMARY_ADDR specifies the primary address of the GPIB
device used by the given session. For the GPIB INTFC Resource,
this attribute is Read-Write.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'primary_address'
visa_name = 'VI_ATTR_GPIB_PRIMARY_ADDR'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, True, False
min_value, max_value, values = 0, 30, []
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_READDR_EN(BooleanAttribute):
"""VI_ATTR_GPIB_READDR_EN specifies whether to use repeat addressing
before each read or write operation.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR')]
py_name = 'enable_repeat_addressing'
visa_name = 'VI_ATTR_GPIB_READDR_EN'
visa_type = 'ViBoolean'
default = True
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_REN_STATE(EnumAttribute):
"""VI_ATTR_GPIB_REN_STATE returns the current state of the GPIB REN
(Remote ENable) interface line.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'remote_enabled'
visa_name = 'VI_ATTR_GPIB_REN_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_SECONDARY_ADDR(RangeAttribute):
"""VI_ATTR_GPIB_SECONDARY_ADDR specifies the secondary address of the
GPIB device used by the given session. For the GPIB INTFC
Resource, this attribute is Read-Write.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'secondary_address'
visa_name = 'VI_ATTR_GPIB_SECONDARY_ADDR'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, True, False
min_value, max_value, values = 0, 30, [constants.VI_NO_SEC_ADDR]
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_SRQ_STATE(EnumAttribute):
"""This attribute shows the current state of the GPIB SRQ (Service
ReQuest) interface line.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = ''
visa_name = 'VI_ATTR_GPIB_SRQ_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_SYS_CNTRL_STATE(BooleanAttribute):
"""This attribute shows whether the specified GPIB interface is currently
the system controller. In some implementations, this attribute may
be modified only through a configuration utility. On these systems
this attribute is read-only (RO).
"""
resources = [(constants.InterfaceType.gpib, 'INTFC')]
py_name = 'is_system_controller'
visa_name = 'VI_ATTR_GPIB_SYS_CNTRL_STATE'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, True, False
# noinspection PyPep8Naming
class AttrVI_ATTR_GPIB_UNADDR_EN(BooleanAttribute):
"""VI_ATTR_GPIB_UNADDR_EN specifies whether to unaddress the device (UNT
and UNL) after each read or write operation.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR')]
py_name = 'enable_unaddressing'
visa_name = 'VI_ATTR_GPIB_UNADDR_EN'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_IMMEDIATE_SERV(BooleanAttribute):
"""VI_ATTR_IMMEDIATE_SERV specifies whether the device associated with
this session is an immediate servant of the controller running
VISA.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_IMMEDIATE_SERV'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_INTF_INST_NAME(Attribute):
"""VI_ATTR_INTF_INST_NAME specifies human-readable text that describes
the given interface.
"""
resources = AllSessionTypes
py_name = ''
visa_name = 'VI_ATTR_INTF_INST_NAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_INTF_NUM(RangeAttribute):
"""VI_ATTR_INTF_NUM specifies the board number for the given interface.
"""
resources = AllSessionTypes
py_name = 'interface_number'
visa_name = 'VI_ATTR_INTF_NUM'
visa_type = 'ViUInt16'
default = 0
read, write, local = True, False, False
min_value, max_value, values = 0x0, 0xFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_INTF_TYPE(RangeAttribute):
"""VI_ATTR_INTF_TYPE specifies the interface type of the given session.
"""
resources = AllSessionTypes
py_name = ''
visa_name = 'VI_ATTR_INTF_TYPE'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_IO_PROT(RangeAttribute):
"""VI_ATTR_IO_PROT specifies which protocol to use. In VXI, you can
choose normal word serial or fast data channel (FDC). In GPIB, you
can choose normal or high-speed (HS-488) transfers. In serial,
TCPIP, or USB RAW, you can choose normal transfers or
488.2-defined strings. In USB INSTR, you can choose normal or
vendor-specific transfers.
"""
resources = [(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = 'io_protocol'
visa_name = 'VI_ATTR_IO_PROT'
visa_type = 'ViUInt16'
default = constants.VI_PROT_NORMAL
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_MAINFRAME_LA(RangeAttribute):
"""VI_ATTR_MA.infRAME_LA specifies the lowest logical address in the
mainframe. If the logical address is not known, VI_UNKNOWN_LA is
returned.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_MAINFRAME_LA'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 255, [constants.VI_UNKNOWN_LA]
# noinspection PyPep8Naming
class AttrVI_ATTR_MANF_ID(RangeAttribute):
"""VI_ATTR_MANF_ID is the manufacturer identification number of the
device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = 'manufacturer_id'
visa_name = 'VI_ATTR_MANF_ID'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0x0, 0xFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_MANF_NAME(Attribute):
"""This string attribute is the manufacturer name.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'BACKPLANE'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = 'manufacturer_name'
visa_name = 'VI_ATTR_MANF_NAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_MAX_QUEUE_LENGTH(RangeAttribute):
"""VI_ATTR_MAX_QUEUE_LENGTH specifies the maximum number of events that
can be queued at any time on the given session. Events that occur
after the queue has become full will be discarded.
"""
resources = AllSessionTypes
py_name = ''
visa_name = 'VI_ATTR_MAX_QUEUE_LENGTH'
visa_type = 'ViUInt32'
default = 50
read, write, local = True, True, True
min_value, max_value, values = 0x1, 0xFFFFFFFF, []
# Could not generate class for VI_ATTR_MEM_BASE.html
# Exception:
"""
Unknown type: VI_ATTR_MEM_BASE:
ViBusAddress
VI_ATTR_MEM_BASE_32:
ViUInt32
VI_ATTR_MEM_BASE_64:
ViUInt64. Range: [u'VI_ATTR_MEM_BASE:', u'0h to FFFFFFFFh for 32\u2011bit applications', u'0h to FFFFFFFFFFFFFFFFh for 64\u2011bit applications', u'VI_ATTR_MEM_BASE_32:', u'0h to FFFFFFFFh', u'VI_ATTR_MEM_BASE_64:', u'0h to FFFFFFFFFFFFFFFFh']
"""
# Could not generate class for VI_ATTR_MEM_SIZE.html
# Exception:
"""
Unknown type: VI_ATTR_MEM_SIZE:
ViBusSize
VI_ATTR_MEM_SIZE_32:
ViUInt32
VI_ATTR_MEM_SIZE_64:
ViUInt64. Range: [u'VI_ATTR_MEM_SIZE:', u'0h to FFFFFFFFh for 32\u2011bit applications', u'0h to FFFFFFFFFFFFFFFFh for 64\u2011bit applications', u'VI_ATTR_MEM_SIZE_32:', u'0h to FFFFFFFFh', u'VI_ATTR_MEM_SIZE_64:', u'0h to FFFFFFFFFFFFFFFFh']
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_MEM_SPACE(RangeAttribute):
"""VI_ATTR_MEM_SPACE specifies the VXIbus address space used by the
device. The three types are A16, A24, or A32 memory address space.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_MEM_SPACE'
visa_type = 'ViUInt16'
default = constants.VI_A16_SPACE
read, write, local = True, False, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_MODEL_CODE(RangeAttribute):
"""VI_ATTR_MODEL_CODE specifies the model code for the device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = 'model_code'
visa_name = 'VI_ATTR_MODEL_CODE'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0x0, 0xFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_MODEL_NAME(Attribute):
"""This string attribute is the model name of the device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'BACKPLANE'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = 'model_name'
visa_name = 'VI_ATTR_MODEL_NAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_ACTUAL_LWIDTH(ValuesAttribute):
"""VI_ATTR_PXI_ACTUAL_LWIDTH specifies the PCI Express link width
negotiated between the PCI Express host controller and the device.
A value of –1 indicates that the device is not a PXI/PCI Express
device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_ACTUAL_LWIDTH'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
values = [-1, 1, 2, 4, 8, 16]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_BUS_NUM(RangeAttribute):
"""VI_ATTR_PXI_BUS_NUM specifies the PCI bus number of this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_BUS_NUM'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 255, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_CHASSIS(RangeAttribute):
"""VI_ATTR_PXI_CHASSIS specifies the PXI chassis number of this device. A
value of –1 means the chassis number is unknown.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_PXI_CHASSIS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 255, [-1]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_DEST_TRIG_BUS(RangeAttribute):
"""VI_ATTR_PXI_DEST_TRIG_BUS specifies the segment to use to qualify
trigDest in viMapTrigger.
"""
resources = [(constants.InterfaceType.pxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_PXI_DEST_TRIG_BUS'
visa_type = 'ViInt16'
default = -1
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_DEV_NUM(RangeAttribute):
"""This is the PXI device number.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_DEV_NUM'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 31, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_DSTAR_BUS(RangeAttribute):
"""VI_ATTR_PXI_DSTAR_BUS specifies the differential star bus number of
this device. A value of –1 means the chassis is unidentified or
does not have a timing slot.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_DSTAR_BUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_DSTAR_SET(RangeAttribute):
"""
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_DSTAR_SET'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 16, [-1]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_FUNC_NUM(RangeAttribute):
"""This is the PCI function number of the PXI/PCI resource. For most
devices, the function number is 0, but a multifunction device may
have a function number up to 7. The meaning of a function number
other than 0 is device specific.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_FUNC_NUM'
visa_type = 'ViUInt16'
default = 0
read, write, local = True, False, False
min_value, max_value, values = 0, 7, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_IS_EXPRESS(BooleanAttribute):
"""VI_ATTR_PXI_IS_EXPRESS specifies whether the device is PXI/PCI or
PXI/PCI Express.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_IS_EXPRESS'
visa_type = 'ViBoolean'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_MAX_LWIDTH(ValuesAttribute):
"""VI_ATTR_PXI_MAX_LWIDTH specifies the maximum PCI Express link width of
the device. A value of –1 indicates that the device is not a
PXI/PCI Express device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_MAX_LWIDTH'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
values = [-1, 1, 2, 4, 8, 16]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_MEM_BASE_BARX(RangeAttribute):
"""PXI memory base address assigned to the specified BAR. If the value of
the corresponding VI_ATTR_PXI_MEM_TYPE_BARx is VI_PXI_ADDR_NONE,
the value of this attribute is meaningless for the given PXI
device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_MEM_BASE_BARX'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFFFFFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_MEM_SIZE_BARX(RangeAttribute):
"""Memory size used by the device in the specified BAR. If the value of
the corresponding VI_ATTR_PXI_MEM_TYPE_BARx is VI_PXI_ADDR_NONE,
the value of this attribute is meaningless for the given PXI
device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_MEM_SIZE_BARX'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFFFFFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_MEM_TYPE_BARX(RangeAttribute):
"""Memory type used by the device in the specified BAR (if applicable).
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_MEM_TYPE_BARX'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_SLOT_LBUS_LEFT(RangeAttribute):
"""VI_ATTR_PXI_SLOT_LBUS_LEFT specifies the slot number or special
feature connected to the local bus left lines of this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_SLOT_LBUS_LEFT'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 1, 18, [constants.VI_PXI_LBUS_UNKNOWN,
constants.VI_PXI_LBUS_NONE,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_0,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_1,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_2,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_3,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_4,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_5,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_6,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_7,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_8,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_9,
constants.VI_PXI_STAR_TRIG_CONTROLLER,
constants.VI_PXI_LBUS_SCXI]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_SLOT_LBUS_RIGHT(RangeAttribute):
"""VI_ATTR_PXI_SLOT_LBUS_RIGHT specifies the slot number or special
feature connected to the local bus right lines of this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_SLOT_LBUS_RIGHT'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 1, 18, [constants.VI_PXI_LBUS_UNKNOWN,
constants.VI_PXI_LBUS_NONE,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_0,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_1,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_2,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_3,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_4,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_5,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_6,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_7,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_8,
constants.VI_PXI_LBUS_STAR_TRIG_BUS_9,
constants.VI_PXI_STAR_TRIG_CONTROLLER,
constants.VI_PXI_LBUS_SCXI]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_SLOT_LWIDTH(ValuesAttribute):
"""VI_ATTR_PXI_SLOT_LWIDTH specifies the PCI Express link width of the
PXI Express peripheral slot in which the device resides. A value
of –1 indicates that the device is not a PXI Express device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_SLOT_LWIDTH'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
values = [-1, 1, 4, 8]
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_SLOTPATH(Attribute):
"""VI_ATTR_PXI_SLOTPATH specifies the slot path of this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_SLOTPATH'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_SRC_TRIG_BUS(RangeAttribute):
"""VI_ATTR_PXI_SRC_TRIG_BUS specifies the segment to use to qualify
trigSrc in viMapTrigger.
"""
resources = [(constants.InterfaceType.pxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_PXI_SRC_TRIG_BUS'
visa_type = 'ViInt16'
default = -1
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_STAR_TRIG_BUS(RangeAttribute):
"""VI_ATTR_PXI_STAR_TRIG_BUS specifies the star trigger bus number of
this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_STAR_TRIG_BUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_STAR_TRIG_LINE(RangeAttribute):
"""VI_ATTR_PXI_STAR_TRIG_LINE specifies the PXI_STAR line connected to
this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_PXI_STAR_TRIG_LINE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_PXI_TRIG_BUS(RangeAttribute):
"""VI_ATTR_PXI_TRIG_BUS specifies the trigger bus number of this device.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_PXI_TRIG_BUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RD_BUF_OPER_MODE(RangeAttribute):
"""VI_ATTR_RD_BUF_OPER_MODE specifies the operational mode of the
formatted I/O read buffer. When the operational mode is set to
VI_FLUSH_DISABLE (default), the buffer is flushed only on explicit
calls to viFlush(). If the operational mode is set to
VI_FLUSH_ON_ACCESS, the read buffer is flushed every time a
viScanf() (or related) operation completes.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_RD_BUF_OPER_MODE'
visa_type = 'ViUInt16'
default = constants.VI_FLUSH_DISABLE
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RD_BUF_SIZE(RangeAttribute):
"""This is the current size of the formatted I/O input buffer for this
session. The user can modify this value by calling viSetBuf().
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_RD_BUF_SIZE'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, True
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RM_SESSION(RangeAttribute):
"""This is the current size of the formatted I/O input buffer for this
session. The user can modify this value by calling viSetBuf().
Not implemented as resource property, use .resource_manager.session
"""
resources = AllSessionTypes
# See docstring
py_name = ''
visa_name = 'VI_ATTR_RM_SESSION'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, True
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_CLASS(Attribute):
"""VI_ATTR_RSRC_CLASS specifies the resource class (for example, "INSTR")
as defined by the canonical resource name.
"""
resources = AllSessionTypes
py_name = 'resource_class'
visa_name = 'VI_ATTR_RSRC_CLASS'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_IMPL_VERSION(RangeAttribute):
"""VI_ATTR_RSRC_IMPL_VERSION is the resource version that uniquely identifies
each of the different revisions or implementations of a resource. This
attribute value is defined by the individual manufacturer and increments
with each new revision. The format of the value has the upper 12 bits as
the major number of the version, the next lower 12 bits as the minor number
of the version, and the lowest 8 bits as the sub-minor number of the version.
"""
resources = AllSessionTypes
py_name = 'implementation_version'
visa_name = 'VI_ATTR_RSRC_IMPL_VERSION'
visa_type = 'ViVersion'
default = NotAvailable
read, write, local = True, False, True
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_LOCK_STATE(EnumAttribute):
"""VI_ATTR_RSRC_LOCK_STATE indicates the current locking state of the
resource. The resource can be unlocked, locked with an exclusive
lock, or locked with a shared lock.
"""
resources = AllSessionTypes
py_name = 'lock_state'
visa_name = 'VI_ATTR_RSRC_LOCK_STATE'
visa_type = 'ViAccessMode'
default = constants.VI_NO_LOCK
read, write, local = True, False, False
enum_type = constants.AccessModes
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_MANF_ID(RangeAttribute):
"""VI_ATTR_RSRC_MANF_ID is a value that corresponds to the VXI manufacturer
ID of the vendor that implemented the VISA library. This attribute is not
related to the device manufacturer attributes.
"""
resources = AllSessionTypes
py_name = ''
visa_name = 'VI_ATTR_RSRC_MANF_ID'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0x3FFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_MANF_NAME(Attribute):
"""VI_ATTR_RSRC_MANF_NAME is a string that corresponds to the manufacturer
name of the vendor that implemented the VISA library. This attribute is not
related to the device manufacturer attributes.
Note The value of this attribute is for display purposes only and not for
programmatic decisions, as the value can differ between VISA implementations
and/or revisions.
"""
resources = AllSessionTypes
py_name = 'resource_manufacturer_name'
visa_name = 'VI_ATTR_RSRC_MANF_NAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_NAME(Attribute):
"""VI_ATTR_RSRC_MANF_NAME is a string that corresponds to the manufacturer
name of the vendor that implemented the VISA library. This attribute is not
related to the device manufacturer attributes.
Note The value of this attribute is for display purposes only and not for
programmatic decisions, as the value can differ between VISA implementations
and/or revisions.
"""
resources = AllSessionTypes
py_name = 'resource_name'
visa_name = 'VI_ATTR_RSRC_NAME'
visa_type = 'ViRsrc'
default = NotAvailable
read, write, local = True, False, False
# noinspection PyPep8Naming
class AttrVI_ATTR_RSRC_SPEC_VERSION(RangeAttribute):
"""VI_ATTR_RSRC_SPEC_VERSION is the resource version that uniquely identifies
the version of the VISA specification to which the implementation is compliant.
The format of the value has the upper 12 bits as the major number of the version,
the next lower 12 bits as the minor number of the version, and the lowest 8 bits
as the sub-minor number of the version. The current VISA specification defines
the value to be 00300000h.
"""
resources = AllSessionTypes
py_name = 'spec_version'
visa_name = 'VI_ATTR_RSRC_SPEC_VERSION'
visa_type = 'ViVersion'
default = 0x00300000
read, write, local = True, False, True
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_SEND_END_EN(BooleanAttribute):
"""VI_ATTR_SEND_END_EN specifies whether to assert END during the
transfer of the last byte of the buffer.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = 'send_end'
visa_name = 'VI_ATTR_SEND_END_EN'
visa_type = 'ViBoolean'
default = True
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_SLOT(RangeAttribute):
"""VI_ATTR_SLOT specifies the physical slot location of the device. If
the slot number is not known, VI_UNKNOWN_SLOT is returned.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_SLOT'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
# [u'VXI', u'0 to 12', u'VI_UNKNOWN_SLOT (\u20131)', u'PXI', u'1 to 18', u'VI_UNKNOWN_SLOT (\u20131)'], ValueError('too many values to unpack',)
# noinspection PyPep8Naming
class AttrVI_ATTR_SRC_ACCESS_PRIV(RangeAttribute):
"""VI_ATTR_SRC_ACCESS_PRIV specifies the address modifier to be used in
high-level access operations, such as viInXX() and viMoveInXX(),
when reading from the source.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_SRC_ACCESS_PRIV'
visa_type = 'ViUInt16'
default = constants.VI_DATA_PRIV
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_SRC_BYTE_ORDER(RangeAttribute):
"""VI_ATTR_SRC_BYTE_ORDER specifies the byte order to be used in high-
level access operations, such as viInXX() and viMoveInXX(), when
reading from the source.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_SRC_BYTE_ORDER'
visa_type = 'ViUInt16'
default = constants.VI_BIG_ENDIAN
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_SRC_INCREMENT(RangeAttribute):
"""VI_ATTR_SRC_INCREMENT is used in the viMoveInXX() operations to
specify by how many elements the source offset is to be
incremented after every transfer. The default value of this
attribute is 1 (that is, the source address will be incremented by
1 after each transfer), and the viMoveInXX() operations move from
consecutive elements. If this attribute is set to 0, the
viMoveInXX() operations will always read from the same element,
essentially treating the source as a FIFO register.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'MEMACC'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = 'source_increment'
visa_name = 'VI_ATTR_SRC_INCREMENT'
visa_type = 'ViInt32'
default = 1
read, write, local = True, True, True
min_value, max_value, values = 0, 1, []
# noinspection PyPep8Naming
class AttrVI_ATTR_SUPPRESS_END_EN(BooleanAttribute):
"""VI_ATTR_SUPPRESS_END_EN is relevant only in viRead and related
operations.
"""
resources = [(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_SUPPRESS_END_EN'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_ADDR(Attribute):
"""This is the TCPIP address of the device to which the session is
connected. This string is formatted in dot notation.
"""
resources = [(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_ADDR'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_DEVICE_NAME(Attribute):
"""This specifies the LAN device name used by the VXI-11 or LXI protocol
during connection.
"""
resources = [(constants.InterfaceType.tcpip, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_DEVICE_NAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_HOSTNAME(Attribute):
"""This specifies the host name of the device. If no host name is
available, this attribute returns an empty string.
"""
resources = [(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_HOSTNAME'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_KEEPALIVE(BooleanAttribute):
"""Setting this attribute to TRUE requests that a TCP/IP provider enable
the use of keep-alive packets on TCP connections. After the system
detects that a connection was dropped, VISA returns a lost
connection error code on subsequent I/O calls on the session. The
time required for the system to detect that the connection was
dropped is dependent on the system and is not settable.
"""
resources = [(constants.InterfaceType.tcpip, 'SOCKET')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_KEEPALIVE'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_NODELAY(BooleanAttribute):
"""The Nagle algorithm is disabled when this attribute is enabled (and
vice versa). The Nagle algorithm improves network performance by
buffering "send" data until a full-size packet can be sent. This
attribute is enabled by default in VISA to verify that synchronous
writes get flushed immediately.
"""
resources = [(constants.InterfaceType.tcpip, 'SOCKET')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_NODELAY'
visa_type = 'ViBoolean'
default = True
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_TCPIP_PORT(RangeAttribute):
"""This specifies the port number for a given TCPIP address. For a TCPIP
SOCKET Resource, this is a required part of the address string.
"""
resources = [(constants.InterfaceType.tcpip, 'SOCKET')]
py_name = ''
visa_name = 'VI_ATTR_TCPIP_PORT'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_TERMCHAR(RangeAttribute):
"""VI_ATTR_TERMCHAR is the termination character. When the termination
character is read and VI_ATTR_TERMCHAR_EN is enabled during a read
operation, the read operation terminates.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_TERMCHAR'
visa_type = 'ViUInt8'
default = 0x0A # (linefeed)
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_TERMCHAR_EN(BooleanAttribute):
"""VI_ATTR_TERMCHAR_EN is a flag that determines whether the read
operation should terminate when a termination character is
received. This attribute is ignored if VI_ATTR_ASRL_END_IN is set
to VI_ASRL_END_TERMCHAR. This attribute is valid for both raw I/O
(viRead) and formatted I/O (viScanf).
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_TERMCHAR_EN'
visa_type = 'ViBoolean'
default = False
read, write, local = True, True, True
# noinspection PyPep8Naming
class AttrVI_ATTR_TMO_VALUE(RangeAttribute):
"""VI_ATTR_TMO_VALUE specifies the minimum timeout value to use (in
milliseconds) when accessing the device associated with the given
session. A timeout value of VI_TMO_IMMEDIATE means that operations
should never wait for the device to respond. A timeout value of
VI_TMO_INFINITE disables the timeout mechanism.
"""
resources = AllSessionTypes
py_name = ''
visa_name = 'VI_ATTR_TMO_VALUE'
visa_type = 'ViUInt32'
default = 2000
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFFFFFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_TRIG_ID(ValuesAttribute):
"""VI_ATTR_TRIG_ID is the identifier for the current triggering
mechanism.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'BACKPLANE'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.vxi, 'BACKPLANE'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_TRIG_ID'
visa_type = 'ViInt16'
default = constants.VI_TRIG_SW
read, write, local = True, True, True
values = [] #TODO
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_ALT_SETTING(RangeAttribute):
"""VI_ATTR_USB_ALT_SETTING specifies the USB alternate setting used by
this USB interface.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_ALT_SETTING'
visa_type = 'ViInt16'
default = 0
read, write, local = True, True, False
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_BULK_IN_PIPE(RangeAttribute):
"""VI_ATTR_USB_BULK_IN_PIPE specifies the endpoint address of the USB
bulk-in pipe used by the given session. An initial value of -1
signifies that this resource does not have any bulk-in pipes. This
endpoint is used in viRead and related operations.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_BULK_IN_PIPE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = 0x81, 0x8F, [-1]
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_BULK_IN_STATUS(RangeAttribute):
"""VI_ATTR_USB_BULK_IN_STATUS specifies whether the USB bulk-in pipe used
by the given session is stalled or ready. This attribute can be
set to only VI_USB_PIPE_READY.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_BULK_IN_STATUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_BULK_OUT_PIPE(RangeAttribute):
"""VI_ATTR_USB_BULK_OUT_PIPE specifies the endpoint address of the USB
bulk-out or interrupt-out pipe used by the given session. An
initial value of –1 signifies that this resource does not have any
bulk-out or interrupt-out pipes. This endpoint is used in viWrite
and related operations.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_BULK_OUT_PIPE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = 0x01, 0x0F, [-1]
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_BULK_OUT_STATUS(RangeAttribute):
"""VI_ATTR_USB_BULK_OUT_STATUS specifies whether the USB bulk-out or
interrupt-out pipe used by the given session is stalled or ready.
This attribute can be set to only VI_USB_PIPE_READY.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_BULK_OUT_STATUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_CLASS(RangeAttribute):
"""VI_ATTR_USB_CLASS specifies the USB class used by this USB interface.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_CLASS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_CTRL_PIPE(RangeAttribute):
"""VI_ATTR_USB_CTRL_PIPE specifies the endpoint address of the USB
control pipe used by the given session. A value of 0 signifies
that the default control pipe will be used. This endpoint is used
in viUsbControlIn and viUsbControlOut operations. Nonzero values
may not be supported on all platforms.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_CTRL_PIPE'
visa_type = 'ViInt16'
default = 0x00
read, write, local = True, True, True
min_value, max_value, values = 0x00, 0x0F, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_END_IN(ValuesAttribute):
"""VI_ATTR_USB_END_IN indicates the method used to terminate read
operations.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_END_IN'
visa_type = 'ViUInt16'
default = constants.VI_USB_END_SHORT_OR_COUNT
read, write, local = True, True, True
values = [constants.VI_USB_END_NONE,
constants.VI_USB_END_SHORT,
constants.VI_USB_END_SHORT_OR_COUNT]
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_INTFC_NUM(RangeAttribute):
"""VI_ATTR_USB_INTFC_NUM specifies the USB interface number used by the
given session.
"""
resources = [(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW')]
py_name = 'interface_number'
visa_name = 'VI_ATTR_USB_INTFC_NUM'
visa_type = 'ViInt16'
default = 0
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFE, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_INTR_IN_PIPE(RangeAttribute):
"""VI_ATTR_USB_INTR_IN_PIPE specifies the endpoint address of the USB
interrupt-in pipe used by the given session. An initial value of
-1 signifies that this resource does not have any interrupt-in
pipes. This endpoint is used in viEnableEvent for
VI_EVENT_USB_INTR.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_INTR_IN_PIPE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = 0x81, 0x8F, [-1]
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_INTR_IN_STATUS(RangeAttribute):
"""VI_ATTR_USB_INTR_IN_STATUS specifies whether the USB interrupt-in pipe
used by the given session is stalled or ready. This attribute can
be set to only VI_USB_PIPE_READY.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_INTR_IN_STATUS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = -32768, 32767, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_MAX_INTR_SIZE(RangeAttribute):
"""VI_ATTR_USB_MAX_INTR_SIZE specifies the maximum size of data that will
be stored by any given USB interrupt. If a USB interrupt contains
more data than this size, the data in excess of this size will be
lost.
"""
resources = [(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW')]
py_name = 'maximum_interrupt_size'
visa_name = 'VI_ATTR_USB_MAX_INTR_SIZE'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, True, True
min_value, max_value, values = 0, 0xFFFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_NUM_INTFCS(RangeAttribute):
"""VI_ATTR_USB_NUM_INTFCS specifies the number of interfaces supported by
this USB device.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_NUM_INTFCS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 1, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_NUM_PIPES(RangeAttribute):
"""VI_ATTR_USB_NUM_PIPES specifies the number of pipes supported by this
USB interface. This does not include the default control pipe.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_NUM_PIPES'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 30, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_PROTOCOL(RangeAttribute):
"""VI_ATTR_USB_PROTOCOL specifies the USB protocol used by this USB
interface.
"""
resources = [(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW')]
py_name = 'usb_protocol'
visa_name = 'VI_ATTR_USB_PROTOCOL'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFF, []
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_SERIAL_NUM(Attribute):
"""VI_ATTR_USB_SERIAL_NUM specifies the USB serial number of this device.
"""
resources = [(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW')]
py_name = 'serial_number'
visa_name = 'VI_ATTR_USB_SERIAL_NUM'
visa_type = 'ViString'
default = NotAvailable
read, write, local = True, False, False
# [u'N/A']
# noinspection PyPep8Naming
class AttrVI_ATTR_USB_SUBCLASS(RangeAttribute):
"""VI_ATTR_USB_SUBCLASS specifies the USB subclass used by this USB
interface.
"""
resources = [(constants.InterfaceType.usb, 'RAW')]
py_name = ''
visa_name = 'VI_ATTR_USB_SUBCLASS'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 0xFF, []
# Could not generate class for VI_ATTR_USER_DATA.html
# Exception:
"""
Unknown type: VI_ATTR_USER_DATA:
ViAddr
VI_ATTR_USER_DATA_32:
ViUInt32
VI_ATTR_USER_DATA_64:
ViUInt64. Range: [u'VI_ATTR_USER_DATA:', u'Not specified', u'VI_ATTR_USER_DATA_32:', u'0h to FFFFFFFFh', u'VI_ATTR_USER_DATA_64:', u'0h to FFFFFFFFFFFFFFFFh']
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_DEV_CLASS(RangeAttribute):
"""This attribute represents the VXI-defined device class to which the
resource belongs, either message based (VI_VXI_CLASS_MESSAGE),
register based (VI_VXI_CLASS_REGISTER), extended
(VI_VXI_CLASS_EXTENDED), or memory (VI_VXI_CLASS_MEMORY). VME
devices are usually either register based or belong to a
miscellaneous class (VI_VXI_CLASS_OTHER).
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_VXI_DEV_CLASS'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_LA(RangeAttribute):
"""For an INSTR session, VI_ATTR_VXI_LA specifies the logical address of
the VXI or VME device used by the given session. For a MEMACC or
SERVANT session, this attribute specifies the logical address of
the local controller.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_VXI_LA'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 511, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_TRIG_DIR(RangeAttribute):
"""VI_ATTR_TRIG_DIR is a bit map of the directions of the mapped TTL
trigger lines. Bits 0-7 represent TTL triggers 0-7 respectively. A
bit's value of 0 means the line is routed out of the frame, and a
value of 1 means into the frame. In order for a direction to be
set, the line must also be enabled using
VI_ATTR_VXI_TRIG_LINES_EN.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_VXI_TRIG_DIR'
visa_type = 'ViUInt16'
default = 0
read, write, local = True, True, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_TRIG_LINES_EN(RangeAttribute):
"""VI_ATTR_VXI_TRIG_LINES_EN is a bit map of what VXI TLL triggers have
mappings. Bits 0-7 represent TTL triggers 0-7 respectively. A
bit's value of 0 means the trigger line is unmapped, and 1 means a
mapping exists. Use VI_ATTR_VXI_TRIG_DIR to set an enabled line's
direction.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR')]
py_name = ''
visa_name = 'VI_ATTR_VXI_TRIG_LINES_EN'
visa_type = 'ViUInt16'
default = 0
read, write, local = True, True, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_TRIG_STATUS(RangeAttribute):
"""This attribute shows the current state of the VXI trigger lines. This
is a bit vector with bits 0-9 corresponding to VI_TRIG_TTL0
through VI_TRIG_ECL1.
"""
resources = [(constants.InterfaceType.vxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_VXI_TRIG_STATUS'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_TRIG_SUPPORT(RangeAttribute):
"""This attribute shows which VXI trigger lines this implementation
supports. This is a bit vector with bits 0-9 corresponding to
VI_TRIG_TTL0 through VI_TRIG_ECL1.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_VXI_TRIG_SUPPORT'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 4294967295, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_VME_INTR_STATUS(RangeAttribute):
"""This attribute shows the current state of the VXI/VME interrupt lines.
This is a bit vector with bits 0-6 corresponding to interrupt
lines 1-7.
"""
resources = [(constants.InterfaceType.vxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_VXI_VME_INTR_STATUS'
visa_type = 'ViUInt16'
default = NotAvailable
read, write, local = True, False, False
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_VXI_VME_SYSFAIL_STATE(EnumAttribute):
"""This attribute shows the current state of the VXI/VME SYSFAIL (SYStem
FAILure) backplane line.
"""
resources = [(constants.InterfaceType.vxi, 'BACKPLANE')]
py_name = ''
visa_name = 'VI_ATTR_VXI_VME_SYSFAIL_STATE'
visa_type = 'ViInt16'
default = NotAvailable
read, write, local = True, False, False
enum_type = constants.LineState
# noinspection PyPep8Naming
class AttrVI_ATTR_WIN_ACCESS(RangeAttribute):
"""VI_ATTR_WIN_ACCESS specifies the modes in which the current window may
be accessed.
"""
resources = [(constants.InterfaceType.pxi, 'INSTR'),
(constants.InterfaceType.pxi, 'MEMACC'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_WIN_ACCESS'
visa_type = 'ViUInt16'
default = constants.VI_NMAPPED
read, write, local = True, False, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_WIN_ACCESS_PRIV(RangeAttribute):
"""VI_ATTR_WIN_ACCESS_PRIV specifies the address modifier to be used in
low-level access operations, such as viMapAddress(), viPeekXX(),
and viPokeXX(), when accessing the mapped window.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_WIN_ACCESS_PRIV'
visa_type = 'ViUInt16'
default = constants.VI_DATA_PRIV
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# Could not generate class for VI_ATTR_WIN_BASE_ADDR.html
# Exception:
"""
Unknown type: VI_ATTR_WIN_BASE_ADDR:
ViBusAddress
VI_ATTR_WIN_BASE_ADDR_32:
ViUInt32
VI_ATTR_WIN_BASE_ADDR_64:
ViUInt64. Range: [u'VI_ATTR_WIN_BASE_ADDR:', u'0h to FFFFFFFFh for 32\u2011bit applications', u'0h to FFFFFFFFFFFFFFFFh for 64\u2011bit applications', u'VI_ATTR_WIN_BASE_ADDR_32:', u'0h to FFFFFFFFh', u'VI_ATTR_WIN_BASE_ADDR_64:', u'0h to FFFFFFFFFFFFFFFFh']
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_WIN_BYTE_ORDER(RangeAttribute):
"""VI_ATTR_WIN_BYTE_ORDER specifies the byte order to be used in low-
level access operations, such as viMapAddress(), viPeekXX(), and
viPokeXX(), when accessing the mapped window.
"""
resources = [(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'MEMACC')]
py_name = ''
visa_name = 'VI_ATTR_WIN_BYTE_ORDER'
visa_type = 'ViUInt16'
default = constants.VI_BIG_ENDIAN
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# Could not generate class for VI_ATTR_WIN_SIZE.html
# Exception:
"""
Unknown type: VI_ATTR_WIN_SIZE:
ViBusSize
VI_ATTR_WIN_SIZE_32:
ViUInt32
VI_ATTR_WIN_SIZE_64:
ViUInt64. Range: [u'VI_ATTR_WIN_SIZE:', u'0h to FFFFFFFFh for 32\u2011bit applications', u'0h to FFFFFFFFFFFFFFFFh for 64\u2011bit applications', u'VI_ATTR_WIN_SIZE_32:', u'0h to FFFFFFFFh', u'VI_ATTR_WIN_SIZE_64:', u'0h to FFFFFFFFFFFFFFFFh']
"""
# noinspection PyPep8Naming
class AttrVI_ATTR_WR_BUF_OPER_MODE(RangeAttribute):
"""VI_ATTR_WR_BUF_OPER_MODE specifies the operational mode of the
formatted I/O write buffer. When the operational mode is set to
VI_FLUSH_WHEN_FULL (default), the buffer is flushed when an END
indicator is written to the buffer, or when the buffer fills up.
If the operational mode is set to VI_FLUSH_ON_ACCESS, the write
buffer is flushed under the same conditions, and also every time a
viPrintf() (or related) operation completes.
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_WR_BUF_OPER_MODE'
visa_type = 'ViUInt16'
default = constants.VI_FLUSH_WHEN_FULL
read, write, local = True, True, True
min_value, max_value, values = 0, 65535, []
# noinspection PyPep8Naming
class AttrVI_ATTR_WR_BUF_SIZE(RangeAttribute):
"""This is the current size of the formatted I/O output buffer for this
session. The user can modify this value by calling viSetBuf().
"""
resources = [(constants.InterfaceType.gpib, 'INSTR'),
(constants.InterfaceType.gpib, 'INTFC'),
(constants.InterfaceType.asrl, 'INSTR'),
(constants.InterfaceType.tcpip, 'INSTR'),
(constants.InterfaceType.tcpip, 'SOCKET'),
(constants.InterfaceType.usb, 'INSTR'),
(constants.InterfaceType.usb, 'RAW'),
(constants.InterfaceType.vxi, 'INSTR'),
(constants.InterfaceType.vxi, 'SERVANT')]
py_name = ''
visa_name = 'VI_ATTR_WR_BUF_SIZE'
visa_type = 'ViUInt32'
default = NotAvailable
read, write, local = True, False, True
min_value, max_value, values = 0, 4294967295, []
|