/usr/include/tango/dbapi.h is in libtango-dev 9.2.5a+dfsg1-2build1.
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 | //+==================================================================================================================
//
// dbapi.h - include file for TANGO database api
//
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Tango is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with Tango.
// If not, see <http://www.gnu.org/licenses/>.
//
//+==================================================================================================================
#ifndef _DBAPI_H
#define _DBAPI_H
#include <vector>
#include <errno.h>
#include <devapi.h>
/** @defgroup DBase Database Client classes
* @ingroup Client
*/
using namespace std;
namespace Tango {
///
/// forward declarations
///
class DbDatum;
class DbDevInfo;
class DbDevImportInfo;
class DbDevExportInfo;
class DbServerInfo;
class DbDevFullInfo;
class DbHistory;
class FileDatabase;
class DbServerCache;
class Util;
class AccessProxy;
///
/// Some typedef and define
///
typedef vector<DbDevInfo> DbDevInfos;
typedef vector<DbDevExportInfo> DbDevExportInfos;
typedef vector<DbDevImportInfo> DbDevImportInfos;
typedef vector<DbDatum> DbData;
#define POGO_DESC "Description"
#define POGO_TITLE "ProjectTitle"
///
/// Classes declaration
///
/**********************************************************************
* *
* Database - database object for implementing generic high-level *
* interface for TANGO database api *
* *
**********************************************************************/
#include "Database.h"
/**********************************************************************
* *
* DbDevice - A database object for accessing device related *
* information in the database *
* *
**********************************************************************/
#include "DbDevice.h"
/**********************************************************************
* *
* DbProperty - A database object for accessing general properties *
* which are stored in the database *
* *
**********************************************************************/
class DbProperty
{
public :
DbProperty(string);
~DbProperty();
//
// methods
//
void get(DbData&);
void put(DbData&);
void delete_(DbData&);
};
/**********************************************************************
* *
* DbAttribute - A database object for accessing attribute related *
* information in the database *
* *
**********************************************************************/
class DbAttribute
{
private :
string name;
string device_name;
Database *dbase;
int db_ind;
bool ext_dbase;
public :
DbAttribute(string &, string &);
DbAttribute(string &, string &, Database *);
DbAttribute(string &,string &, string &,string &);
~DbAttribute();
//
// methods
//
void get_property(DbData&);
void put_property(DbData&);
void delete_property(DbData&);
};
/**********************************************************************
* *
* DbServer - A database object for accessing server related *
* information in the database *
* *
**********************************************************************/
/**
* A database object for a device server which can be used to query or modify server database information.
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbServer
{
private :
string name;
Database *dbase;
int db_ind;
bool ext_dbase;
class DbServerExt
{
public:
DbServerExt() {};
};
#ifdef HAS_UNIQUE_PTR
unique_ptr<DbServerExt> ext;
#else
DbServerExt *ext;
#endif
public :
/**@name Constructors */
//@{
/**
* Create a DbServer instance.
*
* A constructor for a DbServer object for a server in the TANGO database specified by the TANGO_HOST
* environment variable.
*
* @param [in] server_name The device server name
*
*/
DbServer(string server_name);
/**
* Create a DbServer instance using a specified database
*
* A constructor for a DbServer object for the server in the specified database. This method reuses the
* Database supplied by the programmer
*
* @param [in] server_name The device server name
* @param [in] db The database object
*
*/
DbServer(string server_name, Database *db);
//@}
//
// methods
//
/**@name Server oriented methods */
//@{
/**
* Add a device server process into the database
*
* Add a group of devices to the database. The device names, server names and classes are specified in the
* vector of DbDevInfo structures
*
* @param [in] serv Device server process data
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void add_server(DbDevInfos &serv);
/**
* Delete the device server from database
*
* Delete the device server and its associated devices from the database.
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void delete_server();
/**
* Export all device server devices in database
*
* Export a group of device to the database. The device names, IOR, class, server name, pid etc. are specified
* in the vector of DbDevExportInfo structures.
*
* @param [in] serv Devices information
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void export_server(DbDevExportInfos &serv);
/**
* Mark all devices belonging to the device server as un-exported
*
* Mark all the devices exported by the server as un-exported.
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void unexport_server();
//@}
/// @privatesection
~DbServer();
DbServerInfo get_server_info();
};
/**********************************************************************
* *
* DbClass - A database object for accessing class related *
* information in the database *
* *
**********************************************************************/
/**
* A database object for a class which can be used to query or modify class properties
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbClass
{
private :
string name;
Database *dbase;
int db_ind;
bool ext_dbase;
class DbClassExt
{
public:
DbClassExt() {};
};
#ifdef HAS_UNIQUE_PTR
unique_ptr<DbClassExt> ext;
#else
DbClassExt *ext;
#endif
public :
/**@name Constructors */
//@{
/**
* Create a DbClass instance.
*
* A constructor for a DbClass object for a class in the TANGO database specified by the TANGO_HOST
* environment variable
*
* @param [in] class_name The Tango class name
*
*/
DbClass(string class_name);
/**
* Create a DbClass instance using a specified database
*
* A constructor for a DbClass object for the Tango class in the specified database. This method reuses the
* Database supplied by the programmer.
*
* @param [in] class_name The Tango class name
* @param [in] db The database object
*
*/
DbClass(string class_name, Database *db);
//@}
//
// methods
//
/**@name Property oriented methods */
//@{
/**
* Get class property from database
*
* Query the database for the list of properties of this class. See Database::get_class_property() for an example
* of how to specify and retrieve the properties.
*
* @param [in,out] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void get_property(DbData &db);
/**
* Update class property in database
*
* Update the list of properties for this class in the database. See Database::put_class_property() for an example
* of how to specify the properties.
*
* @param [in] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void put_property(DbData &db);
/**
* Remove class property from database
*
* Delete the list of specified properties for this class in the database. See Database::delete_property() for an
* example of how to specify the properties.
*
* @param [in] db Property name(s)
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void delete_property(DbData &db);
/**
* Get class attribute property from database
*
* Query the database for the list of attribute properties of this class. See Database::get_class_attribute_property()
* for an example of how to specify and retrieve the properties.
*
* @param [in,out] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void get_attribute_property(DbData &db);
/**
* Update class attribute property in database
*
* Update the list of attribute properties for this class in the database. See Database::put_class_attribute_property()
* for an example of how to specify the properties.
*
* @param [in] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void put_attribute_property(DbData &db);
/**
* Remove class attribute property from database
*
* Delete all properties for the list of specified attributes for this class in the database. See Database::delete_class_attribute_property()
* for an example of how to specify the properties.
*
* @param [in] db Property name(s)
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void delete_attribute_property(DbData &db);
/**
* Get class pipe property from database
*
* Query the database for the list of pipe properties of this class. See Database::get_class_pipe_property()
* for an example of how to specify and retrieve the properties.
*
* @param [in,out] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void get_pipe_property(DbData &db);
/**
* Update class pipe property in database
*
* Update the list of pipe properties for this class in the database. See Database::put_class_pipe_property()
* for an example of how to specify the properties.
*
* @param [in] db Property name(s) and value
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void put_pipe_property(DbData &db);
/**
* Remove class pipe property from database
*
* Delete all properties for the list of specified pipes for this class in the database. See Database::delete_class_pipe_property()
* for an example of how to specify the properties.
*
* @param [in] db Property name(s)
*
* @exception ConnectionFailed, CommunnicationFailed, DevFailed from device
*/
void delete_pipe_property(DbData &db);
//@}
/// @privatesection
~DbClass();
};
/**********************************************************************
* *
* DbDatum - A database object for sending and receiving data *
* from the Tango database API *
* *
**********************************************************************/
/**
* A database value
*
* A single database value which has a name, type, address and value and methods for inserting and extracting
* C++ native types. This is the fundamental type for specifying database properties. Every property has a
* name and has one or more values associated with it. The values can be inserted and extracted using the
* operators << and >> respectively. A status flag indicates if there is data in the DbDatum object or not. An
* additional flag allows the user to activate exceptions.
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbDatum
{
public:
/// @privatesection
enum except_flags
{
isempty_flag,
wrongtype_flag,
numFlags
};
/// @publicsection
/**@name Constructors */
//@{
/**
* Create a DbDatum object.
*
* Create an instance of the DbDatum class with name set to the specified parameter
*
* @param [in] name The CORBA ORB pointer. Default value is fine for 99 % of cases
*
*/
DbDatum (string name);
/**
* Create a DbDatum object.
*
* Create an instance of the DbDatum class with name set to the specified parameter
*
* @param [in] name The CORBA ORB pointer. Default value is fine for 99 % of cases
*
*/
DbDatum (const char *name);
//@}
/**@name Operators overloading */
//@{
/**
* Inserters operators
*
* The insert and extract operators are specified for the following C++ types :
* @li bool
* @li unsigned char
* @li short
* @li unsigned short
* @li DevLong
* @li DevULong
* @li DevLong64
* @li DevULong64
* @li float
* @li double
* @li string
* @li char* (insert only)
* @li const char *
* @li vector<string>
* @li vector<short>
* @li vector<unsigned short>
* @li vector<DevLong>
* @li vector<DevULong>
* @li vector<DevLong64>
* @li vector<DevULong64>
* @li vector<float>
* @li vector<double>
*
* Here is an example of creating, inserting and extracting some DbDatum types :
* @code
* DbDatum my_short("my_short"), my_long(“my_long”), my_string("my_string");
* DbDatum my_float_vector("my_float_vector"), my_double_vector("my_double_vector");
*
* string a_string;
* short a_short;
* DevLong a_long;
* vector<float> a_float_vector;
* vector<double> a_double_vector;
*
* my_short << 100; // insert a short
* my_short >> a_short; // extract a short
* my_long << 1000; // insert a DevLong
* my_long >> a_long; // extract a long
* my_string << string("estas lista a bailar el tango ?"); // insert a string
* my_string >> a_string; // extract a string
* my_float_vector << a_float_vector // insert a vector of floats
* my_float_vector >> a_float_vector; // extract a vector of floats
* my_double_vector << a_double_vector; // insert a vector of doubles
* my_double_vector >> a_double_vector; // extract a vector of doubles
* @endcode
*
* @param [in] val Data to be inserted
*
* @exception WrongData if requested
*/
void operator << (bool val);
/**
* Extractors operators
*
* See documentation of the DbDatum::operator<< for details
*
* @param [out] val Data to be initalized with database value
* @return A boolean set to true if the extraction succeeds
* @exception WrongData if requested
*/
bool operator >> (bool &val);
//@}
/**@name Exception related methods methods */
//@{
/**
* Set exception flag
*
* Is a method which allows the user to switch on/off exception throwing for trying to extract data from an
* empty DbDatum object. The default is to not throw exception. The following flags are supported :
* @li @b isempty_flag - throw a WrongData exception (reason = API_EmptyDbDatum) if user tries to extract
* data from an empty DbDatum object
* @li @b wrongtype_flag - throw a WrongData exception (reason = API_IncompatibleArgumentType) if user
* tries to extract data with a type different than the type used for insertion
*
* @param [in] fl The exception flag
*/
void exceptions(bitset<DbDatum::numFlags> fl) { exceptions_flags = fl;}
/**
* Get exception flag
*
* Returns the whole exception flags.
* The following is an example of how to use these exceptions related methods
* @code
* DbDatum da;
*
* bitset<DbDatum::numFlags> bs = da.exceptions();
* cout << "bs = " << bs << endl;
*
* da.set_exceptions(DbDatum::wrongtype_flag);
* bs = da.exceptions();
*
* cout << "bs = " << bs << endl;
* @endcode
*
* @return The exception flag
*/
bitset<DbDatum::numFlags> exceptions() {return exceptions_flags;}
/**
* Reset one exception flag
*
* Resets one exception flag
*
* @param [in] fl The exception flag
*/
void reset_exceptions(except_flags fl) {exceptions_flags.reset((size_t)fl);}
/**
* Set one exception flag
*
* Sets one exception flag. See DbDatum::exceptions() for a usage example
*
* @param [in] fl The exception flag
*/
void set_exceptions(except_flags fl) {exceptions_flags.set((size_t)fl);}
//@}
/**@name Miscellaneous methods */
//@{
/**
* Test if instance is empty
*
* is_empty() is a boolean method which returns true or false depending on whether the DbDatum object contains
* data or not. It can be used to test whether a property is defined in the database or not e.g.
* @code
* sl_props.push_back(parity_prop);
* dbase->get_device_property(device_name, sl_props);
*
* if (! parity_prop.is_empty())
* {
* parity_prop >> parity;
* }
* else
* {
* cout << device_name << " has no parity defined in database !" << endl;
* }
* @endcode
*
* @return True if DdDatum instance is empty
*
* @exception WrongData if requested
*/
bool is_empty();
//@}
/// @privatesection
string name;
vector<string> value_string;
//
// constructor methods
//
DbDatum();
~DbDatum();
DbDatum(const DbDatum &);
DbDatum &operator=(const DbDatum &);
size_t size() {return value_string.size();}
//
// insert methods
//
void operator << (short);
void operator << (unsigned char);
void operator << (unsigned short);
void operator << (DevLong);
void operator << (DevULong);
void operator << (DevLong64);
void operator << (DevULong64);
void operator << (float);
void operator << (double);
void operator << (char *);
// void operator << (char *&);
void operator << (const char *);
// void operator << (const char *&);
void operator << (string&);
void operator << (vector<string>&);
void operator << (vector<short>&);
void operator << (vector<unsigned short>&);
void operator << (vector<DevLong>&);
void operator << (vector<DevULong>&);
void operator << (vector<DevLong64>&);
void operator << (vector<DevULong64>&);
void operator << (vector<float>&);
void operator << (vector<double>&);
//
// extract methods
//
bool operator >> (short&);
bool operator >> (unsigned char&);
bool operator >> (unsigned short&);
bool operator >> (DevLong&);
bool operator >> (DevULong&);
bool operator >> (DevLong64&);
bool operator >> (DevULong64&);
bool operator >> (float&);
bool operator >> (double&);
bool operator >> (const char*&);
bool operator >> (string&);
bool operator >> (vector<string>&);
bool operator >> (vector<short>&);
bool operator >> (vector<unsigned short>&);
bool operator >> (vector<DevLong>&);
bool operator >> (vector<DevULong>&);
bool operator >> (vector<DevLong64>&);
bool operator >> (vector<DevULong64>&);
bool operator >> (vector<float>&);
bool operator >> (vector<double>&);
private :
int value_type;
int value_size;
bitset<numFlags> exceptions_flags;
class DbDatumExt
{
public:
DbDatumExt() {};
};
#ifdef HAS_UNIQUE_PTR
unique_ptr<DbDatumExt> ext;
#else
DbDatumExt *ext;
#endif
};
/**********************************************************************
* *
* DbHistory - A data object for receiving data history from the *
* Tango database *
* *
**********************************************************************/
/**
* Class used to retrieve database object history
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbHistory
{
public:
//
// constructor methods
//
DbHistory(string ,string ,vector<string> &);
DbHistory(string ,string ,string ,vector<string> &);
//
// getter methods
//
/**
* Get property name
*
* @return The property name
*/
string get_name();
/**
* Get attribute name
*
* @return The attribute name
*/
string get_attribute_name();
/**
* Get change date
*
* @return The date
*/
string get_date();
/**
* Get value
*
* @return The property value
*/
DbDatum get_value();
/**
* Get property deleted flag
*
* @return The property deleted flag
*/
bool is_deleted();
private:
string propname; // Property name
string attname; // Attribute name (Not used for device/pipe properties)
DbDatum value; // Property value
string date; // Update date
bool deleted; // Deleted flag
string format_mysql_date(string );
void make_db_datum(vector<string> &);
};
/**********************************************************************
* *
* DbDevInfo *
* *
**********************************************************************/
/**
* Device information for Database device creation
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbDevInfo
{
public :
string name; ///< The device name
string _class; ///< The device class name
string server; ///< The full device server process name
};
/**********************************************************************
* *
* DbDevImportInfo *
* *
**********************************************************************/
/**
* Device import information from the database
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbDevImportInfo
{
public :
string name; ///< The device name
long exported; ///< The exported flag
string ior; ///< The device IOR
string version; ///< The device version (as a string)
};
/****************************************************************
* *
* DbDevFullInfo *
* *
****************************************************************/
/**
* Device information from the database
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbDevFullInfo: public DbDevImportInfo
{
public :
string class_name; ///< The device class name
string ds_full_name; ///< The full device server process name
string host; ///< The host name where the device server process is running
string started_date; ///< Date of the last device export (empty if not set in DB)
string stopped_date; ///< Date of the last device un-export (empty if not set in DB)
long pid; ///< The device server process PID (-1 if not set in DB)
};
/**********************************************************************
* *
* DbDevExportInfo *
* *
**********************************************************************/
/**
* Device export information to the database
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbDevExportInfo
{
public :
string name; ///< The device name
string ior; ///< The device IOR
string host; ///< The host name where the device server process runs
string version; ///< The device version
int pid; ///< The device server process PID
};
/**********************************************************************
* *
* DbServerInfo *
* *
**********************************************************************/
class DbServerInfo
{
public :
string name;
string host;
int mode;
int level;
};
/****************************************************************************************
* *
* The DbServerCache class *
* ------------------ *
* *
***************************************************************************************/
//
// DbServerCache data object to implement a DB cache
// used during the DS startup sequence
//
class DbServerCache
{
public:
typedef struct
{
int first_idx;
int last_idx;
}EltIdx;
typedef struct
{
int first_idx;
int last_idx;
int prop_nb;
int *props_idx;
}PropEltIdx;
typedef struct
{
int first_idx;
int last_idx;
int att_nb;
int *atts_idx;
}AttPropEltIdx;
typedef struct
{
PropEltIdx dev_prop;
AttPropEltIdx dev_att_prop;
AttPropEltIdx dev_pipe_prop;
}DevEltIdx;
typedef struct
{
PropEltIdx class_prop;
AttPropEltIdx class_att_prop;
AttPropEltIdx class_pipe_prop;
EltIdx dev_list;
int dev_nb;
DevEltIdx *devs_idx;
}ClassEltIdx;
DbServerCache(Database *,string &,string &);
~DbServerCache();
const DevVarLongStringArray *import_adm_dev();
const DevVarLongStringArray *import_notifd_event();
const DevVarLongStringArray *import_adm_event();
const DevVarStringArray *get_class_property(DevVarStringArray *);
const DevVarStringArray *get_dev_property(DevVarStringArray *);
const DevVarStringArray *get_dev_list(DevVarStringArray *);
const DevVarStringArray *get_class_att_property(DevVarStringArray *);
const DevVarStringArray *get_dev_att_property(DevVarStringArray *);
const DevVarStringArray *get_obj_property(DevVarStringArray *);
const DevVarStringArray *get_device_property_list(DevVarStringArray *);
const DevVarStringArray *get_class_pipe_property(DevVarStringArray *);
const DevVarStringArray *get_dev_pipe_property(DevVarStringArray *);
const DevVarLongStringArray *import_tac_dev(string &);
const EltIdx &get_imp_dat() {return imp_adm;}
const EltIdx &get_imp_notifd_event() {return imp_notifd_event;}
const EltIdx &get_imp_adm_event() {return imp_adm_event;}
const PropEltIdx &get_DServer_class_prop() {return DServer_class_prop;}
const PropEltIdx &get_Default_prop() {return Default_prop;}
const PropEltIdx &get_adm_dev_prop() {return adm_dev_prop;}
const PropEltIdx &get_ctrl_serv_prop() {return ctrl_serv_prop;}
int get_class_nb() {return class_nb;}
const ClassEltIdx *get_classes_elt() {return classes_idx;}
int get_data_nb() {return n_data;}
private:
void prop_indexes(int &,int &,PropEltIdx &,const DevVarStringArray *);
void prop_att_indexes(int &,int &,AttPropEltIdx &,const DevVarStringArray *);
void prop_pipe_indexes(int &,int &,AttPropEltIdx &,const DevVarStringArray *);
void get_obj_prop(DevVarStringArray *,PropEltIdx &,bool dev_prop=false);
int find_class(DevString );
int find_dev_att(DevString,int &,int &);
int find_obj(DevString obj_name,int &);
void get_obj_prop_list(DevVarStringArray *,PropEltIdx &);
CORBA::Any_var received;
const DevVarStringArray *data_list;
int n_data;
int proc_release;
EltIdx imp_adm;
EltIdx imp_notifd_event;
EltIdx imp_adm_event;
EltIdx imp_tac;
PropEltIdx ctrl_serv_prop;
PropEltIdx DServer_class_prop;
PropEltIdx Default_prop;
PropEltIdx adm_dev_prop;
int class_nb;
ClassEltIdx *classes_idx;
DevVarLongStringArray imp_adm_data;
DevVarLongStringArray imp_notifd_event_data;
DevVarLongStringArray imp_adm_event_data;
DevVarLongStringArray imp_tac_data;
DevVarStringArray ret_obj_prop;
DevVarStringArray ret_dev_list;
DevVarStringArray ret_obj_att_prop;
DevVarStringArray ret_obj_pipe_prop;
DevVarStringArray ret_prop_list;
};
/****************************************************************************************
* *
* The DbServerData class *
* ---------------- *
* *
***************************************************************************************/
//
// DbServerData object to implement the features required to move a complete device server proces
// configuration from one database to another one
//
/**
* Class used to move/copy a complete device server process database configuration
* from one Tango host to another
*
* @headerfile tango.h
* @ingroup DBase
*/
class DbServerData
{
private:
struct TangoProperty
{
string name;
vector<string> values;
TangoProperty(string &na, vector<string> &val):name(na),values(val) {}
};
struct TangoAttribute: vector<TangoProperty>
{
string name;
TangoAttribute(string na):name(na) {}
};
struct TangoPipe: vector<TangoProperty>
{
string name;
TangoPipe(string na):name(na) {}
};
struct TangoDevice: DeviceProxy
{
string name;
vector<TangoProperty> properties;
vector<TangoAttribute> attributes;
vector<TangoPipe> pipes;
TangoDevice(string &);
string get_name() {return name;}
vector<TangoProperty> &get_properties() {return properties;}
vector<TangoAttribute> &get_attributes() {return attributes;}
vector<TangoPipe> &get_pipes() {return pipes;}
void put_properties(Database *);
void put_attribute_properties(Database *);
void put_pipe_properties(Database *);
};
struct TangoClass: vector<TangoDevice>
{
string name;
vector<TangoProperty> properties;
vector<TangoAttribute> attributes;
vector<TangoPipe> pipes;
TangoClass(const string &,const string &,Database *);
string get_name() {return name;}
vector<TangoProperty> &get_properties() {return properties;}
vector<TangoAttribute> &get_attributes() {return attributes;}
vector<TangoPipe> &get_pipes() {return pipes;}
void put_properties(Database *);
void put_attribute_properties(Database *);
void put_pipe_properties(Database *);
void remove_properties(Database *);
};
void create_server(Database *);
void put_properties(Database *);
string full_server_name;
vector<TangoClass> classes;
public:
/**
* Create a DbServerData instance.
*
* A constructor for a DbServerData object for a device server process defined in the TANGO database specified by
* the TANGO_HOST environment variable
*
* @param [in] ds_exec_name The device server process executable name
* @param [in] ds_inst_name The device server process instance name
*
*/
DbServerData(const string &ds_exec_name,const string &ds_inst_name);
/**
* Check if device(s) already defined
*
* Return true if one of the device defined in the device server process with configuration in this instance is
* already defined in the database defined by the Tango host given as parameter
*
* @param [in] tg_host The tango host
* @return Boolean set to true if one of the device server device is defined in the Tango host given as parameter
*/
bool already_exist(const string &tg_host);
/**
* Put device server database configuration in new Tango host
*
* Store the device server process database configuration in the database specified by the given Tango host parameter
*
* @param [in] tg_host The tango host
*/
void put_in_database(const string &tg_host);
/**
* Remove device server database configuration from Tango host
*
* Remove the device server process database configuration from the database specified by the given Tango host parameter
*
* @param [in] tg_host The tango host
*/
void remove(const string &tg_host);
/**
* Remove device server database configuration from default Tango host
*
* Remove the device server process database configuration from the database specified by the environment variable
* TANGO_HOST
*
*/
void remove();
///@privatesection
~DbServerData() {}
const string &get_name() {return full_server_name;}
vector<TangoClass> &get_classes() {return classes;}
};
/*
// Some macros to call the Db server
// These macros will do some retries in case of
// timeout while calling the DB device
// This is necessary in case of massive DS
// startup (after a power cut for instance)
// when the Db is over-loaded
*/
#define MANAGE_EXCEPT(NAME) \
catch (Tango::CommunicationFailed &e) \
{ \
if (e.errors.length() >= 2) \
{ \
if (::strcmp(e.errors[1].reason.in(),"API_DeviceTimedOut") == 0) \
{ \
if (db_retries != 0) \
{ \
db_retries--; \
if (db_retries == 0) \
throw; \
} \
else \
throw; \
} \
else \
throw; \
} \
else \
throw; \
}
#define CALL_DB_SERVER_NO_RET(NAME,SEND) \
{ \
bool retry_mac = true; \
long db_retries = 0; \
if (db_tg != NULL) \
{ \
if (db_tg->is_svr_starting() == true) \
db_retries = DB_START_PHASE_RETRIES; \
} \
while (retry_mac == true) \
{ \
try \
{ \
command_inout(NAME,SEND); \
retry_mac = false; \
} \
MANAGE_EXCEPT(NAME) \
} \
}
#define CALL_DB_SERVER(NAME,SEND,RET) \
{ \
bool retry_mac = true; \
long db_retries = 0; \
if (db_tg != NULL) \
{ \
if (db_tg->is_svr_starting() == true) \
db_retries = DB_START_PHASE_RETRIES; \
} \
while (retry_mac == true) \
{ \
try \
{ \
RET = command_inout(NAME,SEND); \
retry_mac = false; \
} \
MANAGE_EXCEPT(NAME) \
} \
}
} // End of Tango namespace
#endif /* _DBAPI_H */
|