NCBI C++ ToolKit
Search_database_.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id$
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file Search_database_.hpp
29 /// Data storage class.
30 ///
31 /// This file was generated by application DATATOOL
32 /// using the following specifications:
33 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.xsd">pepXML.xsd</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.def">pepXML.def</a>
36 ///
37 /// ATTENTION:
38 /// Don't edit or commit this file into CVS as this file will
39 /// be overridden (by DATATOOL) without warning!
40 
41 #ifndef ALGO_MS_FORMATS_PEPXML_SEARCH_DATABASE_BASE_HPP
42 #define ALGO_MS_FORMATS_PEPXML_SEARCH_DATABASE_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
49 
51 
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
55 #endif
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57 
58 
59 // generated classes
60 
61 
62 /** @addtogroup dataspec_pepXML
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///
69 /// CSearch_database_Base --
70 ///
71 
73 {
75 public:
76  // constructor
78  // destructor
79  virtual ~CSearch_database_Base(void);
80 
81  // type info
83 
84  /////////////////////////////////////////////////////////////////////////////
85  ///
86  /// C_Attlist --
87  ///
88 
90  {
92  public:
93  // constructor
94  C_Attlist(void);
95  // destructor
96  ~C_Attlist(void);
97 
98  // type info
100 
102  eAttlist_type_AA = 1,
103  eAttlist_type_NA = 2
104  };
105 
106  /// Access to EAttlist_type's attributes (values, names) as defined in spec
107  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_type)(void);
108 
109  // types
110  typedef string TLocal_path;
111  typedef string TURL;
112  typedef string TDatabase_name;
113  typedef string TOrig_database_url;
114  typedef string TDatabase_release_date;
116  typedef int TSize_in_db_entries;
117  typedef int TSize_of_residues;
119 
120  // member index
121  enum class E_memberIndex {
122  e__allMandatory = 0,
123  e_local_path,
124  e_URL,
125  e_database_name,
126  e_orig_database_url,
127  e_database_release_date,
128  e_database_release_identifier,
129  e_size_in_db_entries,
130  e_size_of_residues,
131  e_type
132  };
134 
135  // getters
136  // setters
137 
138  /// Check if a value has been assigned to Local_path data member.
139  ///
140  /// Data member Local_path is mandatory;
141  /// its type is defined as 'typedef string TLocal_path'
142  /// @return
143  /// - true, if a value has been assigned.
144  /// - false, otherwise.
145  bool IsSetLocal_path(void) const;
146 
147  /// Check if it is safe to call GetLocal_path method.
148  ///
149  /// @return
150  /// - true, if the data member is getatable.
151  /// - false, otherwise.
152  bool CanGetLocal_path(void) const;
153 
154  /// Reset Local_path data member.
155  void ResetLocal_path(void);
156 
157  /// Get the Local_path member data.
158  ///
159  /// @return
160  /// Reference to the member data.
161  const TLocal_path& GetLocal_path(void) const;
162 
163  /// Assign a value to Local_path data member.
164  ///
165  /// @param value
166  /// Value to assign
167  void SetLocal_path(const TLocal_path& value);
168  void SetLocal_path(TLocal_path&& value);
169 
170  /// Assign a value to Local_path data member.
171  ///
172  /// @return
173  /// Reference to the data value.
174  TLocal_path& SetLocal_path(void);
175 
176  /// Check if a value has been assigned to URL data member.
177  ///
178  /// Data member URL is optional;
179  /// its type is defined as 'typedef string TURL'
180  /// @return
181  /// - true, if a value has been assigned.
182  /// - false, otherwise.
183  bool IsSetURL(void) const;
184 
185  /// Check if it is safe to call GetURL method.
186  ///
187  /// @return
188  /// - true, if the data member is getatable.
189  /// - false, otherwise.
190  bool CanGetURL(void) const;
191 
192  /// Reset URL data member.
193  void ResetURL(void);
194 
195  /// Get the URL member data.
196  ///
197  /// @return
198  /// Reference to the member data.
199  const TURL& GetURL(void) const;
200 
201  /// Assign a value to URL data member.
202  ///
203  /// @param value
204  /// Value to assign
205  void SetURL(const TURL& value);
206  void SetURL(TURL&& value);
207 
208  /// Assign a value to URL data member.
209  ///
210  /// @return
211  /// Reference to the data value.
212  TURL& SetURL(void);
213 
214  /// Check if a value has been assigned to Database_name data member.
215  ///
216  /// Data member Database_name is optional;
217  /// its type is defined as 'typedef string TDatabase_name'
218  /// @return
219  /// - true, if a value has been assigned.
220  /// - false, otherwise.
221  bool IsSetDatabase_name(void) const;
222 
223  /// Check if it is safe to call GetDatabase_name method.
224  ///
225  /// @return
226  /// - true, if the data member is getatable.
227  /// - false, otherwise.
228  bool CanGetDatabase_name(void) const;
229 
230  /// Reset Database_name data member.
231  void ResetDatabase_name(void);
232 
233  /// Get the Database_name member data.
234  ///
235  /// @return
236  /// Reference to the member data.
237  const TDatabase_name& GetDatabase_name(void) const;
238 
239  /// Assign a value to Database_name data member.
240  ///
241  /// @param value
242  /// Value to assign
243  void SetDatabase_name(const TDatabase_name& value);
244  void SetDatabase_name(TDatabase_name&& value);
245 
246  /// Assign a value to Database_name data member.
247  ///
248  /// @return
249  /// Reference to the data value.
250  TDatabase_name& SetDatabase_name(void);
251 
252  /// Check if a value has been assigned to Orig_database_url data member.
253  ///
254  /// Data member Orig_database_url is optional;
255  /// its type is defined as 'typedef string TOrig_database_url'
256  /// @return
257  /// - true, if a value has been assigned.
258  /// - false, otherwise.
259  bool IsSetOrig_database_url(void) const;
260 
261  /// Check if it is safe to call GetOrig_database_url method.
262  ///
263  /// @return
264  /// - true, if the data member is getatable.
265  /// - false, otherwise.
266  bool CanGetOrig_database_url(void) const;
267 
268  /// Reset Orig_database_url data member.
269  void ResetOrig_database_url(void);
270 
271  /// Get the Orig_database_url member data.
272  ///
273  /// @return
274  /// Reference to the member data.
275  const TOrig_database_url& GetOrig_database_url(void) const;
276 
277  /// Assign a value to Orig_database_url data member.
278  ///
279  /// @param value
280  /// Value to assign
281  void SetOrig_database_url(const TOrig_database_url& value);
282  void SetOrig_database_url(TOrig_database_url&& value);
283 
284  /// Assign a value to Orig_database_url data member.
285  ///
286  /// @return
287  /// Reference to the data value.
288  TOrig_database_url& SetOrig_database_url(void);
289 
290  /// Check if a value has been assigned to Database_release_date data member.
291  ///
292  /// Data member Database_release_date is optional;
293  /// its type is defined as 'typedef string TDatabase_release_date'
294  /// @return
295  /// - true, if a value has been assigned.
296  /// - false, otherwise.
297  bool IsSetDatabase_release_date(void) const;
298 
299  /// Check if it is safe to call GetDatabase_release_date method.
300  ///
301  /// @return
302  /// - true, if the data member is getatable.
303  /// - false, otherwise.
304  bool CanGetDatabase_release_date(void) const;
305 
306  /// Reset Database_release_date data member.
307  void ResetDatabase_release_date(void);
308 
309  /// Get the Database_release_date member data.
310  ///
311  /// @return
312  /// Reference to the member data.
313  const TDatabase_release_date& GetDatabase_release_date(void) const;
314 
315  /// Assign a value to Database_release_date data member.
316  ///
317  /// @param value
318  /// Value to assign
319  void SetDatabase_release_date(const TDatabase_release_date& value);
320  void SetDatabase_release_date(TDatabase_release_date&& value);
321 
322  /// Assign a value to Database_release_date data member.
323  ///
324  /// @return
325  /// Reference to the data value.
326  TDatabase_release_date& SetDatabase_release_date(void);
327 
328  /// Check if a value has been assigned to Database_release_identifier data member.
329  ///
330  /// Data member Database_release_identifier is optional;
331  /// its type is defined as 'typedef string TDatabase_release_identifier'
332  /// @return
333  /// - true, if a value has been assigned.
334  /// - false, otherwise.
335  bool IsSetDatabase_release_identifier(void) const;
336 
337  /// Check if it is safe to call GetDatabase_release_identifier method.
338  ///
339  /// @return
340  /// - true, if the data member is getatable.
341  /// - false, otherwise.
342  bool CanGetDatabase_release_identifier(void) const;
343 
344  /// Reset Database_release_identifier data member.
345  void ResetDatabase_release_identifier(void);
346 
347  /// Get the Database_release_identifier member data.
348  ///
349  /// @return
350  /// Reference to the member data.
351  const TDatabase_release_identifier& GetDatabase_release_identifier(void) const;
352 
353  /// Assign a value to Database_release_identifier data member.
354  ///
355  /// @param value
356  /// Value to assign
357  void SetDatabase_release_identifier(const TDatabase_release_identifier& value);
358  void SetDatabase_release_identifier(TDatabase_release_identifier&& value);
359 
360  /// Assign a value to Database_release_identifier data member.
361  ///
362  /// @return
363  /// Reference to the data value.
364  TDatabase_release_identifier& SetDatabase_release_identifier(void);
365 
366  /// Check if a value has been assigned to Size_in_db_entries data member.
367  ///
368  /// Data member Size_in_db_entries is optional;
369  /// its type is defined as 'typedef int TSize_in_db_entries'
370  /// @return
371  /// - true, if a value has been assigned.
372  /// - false, otherwise.
373  bool IsSetSize_in_db_entries(void) const;
374 
375  /// Check if it is safe to call GetSize_in_db_entries method.
376  ///
377  /// @return
378  /// - true, if the data member is getatable.
379  /// - false, otherwise.
380  bool CanGetSize_in_db_entries(void) const;
381 
382  /// Reset Size_in_db_entries data member.
383  void ResetSize_in_db_entries(void);
384 
385  /// Get the Size_in_db_entries member data.
386  ///
387  /// @return
388  /// Copy of the member data.
389  TSize_in_db_entries GetSize_in_db_entries(void) const;
390 
391  /// Assign a value to Size_in_db_entries data member.
392  ///
393  /// @param value
394  /// Value to assign
395  void SetSize_in_db_entries(TSize_in_db_entries value);
396 
397  /// Assign a value to Size_in_db_entries data member.
398  ///
399  /// @return
400  /// Reference to the data value.
401  TSize_in_db_entries& SetSize_in_db_entries(void);
402 
403  /// Check if a value has been assigned to Size_of_residues data member.
404  ///
405  /// Data member Size_of_residues is optional;
406  /// its type is defined as 'typedef int TSize_of_residues'
407  /// @return
408  /// - true, if a value has been assigned.
409  /// - false, otherwise.
410  bool IsSetSize_of_residues(void) const;
411 
412  /// Check if it is safe to call GetSize_of_residues method.
413  ///
414  /// @return
415  /// - true, if the data member is getatable.
416  /// - false, otherwise.
417  bool CanGetSize_of_residues(void) const;
418 
419  /// Reset Size_of_residues data member.
420  void ResetSize_of_residues(void);
421 
422  /// Get the Size_of_residues member data.
423  ///
424  /// @return
425  /// Copy of the member data.
426  TSize_of_residues GetSize_of_residues(void) const;
427 
428  /// Assign a value to Size_of_residues data member.
429  ///
430  /// @param value
431  /// Value to assign
432  void SetSize_of_residues(TSize_of_residues value);
433 
434  /// Assign a value to Size_of_residues data member.
435  ///
436  /// @return
437  /// Reference to the data value.
438  TSize_of_residues& SetSize_of_residues(void);
439 
440  ///Database type (AA=amino acid, NA=nucleic acid)
441  /// Check if a value has been assigned to Type data member.
442  ///
443  /// Data member Type is mandatory;
444  /// its type is defined as 'typedef EAttlist_type TType'
445  /// @return
446  /// - true, if a value has been assigned.
447  /// - false, otherwise.
448  bool IsSetType(void) const;
449 
450  /// Check if it is safe to call GetType method.
451  ///
452  /// @return
453  /// - true, if the data member is getatable.
454  /// - false, otherwise.
455  bool CanGetType(void) const;
456 
457  /// Reset Type data member.
458  void ResetType(void);
459 
460  /// Get the Type member data.
461  ///
462  /// @return
463  /// Copy of the member data.
464  TType GetType(void) const;
465 
466  /// Assign a value to Type data member.
467  ///
468  /// @param value
469  /// Value to assign
470  void SetType(TType value);
471 
472  /// Assign a value to Type data member.
473  ///
474  /// @return
475  /// Reference to the data value.
476  TType& SetType(void);
477 
478  /// Reset the whole object
479  void Reset(void);
480 
481 
482  private:
483  // Prohibit copy constructor and assignment operator
486 
487  // data
488  Uint4 m_set_State[1];
489  string m_Local_path;
490  string m_URL;
498  };
499  // types
501 
502  // member index
503  enum class E_memberIndex {
504  e__allMandatory = 0,
505  e_Attlist,
506  e_search_database
507  };
509 
510  // getters
511  // setters
512 
513  /// Check if a value has been assigned to Attlist data member.
514  ///
515  /// Data member Attlist is mandatory;
516  /// its type is defined as 'typedef C_Attlist TAttlist'
517  /// @return
518  /// - true, if a value has been assigned.
519  /// - false, otherwise.
520  bool IsSetAttlist(void) const;
521 
522  /// Check if it is safe to call GetAttlist method.
523  ///
524  /// @return
525  /// - true, if the data member is getatable.
526  /// - false, otherwise.
527  bool CanGetAttlist(void) const;
528 
529  /// Reset Attlist data member.
530  void ResetAttlist(void);
531 
532  /// Get the Attlist member data.
533  ///
534  /// @return
535  /// Reference to the member data.
536  const TAttlist& GetAttlist(void) const;
537 
538  /// Assign a value to Attlist data member.
539  ///
540  /// @param value
541  /// Reference to value.
542  void SetAttlist(TAttlist& value);
543 
544  /// Assign a value to Attlist data member.
545  ///
546  /// @return
547  /// Reference to the data value.
548  TAttlist& SetAttlist(void);
549 
550  /// Check if a value has been assigned to Search_database data member.
551  ///
552  /// Data member Search_database is mandatory
553  /// @return
554  /// - true, if a value has been assigned.
555  /// - false, otherwise.
556  bool IsSetSearch_database(void) const;
557 
558  /// Check if value of Search_database member is getatable.
559  ///
560  /// @return
561  /// - false; the data member of type 'NULL' has no value.
562  bool CanGetSearch_database(void) const;
563 
564  /// Reset Search_database data member.
565  void ResetSearch_database(void);
566 
567  /// Set NULL data member (assign 'NULL' value to Search_database data member).
568  void SetSearch_database(void);
569 
570  /// Reset the whole object
571  virtual void Reset(void);
572 
573 
574 private:
575  // Prohibit copy constructor and assignment operator
578 
579  // data
580  Uint4 m_set_State[1];
582 };
583 
584 /* @} */
585 
586 
587 
588 
589 
590 ///////////////////////////////////////////////////////////
591 ///////////////////// inline methods //////////////////////
592 ///////////////////////////////////////////////////////////
593 inline
595 {
596  return ((m_set_State[0] & 0x3) != 0);
597 }
598 
599 inline
601 {
602  return IsSetLocal_path();
603 }
604 
605 inline
607 {
608  if (!CanGetLocal_path()) {
609  ThrowUnassigned(0);
610  }
611  return m_Local_path;
612 }
613 
614 inline
616 {
617  m_Local_path = value;
618  m_set_State[0] |= 0x3;
619 }
620 
621 inline
623 {
624  m_Local_path = std::forward<CSearch_database_Base::C_Attlist::TLocal_path>(value);
625  m_set_State[0] |= 0x3;
626 }
627 
628 inline
630 {
631 #ifdef _DEBUG
632  if (!IsSetLocal_path()) {
633  m_Local_path = UnassignedString();
634  }
635 #endif
636  m_set_State[0] |= 0x1;
637  return m_Local_path;
638 }
639 
640 inline
642 {
643  return ((m_set_State[0] & 0xc) != 0);
644 }
645 
646 inline
648 {
649  return IsSetURL();
650 }
651 
652 inline
654 {
655  if (!CanGetURL()) {
656  ThrowUnassigned(1);
657  }
658  return m_URL;
659 }
660 
661 inline
663 {
664  m_URL = value;
665  m_set_State[0] |= 0xc;
666 }
667 
668 inline
670 {
671  m_URL = std::forward<CSearch_database_Base::C_Attlist::TURL>(value);
672  m_set_State[0] |= 0xc;
673 }
674 
675 inline
677 {
678 #ifdef _DEBUG
679  if (!IsSetURL()) {
680  m_URL = UnassignedString();
681  }
682 #endif
683  m_set_State[0] |= 0x4;
684  return m_URL;
685 }
686 
687 inline
689 {
690  return ((m_set_State[0] & 0x30) != 0);
691 }
692 
693 inline
695 {
696  return IsSetDatabase_name();
697 }
698 
699 inline
701 {
702  if (!CanGetDatabase_name()) {
703  ThrowUnassigned(2);
704  }
705  return m_Database_name;
706 }
707 
708 inline
710 {
711  m_Database_name = value;
712  m_set_State[0] |= 0x30;
713 }
714 
715 inline
717 {
718  m_Database_name = std::forward<CSearch_database_Base::C_Attlist::TDatabase_name>(value);
719  m_set_State[0] |= 0x30;
720 }
721 
722 inline
724 {
725 #ifdef _DEBUG
726  if (!IsSetDatabase_name()) {
727  m_Database_name = UnassignedString();
728  }
729 #endif
730  m_set_State[0] |= 0x10;
731  return m_Database_name;
732 }
733 
734 inline
736 {
737  return ((m_set_State[0] & 0xc0) != 0);
738 }
739 
740 inline
742 {
743  return IsSetOrig_database_url();
744 }
745 
746 inline
748 {
749  if (!CanGetOrig_database_url()) {
750  ThrowUnassigned(3);
751  }
752  return m_Orig_database_url;
753 }
754 
755 inline
757 {
758  m_Orig_database_url = value;
759  m_set_State[0] |= 0xc0;
760 }
761 
762 inline
764 {
765  m_Orig_database_url = std::forward<CSearch_database_Base::C_Attlist::TOrig_database_url>(value);
766  m_set_State[0] |= 0xc0;
767 }
768 
769 inline
771 {
772 #ifdef _DEBUG
773  if (!IsSetOrig_database_url()) {
774  m_Orig_database_url = UnassignedString();
775  }
776 #endif
777  m_set_State[0] |= 0x40;
778  return m_Orig_database_url;
779 }
780 
781 inline
783 {
784  return ((m_set_State[0] & 0x300) != 0);
785 }
786 
787 inline
789 {
790  return IsSetDatabase_release_date();
791 }
792 
793 inline
795 {
796  if (!CanGetDatabase_release_date()) {
797  ThrowUnassigned(4);
798  }
799  return m_Database_release_date;
800 }
801 
802 inline
804 {
805  m_Database_release_date = value;
806  m_set_State[0] |= 0x300;
807 }
808 
809 inline
811 {
812  m_Database_release_date = std::forward<CSearch_database_Base::C_Attlist::TDatabase_release_date>(value);
813  m_set_State[0] |= 0x300;
814 }
815 
816 inline
818 {
819 #ifdef _DEBUG
820  if (!IsSetDatabase_release_date()) {
821  m_Database_release_date = UnassignedString();
822  }
823 #endif
824  m_set_State[0] |= 0x100;
825  return m_Database_release_date;
826 }
827 
828 inline
830 {
831  return ((m_set_State[0] & 0xc00) != 0);
832 }
833 
834 inline
836 {
837  return IsSetDatabase_release_identifier();
838 }
839 
840 inline
842 {
843  if (!CanGetDatabase_release_identifier()) {
844  ThrowUnassigned(5);
845  }
846  return m_Database_release_identifier;
847 }
848 
849 inline
851 {
852  m_Database_release_identifier = value;
853  m_set_State[0] |= 0xc00;
854 }
855 
856 inline
858 {
859  m_Database_release_identifier = std::forward<CSearch_database_Base::C_Attlist::TDatabase_release_identifier>(value);
860  m_set_State[0] |= 0xc00;
861 }
862 
863 inline
865 {
866 #ifdef _DEBUG
867  if (!IsSetDatabase_release_identifier()) {
868  m_Database_release_identifier = UnassignedString();
869  }
870 #endif
871  m_set_State[0] |= 0x400;
872  return m_Database_release_identifier;
873 }
874 
875 inline
877 {
878  return ((m_set_State[0] & 0x3000) != 0);
879 }
880 
881 inline
883 {
884  return IsSetSize_in_db_entries();
885 }
886 
887 inline
889 {
890  m_Size_in_db_entries = 0;
891  m_set_State[0] &= ~0x3000;
892 }
893 
894 inline
896 {
897  if (!CanGetSize_in_db_entries()) {
898  ThrowUnassigned(6);
899  }
900  return m_Size_in_db_entries;
901 }
902 
903 inline
905 {
906  m_Size_in_db_entries = value;
907  m_set_State[0] |= 0x3000;
908 }
909 
910 inline
912 {
913 #ifdef _DEBUG
914  if (!IsSetSize_in_db_entries()) {
915  memset(&m_Size_in_db_entries,UnassignedByte(),sizeof(m_Size_in_db_entries));
916  }
917 #endif
918  m_set_State[0] |= 0x1000;
919  return m_Size_in_db_entries;
920 }
921 
922 inline
924 {
925  return ((m_set_State[0] & 0xc000) != 0);
926 }
927 
928 inline
930 {
931  return IsSetSize_of_residues();
932 }
933 
934 inline
936 {
937  m_Size_of_residues = 0;
938  m_set_State[0] &= ~0xc000;
939 }
940 
941 inline
943 {
944  if (!CanGetSize_of_residues()) {
945  ThrowUnassigned(7);
946  }
947  return m_Size_of_residues;
948 }
949 
950 inline
952 {
953  m_Size_of_residues = value;
954  m_set_State[0] |= 0xc000;
955 }
956 
957 inline
959 {
960 #ifdef _DEBUG
961  if (!IsSetSize_of_residues()) {
962  memset(&m_Size_of_residues,UnassignedByte(),sizeof(m_Size_of_residues));
963  }
964 #endif
965  m_set_State[0] |= 0x4000;
966  return m_Size_of_residues;
967 }
968 
969 inline
971 {
972  return ((m_set_State[0] & 0x30000) != 0);
973 }
974 
975 inline
977 {
978  return IsSetType();
979 }
980 
981 inline
983 {
984  m_Type = (EAttlist_type)(0);
985  m_set_State[0] &= ~0x30000;
986 }
987 
988 inline
990 {
991  if (!CanGetType()) {
992  ThrowUnassigned(8);
993  }
994  return m_Type;
995 }
996 
997 inline
999 {
1000  m_Type = value;
1001  m_set_State[0] |= 0x30000;
1002 }
1003 
1004 inline
1006 {
1007 #ifdef _DEBUG
1008  if (!IsSetType()) {
1009  memset(&m_Type,UnassignedByte(),sizeof(m_Type));
1010  }
1011 #endif
1012  m_set_State[0] |= 0x10000;
1013  return m_Type;
1014 }
1015 
1016 inline
1018 {
1019  return m_Attlist.NotEmpty();
1020 }
1021 
1022 inline
1024 {
1025  return true;
1026 }
1027 
1028 inline
1030 {
1031  if ( !m_Attlist ) {
1032  const_cast<CSearch_database_Base*>(this)->ResetAttlist();
1033  }
1034  return (*m_Attlist);
1035 }
1036 
1037 inline
1039 {
1040  if ( !m_Attlist ) {
1041  ResetAttlist();
1042  }
1044  return (*m_Attlist);
1045 }
1046 
1047 inline
1049 {
1050  return ((m_set_State[0] & 0xc) != 0);
1051 }
1052 
1053 inline
1055 {
1056  return false;
1057 }
1058 
1059 inline
1061 {
1062  m_set_State[0] &= ~0xc;
1063 }
1064 
1065 inline
1067 {
1068  m_set_State[0] |= 0xc;
1069 }
1070 
1071 ///////////////////////////////////////////////////////////
1072 ////////////////// end of inline methods //////////////////
1073 ///////////////////////////////////////////////////////////
1074 
1075 
1076 
1077 
1078 
1079 END_objects_SCOPE // namespace ncbi::objects::
1080 
1082 
1083 
1084 #endif // ALGO_MS_FORMATS_PEPXML_SEARCH_DATABASE_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
CSearch_database_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
static string UnassignedString(void)
Definition: serialbase.hpp:175
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_PEPXML_EXPORT
Definition: ncbi_export.h:696
TURL & SetURL(void)
Assign a value to URL data member.
bool CanGetAttlist(void) const
Check if it is safe to call GetAttlist method.
TSize_of_residues GetSize_of_residues(void) const
Get the Size_of_residues member data.
bool CanGetDatabase_release_identifier(void) const
Check if it is safe to call GetDatabase_release_identifier method.
TSize_of_residues & SetSize_of_residues(void)
Assign a value to Size_of_residues data member.
bool IsSetSize_of_residues(void) const
Check if a value has been assigned to Size_of_residues data member.
bool IsSetSize_in_db_entries(void) const
Check if a value has been assigned to Size_in_db_entries data member.
bool IsSetDatabase_name(void) const
Check if a value has been assigned to Database_name data member.
TType GetType(void) const
Get the Type member data.
const TAttlist & GetAttlist(void) const
Get the Attlist member data.
C_Attlist & operator=(const C_Attlist &)
bool IsSetSearch_database(void) const
Check if a value has been assigned to Search_database data member.
void ResetType(void)
Reset Type data member.
bool CanGetType(void) const
Check if it is safe to call GetType method.
bool CanGetDatabase_release_date(void) const
Check if it is safe to call GetDatabase_release_date method.
TDatabase_release_date & SetDatabase_release_date(void)
Assign a value to Database_release_date data member.
bool IsSetDatabase_release_date(void) const
Check if a value has been assigned to Database_release_date data member.
bool CanGetLocal_path(void) const
Check if it is safe to call GetLocal_path method.
TLocal_path & SetLocal_path(void)
Assign a value to Local_path data member.
const TDatabase_release_identifier & GetDatabase_release_identifier(void) const
Get the Database_release_identifier member data.
TDatabase_name & SetDatabase_name(void)
Assign a value to Database_name data member.
TSize_in_db_entries & SetSize_in_db_entries(void)
Assign a value to Size_in_db_entries data member.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
bool CanGetSearch_database(void) const
Check if value of Search_database member is getatable.
bool IsSetAttlist(void) const
Check if a value has been assigned to Attlist data member.
bool CanGetOrig_database_url(void) const
Check if it is safe to call GetOrig_database_url method.
bool IsSetURL(void) const
Check if a value has been assigned to URL data member.
TSize_in_db_entries GetSize_in_db_entries(void) const
Get the Size_in_db_entries member data.
bool CanGetDatabase_name(void) const
Check if it is safe to call GetDatabase_name method.
TOrig_database_url & SetOrig_database_url(void)
Assign a value to Orig_database_url data member.
void ResetSearch_database(void)
Reset Search_database data member.
TDatabase_release_identifier & SetDatabase_release_identifier(void)
Assign a value to Database_release_identifier data member.
bool CanGetSize_in_db_entries(void) const
Check if it is safe to call GetSize_in_db_entries method.
Tparent::CMemberIndex< E_memberIndex, 10 > TmemberIndex
void ResetSize_of_residues(void)
Reset Size_of_residues data member.
const TDatabase_release_date & GetDatabase_release_date(void) const
Get the Database_release_date member data.
CSearch_database_Base(const CSearch_database_Base &)
bool IsSetType(void) const
Database type (AA=amino acid, NA=nucleic acid) Check if a value has been assigned to Type data member...
bool CanGetSize_of_residues(void) const
Check if it is safe to call GetSize_of_residues method.
bool CanGetURL(void) const
Check if it is safe to call GetURL method.
const TURL & GetURL(void) const
Get the URL member data.
const TDatabase_name & GetDatabase_name(void) const
Get the Database_name member data.
void ResetSize_in_db_entries(void)
Reset Size_in_db_entries data member.
TAttlist & SetAttlist(void)
Assign a value to Attlist data member.
bool IsSetOrig_database_url(void) const
Check if a value has been assigned to Orig_database_url data member.
void ResetAttlist(void)
Reset Attlist data member.
const TOrig_database_url & GetOrig_database_url(void) const
Get the Orig_database_url member data.
bool IsSetDatabase_release_identifier(void) const
Check if a value has been assigned to Database_release_identifier data member.
CRef< TAttlist > m_Attlist
CSearch_database_Base & operator=(const CSearch_database_Base &)
const TLocal_path & GetLocal_path(void) const
Get the Local_path member data.
bool IsSetLocal_path(void) const
Check if a value has been assigned to Local_path data member.
void SetSearch_database(void)
Set NULL data member (assign 'NULL' value to Search_database data member).
TType & SetType(void)
Assign a value to Type data member.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Jul 10 14:36:06 2024 by modify_doxy.py rev. 669887