/usr/include/gnuradio/rpcregisterhelpers.h is in gnuradio-dev 3.7.10.1-2+b3.
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 | /* -*- c++ -*- */
/*
* Copyright 2012,2014 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
#ifndef RPCREGISTERHELPERS_H
#define RPCREGISTERHELPERS_H
#include <stdio.h>
#include <sstream>
#include <iostream>
#include <gnuradio/rpcserver_booter_base.h>
#include <gnuradio/rpcmanager.h>
#include <gnuradio/rpcserver_selector.h>
#include <gnuradio/rpcserver_base.h>
// Fixes circular dependency issue before including block_registry.h
class rpcbasic_base;
typedef boost::shared_ptr<rpcbasic_base> rpcbasic_sptr;
#include <gnuradio/block_registry.h>
/*********************************************************************
* RPC Extractor Base Classes
********************************************************************/
/*!
*\brief Base class for registering a ControlPort Extractor. Acts as
* a message acceptor.
*/
template<typename T, typename Tto>
class rpcextractor_base
: public virtual gr::messages::msg_accepter
{
public:
rpcextractor_base(T* source, void (T::*func)(Tto)) :
_source(source), _func(func) {;}
~rpcextractor_base() {;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg) {
throw std::runtime_error("rpcextractor_base: no post defined for this data type.\n");
}
protected:
T* _source;
void (T::*_func)(Tto);
};
template<typename T>
class rpcextractor_base<T,void>
: public virtual gr::messages::msg_accepter
{
public:
rpcextractor_base(T* source, void (T::*func)()) :
_source(source), _func(func) {;}
~rpcextractor_base() {;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg) {
throw std::runtime_error("rpcextractor_base: no post defined for this data type.\n");
}
protected:
T* _source;
void (T::*_func)();
};
/*!
* \brief Templated parent class for registering a ControlPort Extractor.
*/
template<typename T, typename Tto>
class rpcbasic_extractor : public virtual rpcextractor_base<T,Tto>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(Tto)) :
rpcextractor_base<T,Tto>(source, func)
{;}
};
/*********************************************************************
* RPC Inserter Base Classes
********************************************************************/
/*!
* \brief Base class for registering a ControlPort Inserter. Produces a
* message.
*/
template<typename T, typename Tfrom>
class rpcinserter_base : public virtual gr::messages::msg_producer
{
public:
rpcinserter_base(T* source, Tfrom (T::*func)()) : _source(source), _func(func) {;}
rpcinserter_base() {;}
pmt::pmt_t retrieve() { assert(0); return pmt::pmt_t(); }
protected:
T* _source;
Tfrom (T::*_func)();
};
/*!
* \brief Templated parent class for registering a ControlPort
* Inserter.
*/
template<typename T, typename Tfrom>
class rpcbasic_inserter :
public virtual rpcinserter_base<T,Tfrom>
{
public:
rpcbasic_inserter(T* source, Tfrom (T::*func)()const)
: rpcinserter_base<T,Tfrom>(source, func)
{;}
rpcbasic_inserter(T* source, Tfrom (T::*func)())
: rpcinserter_base<T,Tfrom>(source, func)
{;}
pmt::pmt_t retrieve()
{
return pmt::mp((rpcinserter_base<T,Tfrom>::
_source->*rpcinserter_base<T,Tfrom>::_func)());
}
};
/*********************************************************************
* RPC Handler Base Classes
********************************************************************/
/*!
*\brief Base class for registering a ControlPort Handler. Acts as
* a message acceptor.
*/
template<typename T>
class rpchandler_base
: public virtual gr::messages::msg_accepter
{
public:
rpchandler_base(T* source, const char* handler) :
_source(source), _handler(handler) {;}
~rpchandler_base() {;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg) {
_source->post(which_port, msg);
}
protected:
T* _source;
const char* _handler;
};
/*!
* \brief Templated parent class for registering a ControlPort Extractor.
*/
template<typename T>
class rpcbasic_handler : public virtual rpchandler_base<T>
{
public:
rpcbasic_handler(T* source, const char* handler) :
rpchandler_base<T>(source, handler)
{;}
};
/*********************************************************************
* RPC Specialized Extractors
********************************************************************/
/*!
* \brief Specialized extractor class to make calls to functions that
* do not take data (enable, reset, start, etc.).
*/
template<typename T>
class rpcbasic_extractor<T,void> : public virtual rpcextractor_base<T,void>
{
public:
rpcbasic_extractor(T* source, void (T::*func)())
: rpcextractor_base<T,void>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,void>::_source->*rpcextractor_base<T,void>::_func)();
}
};
/*!
* \brief Specialized extractor class for char data.
*/
template<typename T>
class rpcbasic_extractor<T,char> : public virtual rpcextractor_base<T,char>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(char))
: rpcextractor_base<T,char>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,char>::_source->*rpcextractor_base<T,char>::_func)
(static_cast<char>(pmt::to_long(msg)));
}
};
/*!
* \brief Specialized extractor class for short data.
*/
template<typename T>
class rpcbasic_extractor<T,short> : public virtual rpcextractor_base<T,short>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(short))
: rpcextractor_base<T,short>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,short>::_source->*rpcextractor_base<T,short>::_func)
(static_cast<short>(pmt::to_long(msg)));
}
};
/*!
* \brief Specialized extractor class for double data.
*/
template<typename T>
class rpcbasic_extractor<T,double> : public virtual rpcextractor_base<T,double>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(double))
: rpcextractor_base<T,double>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,double>::_source->*rpcextractor_base<T,double>::_func)
(pmt::to_double(msg));
}
};
/*!
* \brief Specialized extractor class for float data.
*/
template<typename T>
class rpcbasic_extractor<T,float> : public virtual rpcextractor_base<T,float>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(float))
: rpcextractor_base<T,float>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,float>::_source->*rpcextractor_base<T,float>::_func)
(pmt::to_double(msg));
}
};
/*!
* \brief Specialized extractor class for long data.
*/
template<typename T>
class rpcbasic_extractor<T,long> : public virtual rpcextractor_base<T,long>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(long))
: rpcextractor_base<T,long>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,long>::_source->*rpcextractor_base<T,long>::_func)
(pmt::to_long(msg));
}
};
/*!
* \brief Specialized extractor class for int data.
*/
template<typename T>
class rpcbasic_extractor<T,int> : public virtual rpcextractor_base<T,int>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(int))
: rpcextractor_base<T,int>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,int>::_source->*rpcextractor_base<T,int>::_func)
(pmt::to_long(msg));
}
};
/*!
* \brief Specialized extractor class for bool data.
*/
template<typename T>
class rpcbasic_extractor<T,bool> : public virtual rpcextractor_base<T,bool>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(bool))
: rpcextractor_base<T,bool>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,bool>::_source->*rpcextractor_base<T,bool>::_func)
(pmt::to_bool(msg));
}
};
/*!
* \brief Specialized extractor class for complex (float) data.
*/
template<typename T>
class rpcbasic_extractor<T,std::complex<float> >
: public virtual rpcextractor_base<T,std::complex<float> >
{
public:
rpcbasic_extractor(T* source, void (T::*func)(std::complex<float>))
: rpcextractor_base<T,std::complex<float> >(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
std::complex<float> k = static_cast<std::complex<float> >(pmt::to_complex(msg));
(rpcextractor_base<T,std::complex<float> >::
_source->*rpcextractor_base<T,std::complex<float> >::_func)(k);
}
};
/*!
* \brief Specialized extractor class for complex (double) data.
*/
template<typename T>
class rpcbasic_extractor<T,std::complex<double> >
: public virtual rpcextractor_base<T,std::complex<double> >
{
public:
rpcbasic_extractor(T* source, void (T::*func)(std::complex<double>))
: rpcextractor_base<T,std::complex<double> >(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,std::complex<double> >::
_source->*rpcextractor_base<T,std::complex<double> >::_func)(pmt::to_complex(msg));
}
};
/*!
* \brief Specialized extractor class for string data.
*/
template<typename T>
class rpcbasic_extractor<T,std::string>
: public virtual rpcextractor_base<T,std::string>
{
public:
rpcbasic_extractor(T* source, void (T::*func)(std::string))
: rpcextractor_base<T,std::string>(source, func)
{;}
void post(pmt::pmt_t which_port, pmt::pmt_t msg)
{
(rpcextractor_base<T,std::string>::
_source->*rpcextractor_base<T,std::string>::_func)(pmt::symbol_to_string(msg));
}
};
/*********************************************************************
* RPC Specialized Inserters
********************************************************************/
/*!
* \brief Specialized inserter class for uint64_t data.
*/
template<typename T>
class rpcbasic_inserter<T,uint64_t> : public virtual rpcinserter_base<T,uint64_t>
{
public:
rpcbasic_inserter(T* source, uint64_t (T::*func)() const)
: rpcinserter_base<T,uint64_t>(source, func)
{;}
rpcbasic_inserter(T* source, uint64_t (T::*func)())
: rpcinserter_base<T,uint64_t>(source, func)
{;}
pmt::pmt_t retrieve()
{
return pmt::from_uint64((rpcinserter_base<T,uint64_t>::
_source->*rpcinserter_base<T,uint64_t>::_func)());
}
};
/*!
* \brief Specialized inserter class for vectors of signed char data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< signed char > >
: public virtual rpcinserter_base<T,std::vector< signed char > >
{
public:
rpcbasic_inserter(T* source, std::vector< signed char > (T::*func)() const)
: rpcinserter_base<T,std::vector< signed char > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector< signed char > (T::*func)())
: rpcinserter_base<T,std::vector< signed char > >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< signed char >
vec((rpcinserter_base<T,std::vector< signed char > >::
_source->*rpcinserter_base<T,std::vector< signed char > >::_func)());
return pmt::init_s8vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for vectors of short data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< short > >
: public virtual rpcinserter_base<T,std::vector< short > >
{
public:
rpcbasic_inserter(T* source, std::vector< short > (T::*func)() const)
: rpcinserter_base<T,std::vector< short > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector< short > (T::*func)())
: rpcinserter_base<T,std::vector< short > >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< short >
vec((rpcinserter_base<T,std::vector< short > >::
_source->*rpcinserter_base<T,std::vector< short > >::_func)());
return pmt::init_s16vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for vectors of int data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< int > >
: public virtual rpcinserter_base<T,std::vector< int > >
{
public:
rpcbasic_inserter(T* source, std::vector<int > (T::*func)() const)
: rpcinserter_base<T,std::vector<int > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector<int > (T::*func)())
: rpcinserter_base<T,std::vector<int > >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< int >
vec((rpcinserter_base<T,std::vector<int > >::
_source->*rpcinserter_base<T,std::vector< int > >::_func)());
return pmt::init_s32vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for vectors of complex (float) data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< std::complex<float> > >
: public virtual rpcinserter_base<T,std::vector< std::complex<float> > >
{
public:
rpcbasic_inserter(T* source, std::vector<std::complex<float> > (T::*func)() const)
: rpcinserter_base<T,std::vector<std::complex<float> > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector<std::complex<float> > (T::*func)())
: rpcinserter_base<T,std::vector<std::complex<float> > >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< std::complex<float> >
vec((rpcinserter_base<T,std::vector<std::complex<float> > >::
_source->*rpcinserter_base<T,std::vector< std::complex<float> > >::_func)());
return pmt::init_c32vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for vectors of float data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< float> >
: public virtual rpcinserter_base<T,std::vector< float > >
{
public:
rpcbasic_inserter(T* source, std::vector<float> (T::*func)() const)
: rpcinserter_base<T,std::vector<float > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector<float> (T::*func)())
: rpcinserter_base<T,std::vector<float> >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< float > vec((rpcinserter_base<T,std::vector<float> >::
_source->*rpcinserter_base<T,std::vector< float> >::_func)());
return pmt::init_f32vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for vectors of uint8_t data.
*/
template<typename T>
class rpcbasic_inserter<T,std::vector< uint8_t> >
: public virtual rpcinserter_base<T,std::vector< uint8_t > > {
public:
rpcbasic_inserter(T* source, std::vector<uint8_t> (T::*func)() const)
: rpcinserter_base<T,std::vector<uint8_t > >(source, func)
{;}
rpcbasic_inserter(T* source, std::vector<uint8_t> (T::*func)())
: rpcinserter_base<T,std::vector<uint8_t> >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::vector< uint8_t > vec((rpcinserter_base<T,std::vector<uint8_t> >::
_source->*rpcinserter_base<T,std::vector< uint8_t> >::_func)());
return pmt::init_u8vector(vec.size(), &vec[0]);
}
};
/*!
* \brief Specialized inserter class for complex (float) data.
*/
template<typename T>
class rpcbasic_inserter<T,std::complex<float> >
: public virtual rpcinserter_base<T,std::complex<float > > {
public:
rpcbasic_inserter(T* source, std::complex<float> (T::*func)() const)
: rpcinserter_base<T,std::complex<float> >(source, func)
{;}
rpcbasic_inserter(T* source, std::complex<float> (T::*func)())
: rpcinserter_base<T,std::complex<float> >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::complex<float > k((rpcinserter_base<T,std::complex<float> >::
_source->*rpcinserter_base<T,std::complex<float> >::_func)());
return pmt::from_complex(k);
}
};
/*!
* \brief Specialized inserter class for complex (double) data.
*/
template<typename T>
class rpcbasic_inserter<T,std::complex<double> >
: public virtual rpcinserter_base<T,std::complex<double > > {
public:
rpcbasic_inserter(T* source, std::complex<double> (T::*func)() const)
: rpcinserter_base<T,std::complex<double> >(source, func)
{;}
rpcbasic_inserter(T* source, std::complex<double> (T::*func)())
: rpcinserter_base<T,std::complex<double> >(source, func)
{;}
pmt::pmt_t retrieve()
{
std::complex<double > k((rpcinserter_base<T,std::complex<double> >::
_source->*rpcinserter_base<T,std::complex<double> >::_func)());
return pmt::from_complex(k);
}
};
/*!
* \brief Base class for registering a ControlPort function.
*/
template <typename T>
struct rpc_register_base
{
rpc_register_base() {count++;}
protected: static int count;
};
/*!
* Base class to inherit from and create universal shared pointers.
*/
class rpcbasic_base
{
public:
rpcbasic_base() {}
virtual ~rpcbasic_base() {};
};
/*********************************************************************
* RPC Register Set Classes
********************************************************************/
/*!
* \brief Registers a 'set' function to set a parameter over
* ControlPort.
*
* \details
*
* This class allows us to remotely set a value or parameter of the
* block over ControlPort. The set occurs by calling a setter accessor
* function of the class, usually set_[variable](), which is passed in
* as \p function.
*
* We can set the (expected) minimum (\p min), maximum (\p max), and
* default (\p def) of the variables being set. These values are not
* enforced, however, but can be useful for setting up graphs and
* other ways of bounding the data.
*
* This class also allows us to provide information to the user about
* the variable being set, such as an appropriate unit (\p units_) as
* well as a description (\p desc_) about what the variable does.
*
* The privilege (\p minpriv_) level is the minimum privilege level a
* remote must identify with to be able to call this function.
*
* We also provide display hints (\p display_), which can be used by
* the ControlPort client application to know how to best display or
* even print the data. This is a mask of options for variables set in
* rpccallbackregister_base.h. The mask is defined by one of the
* "DisplayType Plotting Types" and or'd with any of the "DisplayType
* Options" features. See "Display Options" in \ref page_ctrlport for
* details.
*/
template<typename T, typename Tto>
struct rpcbasic_register_set : public rpcbasic_base
{
/*!
* \brief Adds the ability to set the variable over ControlPort.
*
* \details
*
* This constructor is specifically for gr::block's to use to add
* settable variables to ControlPort. Generally meant to be used
* in gr::block::setup_rpc.
*
* Uses the block's alias to create the ControlPort interface. This
* alias is cross-referenced by the global_block_registry (static
* variable of type gr::block_registry) to get the pointer to the
* block.
*
* \param block_alias Block's alias; use alias() to get it from the block.
* \param functionbase The name of the function that we'll access over ControlPort
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::set_[variable]()
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_set(const std::string& block_alias,
const char* functionbase,
void (T::*function)(Tto),
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = dynamic_cast<T*>(global_block_registry.block_lookup(pmt::intern(block_alias)).get());
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::configureCallback_t
extractor(new rpcbasic_extractor<T,Tto>(d_object, function),
minpriv_, std::string(units_),
display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << block_alias << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING SET: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerConfigureCallback(d_id, extractor);
#endif
}
/*!
* \brief Adds the ability to set the variable over ControlPort.
*
* \details
*
* Allows us to add non gr::block related objects to
* ControlPort. Instead of using the block's alias, we give it a \p
* name and the actual pointer to the object as \p obj. We just need
* to make sure that the pointer to this object is always valid.
*
* \param name Name of the object being set up for ControlPort access
* \param functionbase The name of the function that we'll access over ControlPort
* \param obj A pointer to the object itself
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::set_[variable]()
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_set(const std::string& name,
const char* functionbase,
T* obj,
void (T::*function)(Tto),
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = obj;
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::configureCallback_t
extractor(new rpcbasic_extractor<T,Tto>(d_object, function),
minpriv_, std::string(units_),
display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << name << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING SET: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerConfigureCallback(d_id, extractor);
#endif
}
~rpcbasic_register_set()
{
#ifdef GR_RPCSERVER_ENABLED
rpcmanager::get()->i()->unregisterConfigureCallback(d_id);
#endif
}
pmt::pmt_t min() const { return d_min; }
pmt::pmt_t max() const { return d_max; }
pmt::pmt_t def() const { return d_def; }
std::string units() const { return d_units; }
std::string description() const { return d_desc; }
priv_lvl_t privilege_level() const { return d_minpriv; }
DisplayType default_display() const { return d_display; }
void set_min(pmt::pmt_t p) { d_min = p; }
void set_max(pmt::pmt_t p) { d_max = p; }
void set_def(pmt::pmt_t p) { d_def = p; }
void units(std::string u) { d_units = u; }
void description(std::string d) { d_desc = d; }
void privilege_level(priv_lvl_t p) { d_minpriv = p; }
void default_display(DisplayType d) { d_display = d; }
private:
std::string d_id;
pmt::pmt_t d_min, d_max, d_def;
std::string d_units, d_desc;
priv_lvl_t d_minpriv;
DisplayType d_display;
T *d_object;
};
/*********************************************************************
* RPC Register Trigger Classes
********************************************************************/
/*!
* \brief Registers a 'trigger' function to trigger an action over
* ControlPort.
*
* \details
*
* This class allows us to set up triggered events or function calls
* over ControlPort. When used from a ControlPort client, the \p
* function established here will be activated. Generally, this is
* meant to enable some kind of trigger or action that a block or
* object will perform, such as a reset, start, stop, etc.
*
* Simpler than the rpcbasic_register_set class, the constructor here
* only takes a few parameters, mostly because there is not actual
* variable associated with these function calls. It takes in the
* information to set up the pointer to the object that has the \p
* function, a ControlPort name (\p functionbase) for the triggered
* action, a description (\p desc_), and a privilege level (\p
* minpriv_).
*/
template<typename T>
struct rpcbasic_register_trigger : public rpcbasic_base
{
/*!
* \brief Adds the ability to trigger a function over ControlPort.
*
* \details
*
* This constructor is specifically for gr::block's to use to add
* trigger functions to ControlPort. Generally meant to be used
* in gr::block::setup_rpc.
*
* Uses the block's alias to create the ControlPort interface. This
* alias is cross-referenced by the global_block_registry (static
* variable of type gr::block_registry) to get the pointer to the
* block.
*
* \param block_alias Block's alias; use alias() to get it from the block.
* \param functionbase The name of the function that we'll access over ControlPort
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::set_[variable]
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
*/
rpcbasic_register_trigger(const std::string& block_alias,
const char* functionbase,
void (T::*function)(),
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN)
{
d_desc = desc_;
d_minpriv = minpriv_;
d_object = dynamic_cast<T*>(global_block_registry.block_lookup(pmt::intern(block_alias)).get());
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::configureCallback_t
extractor(new rpcbasic_extractor<T,void>(d_object, function),
minpriv_, std::string(desc_));
std::ostringstream oss(std::ostringstream::out);
oss << block_alias << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING TRIGGER: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerConfigureCallback(d_id, extractor);
#endif
}
/*!
* \brief Adds the ability to trigger a function over ControlPort.
*
* \details
*
* Allows us to add non gr::block related objects to
* ControlPort. Instead of using the block's alias, we give it a \p
* name and the actual pointer to the object as \p obj. We just need
* to make sure that the pointer to this object is always valid.
*
* \param name Name of the object being set up for ControlPort access
* \param functionbase The name of the function that we'll access over ControlPort
* \param obj A pointer to the object itself
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::set_[variable]
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
*/
rpcbasic_register_trigger(const std::string& name,
const char* functionbase,
T* obj,
void (T::*function)(),
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN)
{
d_desc = desc_;
d_minpriv = minpriv_;
d_object = obj;
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::configureCallback_t
extractor(new rpcbasic_extractor<T,void>(d_object, function),
minpriv_, std::string(desc_));
std::ostringstream oss(std::ostringstream::out);
oss << name << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING TRIGGER: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerConfigureCallback(d_id, extractor);
#endif
}
~rpcbasic_register_trigger()
{
#ifdef GR_RPCSERVER_ENABLED
rpcmanager::get()->i()->unregisterConfigureCallback(d_id);
#endif
}
std::string description() const { return d_desc; }
priv_lvl_t privilege_level() const { return d_minpriv; }
void description(std::string d) { d_desc = d; }
void privilege_level(priv_lvl_t p) { d_minpriv = p; }
private:
std::string d_id;
std::string d_desc;
priv_lvl_t d_minpriv;
T *d_object;
};
/*********************************************************************
* RPC Register Get Classes
********************************************************************/
/*!
* \brief Registers a 'get' function to get a parameter over
* ControlPort.
*
* \details
*
* This class allows us to remotely get a value or parameter of the
* block over ControlPort. The get occurs by calling a getter accessor
* function of the class, usually [variable](), which is passed in
* as \p function.
*
* We can set the (expected) minimum (\p min), maximum (\p max), and
* default (\p def) of the variables we will get. These values are not
* enforced, however, but can be useful for setting up graphs and
* other ways of bounding the data.
*
* This class also allows us to provide information to the user about
* the variable, such as an appropriate unit (\p units_) as well as a
* description (\p desc_) about what the variable does.
*
* The privilege (\p minpriv_) level is the minimum privilege level a
* remote must identify with to be able to call this function.
*
* We also provide display hints (\p display_), which can be used by
* the ControlPort client application to know how to best display or
* even print the data. This is a mask of options for variables set in
* rpccallbackregister_base.h. The mask is defined by one of the
* "DisplayType Plotting Types" and or'd with any of the "DisplayType
* Options" features. See "Display Options" in \ref page_ctrlport for
* details.
*/
template<typename T, typename Tfrom>
class rpcbasic_register_get : public rpcbasic_base
{
public:
/*!
* \brief Adds the ability to get the variable over ControlPort.
*
* \details
*
* This constructor is specifically for gr::block's to use to add
* gettable variables to ControlPort. Generally meant to be used
* in gr::block::setup_rpc.
*
* Uses the block's alias to create the ControlPort interface. This
* alias is cross-referenced by the global_block_registry (static
* variable of type gr::block_registry) to get the pointer to the
* block.
*
* \param block_alias Block's alias; use alias() to get it from the block.
* \param functionbase The name of the function that we'll access over ControlPort
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::[variable]()
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_get(const std::string& block_alias,
const char* functionbase,
Tfrom (T::*function)(),
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = dynamic_cast<T*>(global_block_registry.block_lookup(pmt::intern(block_alias)).get());
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::queryCallback_t
inserter(new rpcbasic_inserter<T,Tfrom>(d_object, function),
minpriv_, std::string(units_), display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << block_alias << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING GET: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerQueryCallback(d_id, inserter);
#endif
}
/*!
* \brief Same as rpcbasic_register_get::rpcbasic_register_get that allows using
* '[variable]() const' getter functions.
*/
rpcbasic_register_get(const std::string& block_alias,
const char* functionbase,
Tfrom (T::*function)() const,
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = dynamic_cast<T*>(global_block_registry.block_lookup(pmt::intern(block_alias)).get());
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::queryCallback_t
inserter(new rpcbasic_inserter<T,Tfrom>(d_object, (Tfrom (T::*)())function),
minpriv_, std::string(units_), display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << block_alias << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING GET CONST: " << d_id << " " << desc_ << " " << display_ << std::endl;
rpcmanager::get()->i()->registerQueryCallback(d_id, inserter);
#endif
}
/*!
* \brief Adds the ability to get the variable over ControlPort.
*
* \details
*
* Allows us to add non gr::block related objects to
* ControlPort. Instead of using the block's alias, we give it a \p
* name and the actual pointer to the object as \p obj. We just need
* to make sure that the pointer to this object is always valid.
*
* \param name Name of the object being set up for ControlPort access
* \param functionbase The name of the function that we'll access over ControlPort
* \param obj A pointer to the object itself
* \param function A function pointer to the real function accessed when called
* something like: &[block class]\::set_[variable]()
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_get(const std::string& name,
const char* functionbase,
T* obj,
Tfrom (T::*function)(),
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = obj;
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::queryCallback_t
inserter(new rpcbasic_inserter<T,Tfrom>(d_object, function),
minpriv_, std::string(units_), display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << name << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING GET: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerQueryCallback(d_id, inserter);
#endif
}
/*!
* \brief Same as above that allows using '[variable]() const'
* getter functions.
*/
rpcbasic_register_get(const std::string& name,
const char* functionbase,
T* obj,
Tfrom (T::*function)() const,
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_min = min;
d_max = max;
d_def = def;
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = obj;
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::queryCallback_t
inserter(new rpcbasic_inserter<T,Tfrom>(d_object, (Tfrom (T::*)())function),
minpriv_, std::string(units_), display_, std::string(desc_), min, max, def);
std::ostringstream oss(std::ostringstream::out);
oss << name << "::" << functionbase;
d_id = oss.str();
//std::cerr << "REGISTERING GET CONST: " << d_id << " " << desc_ << " " << display_ << std::endl;
rpcmanager::get()->i()->registerQueryCallback(d_id, inserter);
#endif
}
~rpcbasic_register_get()
{
#ifdef GR_RPCSERVER_ENABLED
rpcmanager::get()->i()->unregisterQueryCallback(d_id);
#endif
}
pmt::pmt_t min() const { return d_min; }
pmt::pmt_t max() const { return d_max; }
pmt::pmt_t def() const { return d_def; }
std::string units() const { return d_units; }
std::string description() const { return d_desc; }
priv_lvl_t privilege_level() const { return d_minpriv; }
DisplayType default_display() const { return d_display; }
void set_min(pmt::pmt_t p) { d_min = p; }
void set_max(pmt::pmt_t p) { d_max = p; }
void set_def(pmt::pmt_t p) { d_def = p; }
void units(std::string u) { d_units = u; }
void description(std::string d) { d_desc = d; }
void privilege_level(priv_lvl_t p) { d_minpriv = p; }
void default_display(DisplayType d) { d_display = d; }
private:
std::string d_id;
pmt::pmt_t d_min, d_max, d_def;
std::string d_units, d_desc;
priv_lvl_t d_minpriv;
DisplayType d_display;
T *d_object;
};
/*********************************************************************
* RPC Register Variable Classes
********************************************************************/
/*!
* \brief Registers a read-only function to get a parameter over ControlPort.
*
* \details
*
* This class allows us to remotely get a value or parameter of the
* block over ControlPort. Unlike the rpcbasic_register_get class,
* this version is passed the variable directly and establishes a
* getter for us, so there is no need to have a getter function
* already in the object.
*
* This version is for read-only get access.
*
* We can set the (expected) minimum (\p min), maximum (\p max), and
* default (\p def) of the variables we will get. These values are not
* enforced, however, but can be useful for setting up graphs and
* other ways of bounding the data.
*
* This class also allows us to provide information to the user about
* the variable, such as an appropriate unit (\p units_) as well as a
* description (\p desc_) about what the variable does.
*
* The privilege (\p minpriv_) level is the minimum privilege level a
* remote must identify with to be able to call this function.
*
* We also provide display hints (\p display_), which can be used by
* the ControlPort client application to know how to best display or
* even print the data. This is a mask of options for variables set in
* rpccallbackregister_base.h. The mask is defined by one of the
* "DisplayType Plotting Types" and or'd with any of the "DisplayType
* Options" features. See "Display Options" in \ref page_ctrlport for
* details.
*/
template<typename Tfrom>
class rpcbasic_register_variable
: public rpcbasic_base
{
protected:
rpcbasic_register_get< rpcbasic_register_variable<Tfrom>, Tfrom > d_rpc_reg;
Tfrom *d_variable;
Tfrom get() { return *d_variable; }
public:
void setptr(Tfrom* _variable)
{
rpcbasic_register_variable<Tfrom>::d_variable = _variable;
}
/*! Empty constructor which should never be called but needs to
* exist for ues in varous STL data structures
*/
rpcbasic_register_variable() :
d_rpc_reg("FAIL", "FAIL", this, &rpcbasic_register_variable::get,
pmt::PMT_NIL, pmt::PMT_NIL, pmt::PMT_NIL, DISPNULL,
"FAIL", "FAIL", RPC_PRIVLVL_MIN),
d_variable(NULL)
{
throw std::runtime_error("ERROR: rpcbasic_register_variable called with no args. If this happens, someone has tried to use rpcbasic_register_variable incorrectly.");
};
/*!
* \brief Adds the ability to get the variable over ControlPort.
*
* \details
*
* Creates a new getter accessor function to read \p variable.
*
* \param namebase Name of the object being set up for ControlPort access
* \param functionbase The name of the function that we'll access over ControlPort
* \param variable A pointer to the variable, possibly as a member of a class
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_variable(const std::string& namebase,
const char* functionbase,
Tfrom *variable,
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL) :
d_rpc_reg(namebase, functionbase, this, &rpcbasic_register_variable::get,
min, max, def, units_, desc_, minpriv_, display_),
d_variable(variable)
{
//std::cerr << "REGISTERING VAR: " << " " << desc_ << std::endl;
}
};
/*!
* \brief Registers a read/write function to get and set a parameter
* over ControlPort.
*
* \details
*
* This class allows us to remotely get and/or set a value or
* parameter of the block over ControlPort. Unlike the
* rpcbasic_register_get class, this version is passed the variable
* directly and establishes a getter for us, so there is no need to
* have a getter function already in the object.
*
* This version establishes both get and set functions and so provides
* read/write access to the variable.
*
* We can set the (expected) minimum (\p min), maximum (\p max), and
* default (\p def) of the variables we will get. These values are not
* enforced, however, but can be useful for setting up graphs and
* other ways of bounding the data.
*
* This class also allows us to provide information to the user about
* the variable, such as an appropriate unit (\p units_) as well as a
* description (\p desc_) about what the variable does.
*
* The privilege (\p minpriv_) level is the minimum privilege level a
* remote must identify with to be able to call this function.
*
* We also provide display hints (\p display_), which can be used by
* the ControlPort client application to know how to best display or
* even print the data. This is a mask of options for variables set in
* rpccallbackregister_base.h. The mask is defined by one of the
* "DisplayType Plotting Types" and or'd with any of the "DisplayType
* Options" features. See "Display Options" in \ref page_ctrlport for
* details.
*/
template<typename Tfrom>
class rpcbasic_register_variable_rw
: public rpcbasic_register_variable<Tfrom>
{
private:
rpcbasic_register_set< rpcbasic_register_variable_rw<Tfrom>, Tfrom > d_rpc_regset;
public:
/*! Empty constructor which should never be called but needs to
* exist for ues in varous STL data structures.
*/
rpcbasic_register_variable_rw() :
d_rpc_regset("FAIL", "FAIL", this,
&rpcbasic_register_variable<Tfrom>::get,
pmt::PMT_NIL, pmt::PMT_NIL, pmt::PMT_NIL,
DISPNULL, "FAIL", "FAIL", RPC_PRIVLVL_MIN)
{
throw std::runtime_error("ERROR: rpcbasic_register_variable_rw called with no args. if this happens someone used rpcbasic_register_variable_rw incorrectly.\n");
};
void set(Tfrom _variable)
{
*(rpcbasic_register_variable<Tfrom>::d_variable) = _variable;
}
/*!
* \brief Adds the ability to set and get the variable over ControlPort.
*
* \details
*
* Creates new getter and setter accessor functions to read and write \p variable.
*
* \param namebase Name of the object being set up for ControlPort access
* \param functionbase The name of the function that we'll access over ControlPort
* \param variable A pointer to the variable, possibly as a member of a class
* \param min Expected minimum value the parameter can hold
* \param max Expected maximum value the parameter can hold
* \param def Expected default value the parameter can hold
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_variable_rw(
const std::string& namebase,
const char* functionbase,
Tfrom *variable,
const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv = RPC_PRIVLVL_MIN,
DisplayType display_=DISPNULL)
: rpcbasic_register_variable<Tfrom>(namebase, functionbase, variable,
min, max, def, units_, desc_),
d_rpc_regset(namebase, functionbase, this,
&rpcbasic_register_variable_rw::set,
min, max, def, units_, desc_, minpriv, display_)
{
// no action
}
};
/*!
* \brief Registers a message handler function to post a message to a
* block's handler.
*/
template<typename T>
class rpcbasic_register_handler : public rpcbasic_base
{
public:
/*!
* \brief Adds the ability to pass a message over ControlPort.
*
* \details
* This makes any message handler function avialable over
* ControlPort. Since message handlers always take in a single PMT
* message input, this interface provides a very generic way of
* setting values in a block in a flowgraph.
*
* \param block_alias Alias of the block
* \param handler The name of the message port in the block
* \param units_ A string to describe what units to represent the variable with
* \param desc_ A string to describing the variable.
* \param minpriv_ The required minimum privilege level
* \param display_ The display mask
*/
rpcbasic_register_handler(const std::string& block_alias,
const char* handler,
const char* units_ = "",
const char* desc_ = "",
priv_lvl_t minpriv_ = RPC_PRIVLVL_MIN,
DisplayType display_ = DISPNULL)
{
d_units = units_;
d_desc = desc_;
d_minpriv = minpriv_;
d_display = display_;
d_object = dynamic_cast<T*>(global_block_registry.block_lookup(pmt::intern(block_alias)).get());
#ifdef GR_RPCSERVER_ENABLED
callbackregister_base::handlerCallback_t
inserter(new rpcbasic_handler<T>(d_object, handler),
minpriv_, std::string(units_), display_, std::string(desc_),
0, 0, 0);
std::ostringstream oss(std::ostringstream::out);
oss << block_alias << "::" << handler;
d_id = oss.str();
//std::cerr << "REGISTERING GET: " << d_id << " " << desc_ << std::endl;
rpcmanager::get()->i()->registerHandlerCallback(d_id, inserter);
#endif
}
~rpcbasic_register_handler()
{
#ifdef GR_RPCSERVER_ENABLED
rpcmanager::get()->i()->unregisterHandlerCallback(d_id);
#endif
}
std::string units() const { return d_units; }
std::string description() const { return d_desc; }
priv_lvl_t privilege_level() const { return d_minpriv; }
DisplayType default_display() const { return d_display; }
void units(std::string u) { d_units = u; }
void description(std::string d) { d_desc = d; }
void privilege_level(priv_lvl_t p) { d_minpriv = p; }
void default_display(DisplayType d) { d_display = d; }
private:
std::string d_id;
std::string d_units, d_desc;
priv_lvl_t d_minpriv;
DisplayType d_display;
T *d_object;
};
#endif
|