NCBI C++ Toolkit Cross Reference

  C++/include/objects/entrez2/Entrez2_db_info_.hpp


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
/* $Id$ * =========================================================================== * * PUBLIC DOMAIN NOTICE * National Center for Biotechnology Information * * This software/database is a "United States Government Work" under the * terms of the United States Copyright Act. It was written as part of * the author's official duties as a United States Government employee and * thus cannot be copyrighted. This software/database is freely available * to the public for use. The National Library of Medicine and the U.S. * Government have not placed any restriction on its use or reproduction. * * Although all reasonable efforts have been taken to ensure the accuracy * and reliability of the software and data, the NLM and the U.S. * Government do not and cannot warrant the performance or results that * may be obtained by using this software or data. The NLM and the U.S. * Government disclaim all warranties, express or implied, including * warranties of performance, merchantability or fitness for any particular * purpose. * * Please cite the author in any work or product based on this material. * * =========================================================================== * */ /// @file Entrez2_db_info_.hpp /// Data storage class. /// /// This file was generated by application DATATOOL /// using the following specifications: /// 'entrez2.asn'. /// /// ATTENTION: /// Don't edit or commit this file into CVS as this file will /// be overridden (by DATATOOL) without warning! #ifndef OBJECTS_ENTREZ2_ENTREZ2_DB_INFO_BASE_HPP #define OBJECTS_ENTREZ2_ENTREZ2_DB_INFO_BASE_HPP // standard includes #include <serial/serialbase.hpp> // generated includes #include <list> #include <string> #include <objects/entrez2/Entrez2_db_id.hpp> BEGIN_NCBI_SCOPE #ifndef BEGIN_objects_SCOPE # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects) # define END_objects_SCOPE END_SCOPE(objects) #endif BEGIN_objects_SCOPE // namespace ncbi::objects:: // forward declarations class CEntrez2_docsum_field_info; class CEntrez2_field_info; class CEntrez2_link_info; // generated classes ///////////////////////////////////////////////////////////////////////////// /// info for one database class NCBI_ENTREZ2_EXPORT CEntrez2_db_info_Base : public CSerialObject { typedef CSerialObject Tparent; public: // constructor CEntrez2_db_info_Base(void); // destructor virtual ~CEntrez2_db_info_Base(void); // type info DECLARE_INTERNAL_TYPE_INFO(); // types typedef CEntrez2_db_id TDb_name; typedef string TDb_menu; typedef string TDb_descr; typedef int TDoc_count; typedef int TField_count; typedef list< CRef< CEntrez2_field_info > > TFields; typedef int TLink_count; typedef list< CRef< CEntrez2_link_info > > TLinks; typedef int TDocsum_field_count; typedef list< CRef< CEntrez2_docsum_field_info > > TDocsum_fields; // member index enum class E_memberIndex { e__allMandatory = 0, e_db_name, e_db_menu, e_db_descr, e_doc_count, e_field_count, e_fields, e_link_count, e_links, e_docsum_field_count, e_docsum_fields }; typedef Tparent::CMemberIndex<E_memberIndex, 11> TmemberIndex; // getters // setters /// internal name /// mandatory /// typedef CEntrez2_db_id TDb_name /// Check whether the Db_name data member has been assigned a value. bool IsSetDb_name(void) const; /// Check whether it is safe or not to call GetDb_name method. bool CanGetDb_name(void) const; void ResetDb_name(void); const TDb_name& GetDb_name(void) const; void SetDb_name(const TDb_name& value); TDb_name& SetDb_name(void); /// short name for menu /// mandatory /// typedef string TDb_menu /// Check whether the Db_menu data member has been assigned a value. bool IsSetDb_menu(void) const; /// Check whether it is safe or not to call GetDb_menu method. bool CanGetDb_menu(void) const; void ResetDb_menu(void); const TDb_menu& GetDb_menu(void) const; void SetDb_menu(const TDb_menu& value); TDb_menu& SetDb_menu(void); /// longer explanatory name /// mandatory /// typedef string TDb_descr /// Check whether the Db_descr data member has been assigned a value. bool IsSetDb_descr(void) const; /// Check whether it is safe or not to call GetDb_descr method. bool CanGetDb_descr(void) const; void ResetDb_descr(void); const TDb_descr& GetDb_descr(void) const; void SetDb_descr(const TDb_descr& value); TDb_descr& SetDb_descr(void); /// total number of records /// mandatory /// typedef int TDoc_count /// Check whether the Doc_count data member has been assigned a value. bool IsSetDoc_count(void) const; /// Check whether it is safe or not to call GetDoc_count method. bool CanGetDoc_count(void) const; void ResetDoc_count(void); TDoc_count GetDoc_count(void) const; void SetDoc_count(TDoc_count value); TDoc_count& SetDoc_count(void); /// number of field types /// mandatory /// typedef int TField_count /// Check whether the Field_count data member has been assigned a value. bool IsSetField_count(void) const; /// Check whether it is safe or not to call GetField_count method. bool CanGetField_count(void) const; void ResetField_count(void); TField_count GetField_count(void) const; void SetField_count(TField_count value); TField_count& SetField_count(void); /// mandatory /// typedef list< CRef< CEntrez2_field_info > > TFields /// Check whether the Fields data member has been assigned a value. bool IsSetFields(void) const; /// Check whether it is safe or not to call GetFields method. bool CanGetFields(void) const; void ResetFields(void); const TFields& GetFields(void) const; TFields& SetFields(void); /// number of link types /// mandatory /// typedef int TLink_count /// Check whether the Link_count data member has been assigned a value. bool IsSetLink_count(void) const; /// Check whether it is safe or not to call GetLink_count method. bool CanGetLink_count(void) const; void ResetLink_count(void); TLink_count GetLink_count(void) const; void SetLink_count(TLink_count value); TLink_count& SetLink_count(void); /// mandatory /// typedef list< CRef< CEntrez2_link_info > > TLinks /// Check whether the Links data member has been assigned a value. bool IsSetLinks(void) const; /// Check whether it is safe or not to call GetLinks method. bool CanGetLinks(void) const; void ResetLinks(void); const TLinks& GetLinks(void) const; TLinks& SetLinks(void); /// mandatory /// typedef int TDocsum_field_count /// Check whether the Docsum_field_count data member has been assigned a value. bool IsSetDocsum_field_count(void) const; /// Check whether it is safe or not to call GetDocsum_field_count method. bool CanGetDocsum_field_count(void) const; void ResetDocsum_field_count(void); TDocsum_field_count GetDocsum_field_count(void) const; void SetDocsum_field_count(TDocsum_field_count value); TDocsum_field_count& SetDocsum_field_count(void); /// mandatory /// typedef list< CRef< CEntrez2_docsum_field_info > > TDocsum_fields /// Check whether the Docsum_fields data member has been assigned a value. bool IsSetDocsum_fields(void) const; /// Check whether it is safe or not to call GetDocsum_fields method. bool CanGetDocsum_fields(void) const; void ResetDocsum_fields(void); const TDocsum_fields& GetDocsum_fields(void) const; TDocsum_fields& SetDocsum_fields(void); /// Reset the whole object virtual void Reset(void); private: // Prohibit copy constructor and assignment operator CEntrez2_db_info_Base(const CEntrez2_db_info_Base&); CEntrez2_db_info_Base& operator=(const CEntrez2_db_info_Base&); // data Uint4 m_set_State[1]; CEntrez2_db_id m_Db_name; string m_Db_menu; string m_Db_descr; int m_Doc_count; int m_Field_count; list< CRef< CEntrez2_field_info > > m_Fields; int m_Link_count; list< CRef< CEntrez2_link_info > > m_Links; int m_Docsum_field_count; list< CRef< CEntrez2_docsum_field_info > > m_Docsum_fields; }; /////////////////////////////////////////////////////////// ///////////////////// inline methods ////////////////////// /////////////////////////////////////////////////////////// inline bool CEntrez2_db_info_Base::IsSetDb_name(void) const { return ((m_set_State[0] & 0x3) != 0); } inline bool CEntrez2_db_info_Base::CanGetDb_name(void) const { return IsSetDb_name(); } inline const CEntrez2_db_info_Base::TDb_name& CEntrez2_db_info_Base::GetDb_name(void) const { if (!CanGetDb_name()) { ThrowUnassigned(0); } return m_Db_name; } inline void CEntrez2_db_info_Base::SetDb_name(const CEntrez2_db_info_Base::TDb_name& value) { m_Db_name = value; m_set_State[0] |= 0x3; } inline CEntrez2_db_info_Base::TDb_name& CEntrez2_db_info_Base::SetDb_name(void) { m_set_State[0] |= 0x1; return m_Db_name; } inline bool CEntrez2_db_info_Base::IsSetDb_menu(void) const { return ((m_set_State[0] & 0xc) != 0); } inline bool CEntrez2_db_info_Base::CanGetDb_menu(void) const { return IsSetDb_menu(); } inline const CEntrez2_db_info_Base::TDb_menu& CEntrez2_db_info_Base::GetDb_menu(void) const { if (!CanGetDb_menu()) { ThrowUnassigned(1); } return m_Db_menu; } inline void CEntrez2_db_info_Base::SetDb_menu(const CEntrez2_db_info_Base::TDb_menu& value) { m_Db_menu = value; m_set_State[0] |= 0xc; } inline CEntrez2_db_info_Base::TDb_menu& CEntrez2_db_info_Base::SetDb_menu(void) { #ifdef _DEBUG if (!IsSetDb_menu()) { m_Db_menu = UnassignedString(); } #endif m_set_State[0] |= 0x4; return m_Db_menu; } inline bool CEntrez2_db_info_Base::IsSetDb_descr(void) const { return ((m_set_State[0] & 0x30) != 0); } inline bool CEntrez2_db_info_Base::CanGetDb_descr(void) const { return IsSetDb_descr(); } inline const CEntrez2_db_info_Base::TDb_descr& CEntrez2_db_info_Base::GetDb_descr(void) const { if (!CanGetDb_descr()) { ThrowUnassigned(2); } return m_Db_descr; } inline void CEntrez2_db_info_Base::SetDb_descr(const CEntrez2_db_info_Base::TDb_descr& value) { m_Db_descr = value; m_set_State[0] |= 0x30; } inline CEntrez2_db_info_Base::TDb_descr& CEntrez2_db_info_Base::SetDb_descr(void) { #ifdef _DEBUG if (!IsSetDb_descr()) { m_Db_descr = UnassignedString(); } #endif m_set_State[0] |= 0x10; return m_Db_descr; } inline bool CEntrez2_db_info_Base::IsSetDoc_count(void) const { return ((m_set_State[0] & 0xc0) != 0); } inline bool CEntrez2_db_info_Base::CanGetDoc_count(void) const { return IsSetDoc_count(); } inline void CEntrez2_db_info_Base::ResetDoc_count(void) { m_Doc_count = 0; m_set_State[0] &= ~0xc0; } inline CEntrez2_db_info_Base::TDoc_count CEntrez2_db_info_Base::GetDoc_count(void) const { if (!CanGetDoc_count()) { ThrowUnassigned(3); } return m_Doc_count; } inline void CEntrez2_db_info_Base::SetDoc_count(CEntrez2_db_info_Base::TDoc_count value) { m_Doc_count = value; m_set_State[0] |= 0xc0; } inline CEntrez2_db_info_Base::TDoc_count& CEntrez2_db_info_Base::SetDoc_count(void) { #ifdef _DEBUG if (!IsSetDoc_count()) { memset(&m_Doc_count,UnassignedByte(),sizeof(m_Doc_count)); } #endif m_set_State[0] |= 0x40; return m_Doc_count; } inline bool CEntrez2_db_info_Base::IsSetField_count(void) const { return ((m_set_State[0] & 0x300) != 0); } inline bool CEntrez2_db_info_Base::CanGetField_count(void) const { return IsSetField_count(); } inline void CEntrez2_db_info_Base::ResetField_count(void) { m_Field_count = 0; m_set_State[0] &= ~0x300; } inline CEntrez2_db_info_Base::TField_count CEntrez2_db_info_Base::GetField_count(void) const { if (!CanGetField_count()) { ThrowUnassigned(4); } return m_Field_count; } inline void CEntrez2_db_info_Base::SetField_count(CEntrez2_db_info_Base::TField_count value) { m_Field_count = value; m_set_State[0] |= 0x300; } inline CEntrez2_db_info_Base::TField_count& CEntrez2_db_info_Base::SetField_count(void) { #ifdef _DEBUG if (!IsSetField_count()) { memset(&m_Field_count,UnassignedByte(),sizeof(m_Field_count)); } #endif m_set_State[0] |= 0x100; return m_Field_count; } inline bool CEntrez2_db_info_Base::IsSetFields(void) const { return ((m_set_State[0] & 0xc00) != 0); } inline bool CEntrez2_db_info_Base::CanGetFields(void) const { return true; } inline const CEntrez2_db_info_Base::TFields& CEntrez2_db_info_Base::GetFields(void) const { return m_Fields; } inline CEntrez2_db_info_Base::TFields& CEntrez2_db_info_Base::SetFields(void) { m_set_State[0] |= 0x400; return m_Fields; } inline bool CEntrez2_db_info_Base::IsSetLink_count(void) const { return ((m_set_State[0] & 0x3000) != 0); } inline bool CEntrez2_db_info_Base::CanGetLink_count(void) const { return IsSetLink_count(); } inline void CEntrez2_db_info_Base::ResetLink_count(void) { m_Link_count = 0; m_set_State[0] &= ~0x3000; } inline CEntrez2_db_info_Base::TLink_count CEntrez2_db_info_Base::GetLink_count(void) const { if (!CanGetLink_count()) { ThrowUnassigned(6); } return m_Link_count; } inline void CEntrez2_db_info_Base::SetLink_count(CEntrez2_db_info_Base::TLink_count value) { m_Link_count = value; m_set_State[0] |= 0x3000; } inline CEntrez2_db_info_Base::TLink_count& CEntrez2_db_info_Base::SetLink_count(void) { #ifdef _DEBUG if (!IsSetLink_count()) { memset(&m_Link_count,UnassignedByte(),sizeof(m_Link_count)); } #endif m_set_State[0] |= 0x1000; return m_Link_count; } inline bool CEntrez2_db_info_Base::IsSetLinks(void) const { return ((m_set_State[0] & 0xc000) != 0); } inline bool CEntrez2_db_info_Base::CanGetLinks(void) const { return true; } inline const CEntrez2_db_info_Base::TLinks& CEntrez2_db_info_Base::GetLinks(void) const { return m_Links; } inline CEntrez2_db_info_Base::TLinks& CEntrez2_db_info_Base::SetLinks(void) { m_set_State[0] |= 0x4000; return m_Links; } inline bool CEntrez2_db_info_Base::IsSetDocsum_field_count(void) const { return ((m_set_State[0] & 0x30000) != 0); } inline bool CEntrez2_db_info_Base::CanGetDocsum_field_count(void) const { return IsSetDocsum_field_count(); } inline void CEntrez2_db_info_Base::ResetDocsum_field_count(void) { m_Docsum_field_count = 0; m_set_State[0] &= ~0x30000; } inline CEntrez2_db_info_Base::TDocsum_field_count CEntrez2_db_info_Base::GetDocsum_field_count(void) const { if (!CanGetDocsum_field_count()) { ThrowUnassigned(8); } return m_Docsum_field_count; } inline void CEntrez2_db_info_Base::SetDocsum_field_count(CEntrez2_db_info_Base::TDocsum_field_count value) { m_Docsum_field_count = value; m_set_State[0] |= 0x30000; } inline CEntrez2_db_info_Base::TDocsum_field_count& CEntrez2_db_info_Base::SetDocsum_field_count(void) { #ifdef _DEBUG if (!IsSetDocsum_field_count()) { memset(&m_Docsum_field_count,UnassignedByte(),sizeof(m_Docsum_field_count)); } #endif m_set_State[0] |= 0x10000; return m_Docsum_field_count; } inline bool CEntrez2_db_info_Base::IsSetDocsum_fields(void) const { return ((m_set_State[0] & 0xc0000) != 0); } inline bool CEntrez2_db_info_Base::CanGetDocsum_fields(void) const { return true; } inline const CEntrez2_db_info_Base::TDocsum_fields& CEntrez2_db_info_Base::GetDocsum_fields(void) const { return m_Docsum_fields; } inline CEntrez2_db_info_Base::TDocsum_fields& CEntrez2_db_info_Base::SetDocsum_fields(void) { m_set_State[0] |= 0x40000; return m_Docsum_fields; } /////////////////////////////////////////////////////////// ////////////////// end of inline methods ////////////////// /////////////////////////////////////////////////////////// END_objects_SCOPE // namespace ncbi::objects:: END_NCBI_SCOPE #endif // OBJECTS_ENTREZ2_ENTREZ2_DB_INFO_BASE_HPP

source navigation ]   [ diff markup ]   [ identifier search ]   [ freetext search ]   [ file search ]  

This page was automatically generated by the LXR engine.
Visit the LXR main site for more information.