NCBI C++ ToolKit
Blast_db_metadata_.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 Blast_db_metadata_.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/objects/blastdb/blastdb.asn">blastdb.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blastdb/blastdb.def">blastdb.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 OBJECTS_BLASTDB_BLAST_DB_METADATA_BASE_HPP
42 #define OBJECTS_BLASTDB_BLAST_DB_METADATA_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
49 #include <vector>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 
60 // generated classes
61 
62 
63 /** @addtogroup dataspec_NCBI_BlastDL
64  *
65  * @{
66  */
67 
68 /////////////////////////////////////////////////////////////////////////////
69 ///
70 /// CBlast_db_metadata_Base --
71 ///
72 
74 {
76 public:
77  // constructor
79  // destructor
80  virtual ~CBlast_db_metadata_Base(void);
81 
82  // type info
84 
85  // types
86  typedef string TVersion;
87  typedef string TDbname;
88  typedef string TDbtype;
89  typedef int TDb_version;
90  typedef string TDescription;
93  typedef string TLast_updated;
94  typedef int TNumber_of_volumes;
95  typedef int TNumber_of_taxids;
99  typedef vector< string > TFiles;
100  typedef vector< string > TCompressed_files;
101 
102  // member index
103  enum class E_memberIndex {
104  e__allMandatory = 0,
105  e_version,
106  e_dbname,
107  e_dbtype,
108  e_db_version,
109  e_description,
110  e_number_of_letters,
111  e_number_of_sequences,
112  e_last_updated,
113  e_number_of_volumes,
114  e_number_of_taxids,
115  e_bytes_total,
116  e_bytes_to_cache,
117  e_bytes_total_compressed,
118  e_files,
119  e_compressed_files
120  };
122 
123  // getters
124  // setters
125 
126  /// Default indicates the starting version
127  /// Check if a value has been assigned to Version data member.
128  ///
129  /// Data member Version is optional with default "1.2";
130  /// its type is defined as 'typedef string TVersion'
131  /// @return
132  /// - true, if a value has been assigned.
133  /// - false, otherwise.
134  bool IsSetVersion(void) const;
135 
136  /// Check if it is safe to call GetVersion method.
137  ///
138  /// @return
139  /// - true, if the data member is getatable.
140  /// - false, otherwise.
141  bool CanGetVersion(void) const;
142 
143  /// Reset Version data member.
144  void ResetVersion(void);
145 
146  /// Assign default value to Version data member.
147  void SetDefaultVersion(void);
148 
149  /// Get the Version member data.
150  ///
151  /// @return
152  /// Reference to the member data.
153  const TVersion& GetVersion(void) const;
154 
155  /// Assign a value to Version data member.
156  ///
157  /// @param value
158  /// Value to assign
159  void SetVersion(const TVersion& value);
160  void SetVersion(TVersion&& value);
161 
162  /// Assign a value to Version data member.
163  ///
164  /// @return
165  /// Reference to the data value.
166  TVersion& SetVersion(void);
167 
168  /// Check if a value has been assigned to Dbname data member.
169  ///
170  /// Data member Dbname is mandatory;
171  /// its type is defined as 'typedef string TDbname'
172  /// @return
173  /// - true, if a value has been assigned.
174  /// - false, otherwise.
175  bool IsSetDbname(void) const;
176 
177  /// Check if it is safe to call GetDbname method.
178  ///
179  /// @return
180  /// - true, if the data member is getatable.
181  /// - false, otherwise.
182  bool CanGetDbname(void) const;
183 
184  /// Reset Dbname data member.
185  void ResetDbname(void);
186 
187  /// Get the Dbname member data.
188  ///
189  /// @return
190  /// Reference to the member data.
191  const TDbname& GetDbname(void) const;
192 
193  /// Assign a value to Dbname data member.
194  ///
195  /// @param value
196  /// Value to assign
197  void SetDbname(const TDbname& value);
198  void SetDbname(TDbname&& value);
199 
200  /// Assign a value to Dbname data member.
201  ///
202  /// @return
203  /// Reference to the data value.
204  TDbname& SetDbname(void);
205 
206  /// Check if a value has been assigned to Dbtype data member.
207  ///
208  /// Data member Dbtype is mandatory;
209  /// its type is defined as 'typedef string TDbtype'
210  /// @return
211  /// - true, if a value has been assigned.
212  /// - false, otherwise.
213  bool IsSetDbtype(void) const;
214 
215  /// Check if it is safe to call GetDbtype method.
216  ///
217  /// @return
218  /// - true, if the data member is getatable.
219  /// - false, otherwise.
220  bool CanGetDbtype(void) const;
221 
222  /// Reset Dbtype data member.
223  void ResetDbtype(void);
224 
225  /// Get the Dbtype member data.
226  ///
227  /// @return
228  /// Reference to the member data.
229  const TDbtype& GetDbtype(void) const;
230 
231  /// Assign a value to Dbtype data member.
232  ///
233  /// @param value
234  /// Value to assign
235  void SetDbtype(const TDbtype& value);
236  void SetDbtype(TDbtype&& value);
237 
238  /// Assign a value to Dbtype data member.
239  ///
240  /// @return
241  /// Reference to the data value.
242  TDbtype& SetDbtype(void);
243 
244  /// Default indicates the starting version
245  /// Check if a value has been assigned to Db_version data member.
246  ///
247  /// Data member Db_version is optional with default 5;
248  /// its type is defined as 'typedef int TDb_version'
249  /// @return
250  /// - true, if a value has been assigned.
251  /// - false, otherwise.
252  bool IsSetDb_version(void) const;
253 
254  /// Check if it is safe to call GetDb_version method.
255  ///
256  /// @return
257  /// - true, if the data member is getatable.
258  /// - false, otherwise.
259  bool CanGetDb_version(void) const;
260 
261  /// Reset Db_version data member.
262  void ResetDb_version(void);
263 
264  /// Assign default value to Db_version data member.
265  void SetDefaultDb_version(void);
266 
267  /// Get the Db_version member data.
268  ///
269  /// @return
270  /// Copy of the member data.
271  TDb_version GetDb_version(void) const;
272 
273  /// Assign a value to Db_version data member.
274  ///
275  /// @param value
276  /// Value to assign
277  void SetDb_version(TDb_version value);
278 
279  /// Assign a value to Db_version data member.
280  ///
281  /// @return
282  /// Reference to the data value.
283  TDb_version& SetDb_version(void);
284 
285  /// Check if a value has been assigned to Description data member.
286  ///
287  /// Data member Description is optional;
288  /// its type is defined as 'typedef string TDescription'
289  /// @return
290  /// - true, if a value has been assigned.
291  /// - false, otherwise.
292  bool IsSetDescription(void) const;
293 
294  /// Check if it is safe to call GetDescription method.
295  ///
296  /// @return
297  /// - true, if the data member is getatable.
298  /// - false, otherwise.
299  bool CanGetDescription(void) const;
300 
301  /// Reset Description data member.
302  void ResetDescription(void);
303 
304  /// Get the Description member data.
305  ///
306  /// @return
307  /// Reference to the member data.
308  const TDescription& GetDescription(void) const;
309 
310  /// Assign a value to Description data member.
311  ///
312  /// @param value
313  /// Value to assign
314  void SetDescription(const TDescription& value);
315  void SetDescription(TDescription&& value);
316 
317  /// Assign a value to Description data member.
318  ///
319  /// @return
320  /// Reference to the data value.
321  TDescription& SetDescription(void);
322 
323  /// Check if a value has been assigned to Number_of_letters data member.
324  ///
325  /// Data member Number_of_letters is mandatory;
326  /// its type is defined as 'typedef Uint8 TNumber_of_letters'
327  /// @return
328  /// - true, if a value has been assigned.
329  /// - false, otherwise.
330  bool IsSetNumber_of_letters(void) const;
331 
332  /// Check if it is safe to call GetNumber_of_letters method.
333  ///
334  /// @return
335  /// - true, if the data member is getatable.
336  /// - false, otherwise.
337  bool CanGetNumber_of_letters(void) const;
338 
339  /// Reset Number_of_letters data member.
340  void ResetNumber_of_letters(void);
341 
342  /// Get the Number_of_letters member data.
343  ///
344  /// @return
345  /// Copy of the member data.
346  TNumber_of_letters GetNumber_of_letters(void) const;
347 
348  /// Assign a value to Number_of_letters data member.
349  ///
350  /// @param value
351  /// Value to assign
352  void SetNumber_of_letters(TNumber_of_letters value);
353 
354  /// Assign a value to Number_of_letters data member.
355  ///
356  /// @return
357  /// Reference to the data value.
358  TNumber_of_letters& SetNumber_of_letters(void);
359 
360  /// Check if a value has been assigned to Number_of_sequences data member.
361  ///
362  /// Data member Number_of_sequences is mandatory;
363  /// its type is defined as 'typedef Int8 TNumber_of_sequences'
364  /// @return
365  /// - true, if a value has been assigned.
366  /// - false, otherwise.
367  bool IsSetNumber_of_sequences(void) const;
368 
369  /// Check if it is safe to call GetNumber_of_sequences method.
370  ///
371  /// @return
372  /// - true, if the data member is getatable.
373  /// - false, otherwise.
374  bool CanGetNumber_of_sequences(void) const;
375 
376  /// Reset Number_of_sequences data member.
377  void ResetNumber_of_sequences(void);
378 
379  /// Get the Number_of_sequences member data.
380  ///
381  /// @return
382  /// Copy of the member data.
383  TNumber_of_sequences GetNumber_of_sequences(void) const;
384 
385  /// Assign a value to Number_of_sequences data member.
386  ///
387  /// @param value
388  /// Value to assign
389  void SetNumber_of_sequences(TNumber_of_sequences value);
390 
391  /// Assign a value to Number_of_sequences data member.
392  ///
393  /// @return
394  /// Reference to the data value.
395  TNumber_of_sequences& SetNumber_of_sequences(void);
396 
397  /// Check if a value has been assigned to Last_updated data member.
398  ///
399  /// Data member Last_updated is mandatory;
400  /// its type is defined as 'typedef string TLast_updated'
401  /// @return
402  /// - true, if a value has been assigned.
403  /// - false, otherwise.
404  bool IsSetLast_updated(void) const;
405 
406  /// Check if it is safe to call GetLast_updated method.
407  ///
408  /// @return
409  /// - true, if the data member is getatable.
410  /// - false, otherwise.
411  bool CanGetLast_updated(void) const;
412 
413  /// Reset Last_updated data member.
414  void ResetLast_updated(void);
415 
416  /// Get the Last_updated member data.
417  ///
418  /// @return
419  /// Reference to the member data.
420  const TLast_updated& GetLast_updated(void) const;
421 
422  /// Assign a value to Last_updated data member.
423  ///
424  /// @param value
425  /// Value to assign
426  void SetLast_updated(const TLast_updated& value);
427  void SetLast_updated(TLast_updated&& value);
428 
429  /// Assign a value to Last_updated data member.
430  ///
431  /// @return
432  /// Reference to the data value.
433  TLast_updated& SetLast_updated(void);
434 
435  /// Check if a value has been assigned to Number_of_volumes data member.
436  ///
437  /// Data member Number_of_volumes is mandatory;
438  /// its type is defined as 'typedef int TNumber_of_volumes'
439  /// @return
440  /// - true, if a value has been assigned.
441  /// - false, otherwise.
442  bool IsSetNumber_of_volumes(void) const;
443 
444  /// Check if it is safe to call GetNumber_of_volumes method.
445  ///
446  /// @return
447  /// - true, if the data member is getatable.
448  /// - false, otherwise.
449  bool CanGetNumber_of_volumes(void) const;
450 
451  /// Reset Number_of_volumes data member.
452  void ResetNumber_of_volumes(void);
453 
454  /// Get the Number_of_volumes member data.
455  ///
456  /// @return
457  /// Copy of the member data.
458  TNumber_of_volumes GetNumber_of_volumes(void) const;
459 
460  /// Assign a value to Number_of_volumes data member.
461  ///
462  /// @param value
463  /// Value to assign
464  void SetNumber_of_volumes(TNumber_of_volumes value);
465 
466  /// Assign a value to Number_of_volumes data member.
467  ///
468  /// @return
469  /// Reference to the data value.
470  TNumber_of_volumes& SetNumber_of_volumes(void);
471 
472  /// Check if a value has been assigned to Number_of_taxids data member.
473  ///
474  /// Data member Number_of_taxids is optional;
475  /// its type is defined as 'typedef int TNumber_of_taxids'
476  /// @return
477  /// - true, if a value has been assigned.
478  /// - false, otherwise.
479  bool IsSetNumber_of_taxids(void) const;
480 
481  /// Check if it is safe to call GetNumber_of_taxids method.
482  ///
483  /// @return
484  /// - true, if the data member is getatable.
485  /// - false, otherwise.
486  bool CanGetNumber_of_taxids(void) const;
487 
488  /// Reset Number_of_taxids data member.
489  void ResetNumber_of_taxids(void);
490 
491  /// Get the Number_of_taxids member data.
492  ///
493  /// @return
494  /// Copy of the member data.
495  TNumber_of_taxids GetNumber_of_taxids(void) const;
496 
497  /// Assign a value to Number_of_taxids data member.
498  ///
499  /// @param value
500  /// Value to assign
501  void SetNumber_of_taxids(TNumber_of_taxids value);
502 
503  /// Assign a value to Number_of_taxids data member.
504  ///
505  /// @return
506  /// Reference to the data value.
507  TNumber_of_taxids& SetNumber_of_taxids(void);
508 
509  /// Check if a value has been assigned to Bytes_total data member.
510  ///
511  /// Data member Bytes_total is mandatory;
512  /// its type is defined as 'typedef Uint8 TBytes_total'
513  /// @return
514  /// - true, if a value has been assigned.
515  /// - false, otherwise.
516  bool IsSetBytes_total(void) const;
517 
518  /// Check if it is safe to call GetBytes_total method.
519  ///
520  /// @return
521  /// - true, if the data member is getatable.
522  /// - false, otherwise.
523  bool CanGetBytes_total(void) const;
524 
525  /// Reset Bytes_total data member.
526  void ResetBytes_total(void);
527 
528  /// Get the Bytes_total member data.
529  ///
530  /// @return
531  /// Copy of the member data.
532  TBytes_total GetBytes_total(void) const;
533 
534  /// Assign a value to Bytes_total data member.
535  ///
536  /// @param value
537  /// Value to assign
538  void SetBytes_total(TBytes_total value);
539 
540  /// Assign a value to Bytes_total data member.
541  ///
542  /// @return
543  /// Reference to the data value.
544  TBytes_total& SetBytes_total(void);
545 
546  /// Check if a value has been assigned to Bytes_to_cache data member.
547  ///
548  /// Data member Bytes_to_cache is mandatory;
549  /// its type is defined as 'typedef Uint8 TBytes_to_cache'
550  /// @return
551  /// - true, if a value has been assigned.
552  /// - false, otherwise.
553  bool IsSetBytes_to_cache(void) const;
554 
555  /// Check if it is safe to call GetBytes_to_cache method.
556  ///
557  /// @return
558  /// - true, if the data member is getatable.
559  /// - false, otherwise.
560  bool CanGetBytes_to_cache(void) const;
561 
562  /// Reset Bytes_to_cache data member.
563  void ResetBytes_to_cache(void);
564 
565  /// Get the Bytes_to_cache member data.
566  ///
567  /// @return
568  /// Copy of the member data.
569  TBytes_to_cache GetBytes_to_cache(void) const;
570 
571  /// Assign a value to Bytes_to_cache data member.
572  ///
573  /// @param value
574  /// Value to assign
575  void SetBytes_to_cache(TBytes_to_cache value);
576 
577  /// Assign a value to Bytes_to_cache data member.
578  ///
579  /// @return
580  /// Reference to the data value.
581  TBytes_to_cache& SetBytes_to_cache(void);
582 
583  /// Check if a value has been assigned to Bytes_total_compressed data member.
584  ///
585  /// Data member Bytes_total_compressed is optional;
586  /// its type is defined as 'typedef Uint8 TBytes_total_compressed'
587  /// @return
588  /// - true, if a value has been assigned.
589  /// - false, otherwise.
590  bool IsSetBytes_total_compressed(void) const;
591 
592  /// Check if it is safe to call GetBytes_total_compressed method.
593  ///
594  /// @return
595  /// - true, if the data member is getatable.
596  /// - false, otherwise.
597  bool CanGetBytes_total_compressed(void) const;
598 
599  /// Reset Bytes_total_compressed data member.
600  void ResetBytes_total_compressed(void);
601 
602  /// Get the Bytes_total_compressed member data.
603  ///
604  /// @return
605  /// Copy of the member data.
606  TBytes_total_compressed GetBytes_total_compressed(void) const;
607 
608  /// Assign a value to Bytes_total_compressed data member.
609  ///
610  /// @param value
611  /// Value to assign
612  void SetBytes_total_compressed(TBytes_total_compressed value);
613 
614  /// Assign a value to Bytes_total_compressed data member.
615  ///
616  /// @return
617  /// Reference to the data value.
618  TBytes_total_compressed& SetBytes_total_compressed(void);
619 
620  /// Check if a value has been assigned to Files data member.
621  ///
622  /// Data member Files is optional;
623  /// its type is defined as 'typedef vector< string > TFiles'
624  /// @return
625  /// - true, if a value has been assigned.
626  /// - false, otherwise.
627  bool IsSetFiles(void) const;
628 
629  /// Check if it is safe to call GetFiles method.
630  ///
631  /// @return
632  /// - true, if the data member is getatable.
633  /// - false, otherwise.
634  bool CanGetFiles(void) const;
635 
636  /// Reset Files data member.
637  void ResetFiles(void);
638 
639  /// Get the Files member data.
640  ///
641  /// @return
642  /// Reference to the member data.
643  const TFiles& GetFiles(void) const;
644 
645  /// Assign a value to Files data member.
646  ///
647  /// @return
648  /// Reference to the data value.
649  TFiles& SetFiles(void);
650 
651  /// Check if a value has been assigned to Compressed_files data member.
652  ///
653  /// Data member Compressed_files is optional;
654  /// its type is defined as 'typedef vector< string > TCompressed_files'
655  /// @return
656  /// - true, if a value has been assigned.
657  /// - false, otherwise.
658  bool IsSetCompressed_files(void) const;
659 
660  /// Check if it is safe to call GetCompressed_files method.
661  ///
662  /// @return
663  /// - true, if the data member is getatable.
664  /// - false, otherwise.
665  bool CanGetCompressed_files(void) const;
666 
667  /// Reset Compressed_files data member.
668  void ResetCompressed_files(void);
669 
670  /// Get the Compressed_files member data.
671  ///
672  /// @return
673  /// Reference to the member data.
674  const TCompressed_files& GetCompressed_files(void) const;
675 
676  /// Assign a value to Compressed_files data member.
677  ///
678  /// @return
679  /// Reference to the data value.
680  TCompressed_files& SetCompressed_files(void);
681 
682  /// Reset the whole object
683  virtual void Reset(void);
684 
685 
686 private:
687  // Prohibit copy constructor and assignment operator
690 
691  // data
692  Uint4 m_set_State[1];
693  string m_Version;
694  string m_Dbname;
695  string m_Dbtype;
706  vector< string > m_Files;
707  vector< string > m_Compressed_files;
708 };
709 
710 /* @} */
711 
712 
713 
714 
715 
716 ///////////////////////////////////////////////////////////
717 ///////////////////// inline methods //////////////////////
718 ///////////////////////////////////////////////////////////
719 inline
721 {
722  return ((m_set_State[0] & 0x3) != 0);
723 }
724 
725 inline
727 {
728  return true;
729 }
730 
731 inline
733 {
734  m_Version = "1.2";
735  m_set_State[0] &= ~0x3;
736 }
737 
738 inline
740 {
741  ResetVersion();
742 }
743 
744 inline
746 {
747  return m_Version;
748 }
749 
750 inline
752 {
753  m_Version = value;
754  m_set_State[0] |= 0x3;
755 }
756 
757 inline
759 {
760  m_Version = std::forward<CBlast_db_metadata_Base::TVersion>(value);
761  m_set_State[0] |= 0x3;
762 }
763 
764 inline
766 {
767 #ifdef _DEBUG
768  if (!IsSetVersion()) {
770  }
771 #endif
772  m_set_State[0] |= 0x1;
773  return m_Version;
774 }
775 
776 inline
778 {
779  return ((m_set_State[0] & 0xc) != 0);
780 }
781 
782 inline
784 {
785  return IsSetDbname();
786 }
787 
788 inline
790 {
791  if (!CanGetDbname()) {
792  ThrowUnassigned(1);
793  }
794  return m_Dbname;
795 }
796 
797 inline
799 {
800  m_Dbname = value;
801  m_set_State[0] |= 0xc;
802 }
803 
804 inline
806 {
807  m_Dbname = std::forward<CBlast_db_metadata_Base::TDbname>(value);
808  m_set_State[0] |= 0xc;
809 }
810 
811 inline
813 {
814 #ifdef _DEBUG
815  if (!IsSetDbname()) {
817  }
818 #endif
819  m_set_State[0] |= 0x4;
820  return m_Dbname;
821 }
822 
823 inline
825 {
826  return ((m_set_State[0] & 0x30) != 0);
827 }
828 
829 inline
831 {
832  return IsSetDbtype();
833 }
834 
835 inline
837 {
838  if (!CanGetDbtype()) {
839  ThrowUnassigned(2);
840  }
841  return m_Dbtype;
842 }
843 
844 inline
846 {
847  m_Dbtype = value;
848  m_set_State[0] |= 0x30;
849 }
850 
851 inline
853 {
854  m_Dbtype = std::forward<CBlast_db_metadata_Base::TDbtype>(value);
855  m_set_State[0] |= 0x30;
856 }
857 
858 inline
860 {
861 #ifdef _DEBUG
862  if (!IsSetDbtype()) {
864  }
865 #endif
866  m_set_State[0] |= 0x10;
867  return m_Dbtype;
868 }
869 
870 inline
872 {
873  return ((m_set_State[0] & 0xc0) != 0);
874 }
875 
876 inline
878 {
879  return true;
880 }
881 
882 inline
884 {
885  m_Db_version = 5;
886  m_set_State[0] &= ~0xc0;
887 }
888 
889 inline
891 {
892  ResetDb_version();
893 }
894 
895 inline
897 {
898  return m_Db_version;
899 }
900 
901 inline
903 {
905  m_set_State[0] |= 0xc0;
906 }
907 
908 inline
910 {
911 #ifdef _DEBUG
912  if (!IsSetDb_version()) {
913  memset(&m_Db_version,UnassignedByte(),sizeof(m_Db_version));
914  }
915 #endif
916  m_set_State[0] |= 0x40;
917  return m_Db_version;
918 }
919 
920 inline
922 {
923  return ((m_set_State[0] & 0x300) != 0);
924 }
925 
926 inline
928 {
929  return IsSetDescription();
930 }
931 
932 inline
934 {
935  if (!CanGetDescription()) {
936  ThrowUnassigned(4);
937  }
938  return m_Description;
939 }
940 
941 inline
943 {
945  m_set_State[0] |= 0x300;
946 }
947 
948 inline
950 {
951  m_Description = std::forward<CBlast_db_metadata_Base::TDescription>(value);
952  m_set_State[0] |= 0x300;
953 }
954 
955 inline
957 {
958 #ifdef _DEBUG
959  if (!IsSetDescription()) {
961  }
962 #endif
963  m_set_State[0] |= 0x100;
964  return m_Description;
965 }
966 
967 inline
969 {
970  return ((m_set_State[0] & 0xc00) != 0);
971 }
972 
973 inline
975 {
976  return IsSetNumber_of_letters();
977 }
978 
979 inline
981 {
983  m_set_State[0] &= ~0xc00;
984 }
985 
986 inline
988 {
989  if (!CanGetNumber_of_letters()) {
990  ThrowUnassigned(5);
991  }
992  return m_Number_of_letters;
993 }
994 
995 inline
997 {
999  m_set_State[0] |= 0xc00;
1000 }
1001 
1002 inline
1004 {
1005 #ifdef _DEBUG
1006  if (!IsSetNumber_of_letters()) {
1008  }
1009 #endif
1010  m_set_State[0] |= 0x400;
1011  return m_Number_of_letters;
1012 }
1013 
1014 inline
1016 {
1017  return ((m_set_State[0] & 0x3000) != 0);
1018 }
1019 
1020 inline
1022 {
1023  return IsSetNumber_of_sequences();
1024 }
1025 
1026 inline
1028 {
1030  m_set_State[0] &= ~0x3000;
1031 }
1032 
1033 inline
1035 {
1036  if (!CanGetNumber_of_sequences()) {
1037  ThrowUnassigned(6);
1038  }
1039  return m_Number_of_sequences;
1040 }
1041 
1042 inline
1044 {
1046  m_set_State[0] |= 0x3000;
1047 }
1048 
1049 inline
1051 {
1052 #ifdef _DEBUG
1053  if (!IsSetNumber_of_sequences()) {
1055  }
1056 #endif
1057  m_set_State[0] |= 0x1000;
1058  return m_Number_of_sequences;
1059 }
1060 
1061 inline
1063 {
1064  return ((m_set_State[0] & 0xc000) != 0);
1065 }
1066 
1067 inline
1069 {
1070  return IsSetLast_updated();
1071 }
1072 
1073 inline
1075 {
1076  if (!CanGetLast_updated()) {
1077  ThrowUnassigned(7);
1078  }
1079  return m_Last_updated;
1080 }
1081 
1082 inline
1084 {
1086  m_set_State[0] |= 0xc000;
1087 }
1088 
1089 inline
1091 {
1092  m_Last_updated = std::forward<CBlast_db_metadata_Base::TLast_updated>(value);
1093  m_set_State[0] |= 0xc000;
1094 }
1095 
1096 inline
1098 {
1099 #ifdef _DEBUG
1100  if (!IsSetLast_updated()) {
1102  }
1103 #endif
1104  m_set_State[0] |= 0x4000;
1105  return m_Last_updated;
1106 }
1107 
1108 inline
1110 {
1111  return ((m_set_State[0] & 0x30000) != 0);
1112 }
1113 
1114 inline
1116 {
1117  return IsSetNumber_of_volumes();
1118 }
1119 
1120 inline
1122 {
1123  m_Number_of_volumes = 0;
1124  m_set_State[0] &= ~0x30000;
1125 }
1126 
1127 inline
1129 {
1130  if (!CanGetNumber_of_volumes()) {
1131  ThrowUnassigned(8);
1132  }
1133  return m_Number_of_volumes;
1134 }
1135 
1136 inline
1138 {
1140  m_set_State[0] |= 0x30000;
1141 }
1142 
1143 inline
1145 {
1146 #ifdef _DEBUG
1147  if (!IsSetNumber_of_volumes()) {
1149  }
1150 #endif
1151  m_set_State[0] |= 0x10000;
1152  return m_Number_of_volumes;
1153 }
1154 
1155 inline
1157 {
1158  return ((m_set_State[0] & 0xc0000) != 0);
1159 }
1160 
1161 inline
1163 {
1164  return IsSetNumber_of_taxids();
1165 }
1166 
1167 inline
1169 {
1170  m_Number_of_taxids = 0;
1171  m_set_State[0] &= ~0xc0000;
1172 }
1173 
1174 inline
1176 {
1177  if (!CanGetNumber_of_taxids()) {
1178  ThrowUnassigned(9);
1179  }
1180  return m_Number_of_taxids;
1181 }
1182 
1183 inline
1185 {
1187  m_set_State[0] |= 0xc0000;
1188 }
1189 
1190 inline
1192 {
1193 #ifdef _DEBUG
1194  if (!IsSetNumber_of_taxids()) {
1196  }
1197 #endif
1198  m_set_State[0] |= 0x40000;
1199  return m_Number_of_taxids;
1200 }
1201 
1202 inline
1204 {
1205  return ((m_set_State[0] & 0x300000) != 0);
1206 }
1207 
1208 inline
1210 {
1211  return IsSetBytes_total();
1212 }
1213 
1214 inline
1216 {
1217  m_Bytes_total = 0;
1218  m_set_State[0] &= ~0x300000;
1219 }
1220 
1221 inline
1223 {
1224  if (!CanGetBytes_total()) {
1225  ThrowUnassigned(10);
1226  }
1227  return m_Bytes_total;
1228 }
1229 
1230 inline
1232 {
1233  m_Bytes_total = value;
1234  m_set_State[0] |= 0x300000;
1235 }
1236 
1237 inline
1239 {
1240 #ifdef _DEBUG
1241  if (!IsSetBytes_total()) {
1242  memset(&m_Bytes_total,UnassignedByte(),sizeof(m_Bytes_total));
1243  }
1244 #endif
1245  m_set_State[0] |= 0x100000;
1246  return m_Bytes_total;
1247 }
1248 
1249 inline
1251 {
1252  return ((m_set_State[0] & 0xc00000) != 0);
1253 }
1254 
1255 inline
1257 {
1258  return IsSetBytes_to_cache();
1259 }
1260 
1261 inline
1263 {
1264  m_Bytes_to_cache = 0;
1265  m_set_State[0] &= ~0xc00000;
1266 }
1267 
1268 inline
1270 {
1271  if (!CanGetBytes_to_cache()) {
1272  ThrowUnassigned(11);
1273  }
1274  return m_Bytes_to_cache;
1275 }
1276 
1277 inline
1279 {
1281  m_set_State[0] |= 0xc00000;
1282 }
1283 
1284 inline
1286 {
1287 #ifdef _DEBUG
1288  if (!IsSetBytes_to_cache()) {
1290  }
1291 #endif
1292  m_set_State[0] |= 0x400000;
1293  return m_Bytes_to_cache;
1294 }
1295 
1296 inline
1298 {
1299  return ((m_set_State[0] & 0x3000000) != 0);
1300 }
1301 
1302 inline
1304 {
1305  return IsSetBytes_total_compressed();
1306 }
1307 
1308 inline
1310 {
1312  m_set_State[0] &= ~0x3000000;
1313 }
1314 
1315 inline
1317 {
1319  ThrowUnassigned(12);
1320  }
1321  return m_Bytes_total_compressed;
1322 }
1323 
1324 inline
1326 {
1328  m_set_State[0] |= 0x3000000;
1329 }
1330 
1331 inline
1333 {
1334 #ifdef _DEBUG
1335  if (!IsSetBytes_total_compressed()) {
1337  }
1338 #endif
1339  m_set_State[0] |= 0x1000000;
1340  return m_Bytes_total_compressed;
1341 }
1342 
1343 inline
1345 {
1346  return ((m_set_State[0] & 0xc000000) != 0);
1347 }
1348 
1349 inline
1351 {
1352  return true;
1353 }
1354 
1355 inline
1357 {
1358  return m_Files;
1359 }
1360 
1361 inline
1363 {
1364  m_set_State[0] |= 0x4000000;
1365  return m_Files;
1366 }
1367 
1368 inline
1370 {
1371  return ((m_set_State[0] & 0x30000000) != 0);
1372 }
1373 
1374 inline
1376 {
1377  return true;
1378 }
1379 
1380 inline
1382 {
1383  return m_Compressed_files;
1384 }
1385 
1386 inline
1388 {
1389  m_set_State[0] |= 0x10000000;
1390  return m_Compressed_files;
1391 }
1392 
1393 ///////////////////////////////////////////////////////////
1394 ////////////////// end of inline methods //////////////////
1395 ///////////////////////////////////////////////////////////
1396 
1397 
1398 
1399 
1400 
1401 END_objects_SCOPE // namespace ncbi::objects::
1402 
1404 
1405 
1406 #endif // OBJECTS_BLASTDB_BLAST_DB_METADATA_BASE_HPP
CBlast_db_metadata_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
int64_t Int8
8-byte (64-bit) signed integer
Definition: ncbitype.h:104
uint64_t Uint8
8-byte (64-bit) unsigned integer
Definition: ncbitype.h:105
#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_BLASTDB_EXPORT
Definition: ncbi_export.h:328
bool IsSetDb_version(void) const
Default indicates the starting version Check if a value has been assigned to Db_version data member.
TNumber_of_volumes & SetNumber_of_volumes(void)
Assign a value to Number_of_volumes data member.
bool CanGetBytes_to_cache(void) const
Check if it is safe to call GetBytes_to_cache method.
const TVersion & GetVersion(void) const
Get the Version member data.
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
const TDescription & GetDescription(void) const
Get the Description member data.
TVersion & SetVersion(void)
Assign a value to Version data member.
void ResetNumber_of_letters(void)
Reset Number_of_letters data member.
bool IsSetDbtype(void) const
Check if a value has been assigned to Dbtype data member.
vector< string > TCompressed_files
bool CanGetFiles(void) const
Check if it is safe to call GetFiles method.
TBytes_to_cache & SetBytes_to_cache(void)
Assign a value to Bytes_to_cache data member.
bool IsSetBytes_total(void) const
Check if a value has been assigned to Bytes_total data member.
bool CanGetDbtype(void) const
Check if it is safe to call GetDbtype method.
TBytes_total GetBytes_total(void) const
Get the Bytes_total member data.
bool IsSetBytes_total_compressed(void) const
Check if a value has been assigned to Bytes_total_compressed data member.
void ResetDb_version(void)
Reset Db_version data member.
const TLast_updated & GetLast_updated(void) const
Get the Last_updated member data.
TDbtype & SetDbtype(void)
Assign a value to Dbtype data member.
void SetDefaultVersion(void)
Assign default value to Version data member.
CBlast_db_metadata_Base & operator=(const CBlast_db_metadata_Base &)
Tparent::CMemberIndex< E_memberIndex, 16 > TmemberIndex
bool IsSetDbname(void) const
Check if a value has been assigned to Dbname data member.
TNumber_of_volumes GetNumber_of_volumes(void) const
Get the Number_of_volumes member data.
void ResetBytes_total(void)
Reset Bytes_total data member.
TLast_updated & SetLast_updated(void)
Assign a value to Last_updated data member.
bool IsSetNumber_of_letters(void) const
Check if a value has been assigned to Number_of_letters data member.
const TDbname & GetDbname(void) const
Get the Dbname member data.
void ResetBytes_total_compressed(void)
Reset Bytes_total_compressed data member.
TNumber_of_sequences GetNumber_of_sequences(void) const
Get the Number_of_sequences member data.
void ResetBytes_to_cache(void)
Reset Bytes_to_cache data member.
bool CanGetDescription(void) const
Check if it is safe to call GetDescription method.
TNumber_of_sequences & SetNumber_of_sequences(void)
Assign a value to Number_of_sequences data member.
bool CanGetNumber_of_letters(void) const
Check if it is safe to call GetNumber_of_letters method.
void ResetNumber_of_volumes(void)
Reset Number_of_volumes data member.
vector< string > m_Compressed_files
TFiles & SetFiles(void)
Assign a value to Files data member.
bool CanGetBytes_total(void) const
Check if it is safe to call GetBytes_total method.
bool CanGetNumber_of_sequences(void) const
Check if it is safe to call GetNumber_of_sequences method.
bool IsSetDescription(void) const
Check if a value has been assigned to Description data member.
bool IsSetLast_updated(void) const
Check if a value has been assigned to Last_updated data member.
bool CanGetLast_updated(void) const
Check if it is safe to call GetLast_updated method.
TCompressed_files & SetCompressed_files(void)
Assign a value to Compressed_files data member.
bool IsSetFiles(void) const
Check if a value has been assigned to Files data member.
TDbname & SetDbname(void)
Assign a value to Dbname data member.
void ResetNumber_of_taxids(void)
Reset Number_of_taxids data member.
const TCompressed_files & GetCompressed_files(void) const
Get the Compressed_files member data.
TNumber_of_taxids & SetNumber_of_taxids(void)
Assign a value to Number_of_taxids data member.
bool CanGetNumber_of_taxids(void) const
Check if it is safe to call GetNumber_of_taxids method.
void ResetVersion(void)
Reset Version data member.
TDescription & SetDescription(void)
Assign a value to Description data member.
bool CanGetDb_version(void) const
Check if it is safe to call GetDb_version method.
TBytes_total_compressed GetBytes_total_compressed(void) const
Get the Bytes_total_compressed member data.
bool IsSetNumber_of_sequences(void) const
Check if a value has been assigned to Number_of_sequences data member.
bool IsSetVersion(void) const
Default indicates the starting version Check if a value has been assigned to Version data member.
bool IsSetBytes_to_cache(void) const
Check if a value has been assigned to Bytes_to_cache data member.
TBytes_total_compressed & SetBytes_total_compressed(void)
Assign a value to Bytes_total_compressed data member.
bool CanGetDbname(void) const
Check if it is safe to call GetDbname method.
bool CanGetNumber_of_volumes(void) const
Check if it is safe to call GetNumber_of_volumes method.
bool IsSetNumber_of_volumes(void) const
Check if a value has been assigned to Number_of_volumes data member.
const TDbtype & GetDbtype(void) const
Get the Dbtype member data.
TNumber_of_taxids GetNumber_of_taxids(void) const
Get the Number_of_taxids member data.
bool CanGetBytes_total_compressed(void) const
Check if it is safe to call GetBytes_total_compressed method.
bool IsSetNumber_of_taxids(void) const
Check if a value has been assigned to Number_of_taxids data member.
TNumber_of_letters GetNumber_of_letters(void) const
Get the Number_of_letters member data.
bool CanGetCompressed_files(void) const
Check if it is safe to call GetCompressed_files method.
TDb_version & SetDb_version(void)
Assign a value to Db_version data member.
TNumber_of_letters & SetNumber_of_letters(void)
Assign a value to Number_of_letters data member.
CBlast_db_metadata_Base(const CBlast_db_metadata_Base &)
TBytes_to_cache GetBytes_to_cache(void) const
Get the Bytes_to_cache member data.
const TFiles & GetFiles(void) const
Get the Files member data.
TBytes_total & SetBytes_total(void)
Assign a value to Bytes_total data member.
TDb_version GetDb_version(void) const
Get the Db_version member data.
bool IsSetCompressed_files(void) const
Check if a value has been assigned to Compressed_files data member.
void SetDefaultDb_version(void)
Assign default value to Db_version data member.
void ResetNumber_of_sequences(void)
Reset Number_of_sequences data member.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed May 15 15:05:33 2024 by modify_doxy.py rev. 669887