NCBI C++ ToolKit
BlastOutput_.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 BlastOutput_.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/blastxml/blastxml.asn">blastxml.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blastxml/blastxml.def">blastxml.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_BLASTXML_BLASTOUTPUT_BASE_HPP
42 #define OBJECTS_BLASTXML_BLASTOUTPUT_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
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 // forward declarations
61 class CIteration;
62 class CParameters;
63 class CStatistics;
64 
65 
66 // generated classes
67 
68 
69 /** @addtogroup dataspec_NCBI_BlastOutput
70  *
71  * @{
72  */
73 
74 /////////////////////////////////////////////////////////////////////////////
75 ///
76 /// CBlastOutput_Base --
77 ///
78 
80 {
82 public:
83  // constructor
84  CBlastOutput_Base(void);
85  // destructor
86  virtual ~CBlastOutput_Base(void);
87 
88  // type info
90 
91  // types
92  typedef string TProgram;
93  typedef string TVersion;
94  typedef string TReference;
95  typedef string TDb;
96  typedef string TQuery_ID;
97  typedef string TQuery_def;
98  typedef int TQuery_len;
99  typedef string TQuery_seq;
101  typedef list< CRef< CIteration > > TIterations;
103 
104  // member index
105  enum class E_memberIndex {
106  e__allMandatory = 0,
107  e_program,
108  e_version,
109  e_reference,
110  e_db,
111  e_query_ID,
112  e_query_def,
113  e_query_len,
114  e_query_seq,
115  e_param,
116  e_iterations,
117  e_mbstat
118  };
120 
121  // getters
122  // setters
123 
124  /// BLAST program: blastp, tblastx etc.
125  /// Check if a value has been assigned to Program data member.
126  ///
127  /// Data member Program is mandatory;
128  /// its type is defined as 'typedef string TProgram'
129  /// @return
130  /// - true, if a value has been assigned.
131  /// - false, otherwise.
132  bool IsSetProgram(void) const;
133 
134  /// Check if it is safe to call GetProgram method.
135  ///
136  /// @return
137  /// - true, if the data member is getatable.
138  /// - false, otherwise.
139  bool CanGetProgram(void) const;
140 
141  /// Reset Program data member.
142  void ResetProgram(void);
143 
144  /// Get the Program member data.
145  ///
146  /// @return
147  /// Reference to the member data.
148  const TProgram& GetProgram(void) const;
149 
150  /// Assign a value to Program data member.
151  ///
152  /// @param value
153  /// Value to assign
154  void SetProgram(const TProgram& value);
155  void SetProgram(TProgram&& value);
156 
157  /// Assign a value to Program data member.
158  ///
159  /// @return
160  /// Reference to the data value.
161  TProgram& SetProgram(void);
162 
163  /// Program version
164  /// Check if a value has been assigned to Version data member.
165  ///
166  /// Data member Version is mandatory;
167  /// its type is defined as 'typedef string TVersion'
168  /// @return
169  /// - true, if a value has been assigned.
170  /// - false, otherwise.
171  bool IsSetVersion(void) const;
172 
173  /// Check if it is safe to call GetVersion method.
174  ///
175  /// @return
176  /// - true, if the data member is getatable.
177  /// - false, otherwise.
178  bool CanGetVersion(void) const;
179 
180  /// Reset Version data member.
181  void ResetVersion(void);
182 
183  /// Get the Version member data.
184  ///
185  /// @return
186  /// Reference to the member data.
187  const TVersion& GetVersion(void) const;
188 
189  /// Assign a value to Version data member.
190  ///
191  /// @param value
192  /// Value to assign
193  void SetVersion(const TVersion& value);
194  void SetVersion(TVersion&& value);
195 
196  /// Assign a value to Version data member.
197  ///
198  /// @return
199  /// Reference to the data value.
200  TVersion& SetVersion(void);
201 
202  /// Steven, David, Tom and others
203  /// Check if a value has been assigned to Reference data member.
204  ///
205  /// Data member Reference is mandatory;
206  /// its type is defined as 'typedef string TReference'
207  /// @return
208  /// - true, if a value has been assigned.
209  /// - false, otherwise.
210  bool IsSetReference(void) const;
211 
212  /// Check if it is safe to call GetReference method.
213  ///
214  /// @return
215  /// - true, if the data member is getatable.
216  /// - false, otherwise.
217  bool CanGetReference(void) const;
218 
219  /// Reset Reference data member.
220  void ResetReference(void);
221 
222  /// Get the Reference member data.
223  ///
224  /// @return
225  /// Reference to the member data.
226  const TReference& GetReference(void) const;
227 
228  /// Assign a value to Reference data member.
229  ///
230  /// @param value
231  /// Value to assign
232  void SetReference(const TReference& value);
233  void SetReference(TReference&& value);
234 
235  /// Assign a value to Reference data member.
236  ///
237  /// @return
238  /// Reference to the data value.
239  TReference& SetReference(void);
240 
241  /// BLAST Database name
242  /// Check if a value has been assigned to Db data member.
243  ///
244  /// Data member Db is mandatory;
245  /// its type is defined as 'typedef string TDb'
246  /// @return
247  /// - true, if a value has been assigned.
248  /// - false, otherwise.
249  bool IsSetDb(void) const;
250 
251  /// Check if it is safe to call GetDb method.
252  ///
253  /// @return
254  /// - true, if the data member is getatable.
255  /// - false, otherwise.
256  bool CanGetDb(void) const;
257 
258  /// Reset Db data member.
259  void ResetDb(void);
260 
261  /// Get the Db member data.
262  ///
263  /// @return
264  /// Reference to the member data.
265  const TDb& GetDb(void) const;
266 
267  /// Assign a value to Db data member.
268  ///
269  /// @param value
270  /// Value to assign
271  void SetDb(const TDb& value);
272  void SetDb(TDb&& value);
273 
274  /// Assign a value to Db data member.
275  ///
276  /// @return
277  /// Reference to the data value.
278  TDb& SetDb(void);
279 
280  /// SeqId of query
281  /// Check if a value has been assigned to Query_ID data member.
282  ///
283  /// Data member Query_ID is mandatory;
284  /// its type is defined as 'typedef string TQuery_ID'
285  /// @return
286  /// - true, if a value has been assigned.
287  /// - false, otherwise.
288  bool IsSetQuery_ID(void) const;
289 
290  /// Check if it is safe to call GetQuery_ID method.
291  ///
292  /// @return
293  /// - true, if the data member is getatable.
294  /// - false, otherwise.
295  bool CanGetQuery_ID(void) const;
296 
297  /// Reset Query_ID data member.
298  void ResetQuery_ID(void);
299 
300  /// Get the Query_ID member data.
301  ///
302  /// @return
303  /// Reference to the member data.
304  const TQuery_ID& GetQuery_ID(void) const;
305 
306  /// Assign a value to Query_ID data member.
307  ///
308  /// @param value
309  /// Value to assign
310  void SetQuery_ID(const TQuery_ID& value);
311  void SetQuery_ID(TQuery_ID&& value);
312 
313  /// Assign a value to Query_ID data member.
314  ///
315  /// @return
316  /// Reference to the data value.
317  TQuery_ID& SetQuery_ID(void);
318 
319  /// Definition line of query
320  /// Check if a value has been assigned to Query_def data member.
321  ///
322  /// Data member Query_def is mandatory;
323  /// its type is defined as 'typedef string TQuery_def'
324  /// @return
325  /// - true, if a value has been assigned.
326  /// - false, otherwise.
327  bool IsSetQuery_def(void) const;
328 
329  /// Check if it is safe to call GetQuery_def method.
330  ///
331  /// @return
332  /// - true, if the data member is getatable.
333  /// - false, otherwise.
334  bool CanGetQuery_def(void) const;
335 
336  /// Reset Query_def data member.
337  void ResetQuery_def(void);
338 
339  /// Get the Query_def member data.
340  ///
341  /// @return
342  /// Reference to the member data.
343  const TQuery_def& GetQuery_def(void) const;
344 
345  /// Assign a value to Query_def data member.
346  ///
347  /// @param value
348  /// Value to assign
349  void SetQuery_def(const TQuery_def& value);
350  void SetQuery_def(TQuery_def&& value);
351 
352  /// Assign a value to Query_def data member.
353  ///
354  /// @return
355  /// Reference to the data value.
356  TQuery_def& SetQuery_def(void);
357 
358  /// length of query sequence
359  /// Check if a value has been assigned to Query_len data member.
360  ///
361  /// Data member Query_len is mandatory;
362  /// its type is defined as 'typedef int TQuery_len'
363  /// @return
364  /// - true, if a value has been assigned.
365  /// - false, otherwise.
366  bool IsSetQuery_len(void) const;
367 
368  /// Check if it is safe to call GetQuery_len method.
369  ///
370  /// @return
371  /// - true, if the data member is getatable.
372  /// - false, otherwise.
373  bool CanGetQuery_len(void) const;
374 
375  /// Reset Query_len data member.
376  void ResetQuery_len(void);
377 
378  /// Get the Query_len member data.
379  ///
380  /// @return
381  /// Copy of the member data.
382  TQuery_len GetQuery_len(void) const;
383 
384  /// Assign a value to Query_len data member.
385  ///
386  /// @param value
387  /// Value to assign
388  void SetQuery_len(TQuery_len value);
389 
390  /// Assign a value to Query_len data member.
391  ///
392  /// @return
393  /// Reference to the data value.
394  TQuery_len& SetQuery_len(void);
395 
396  /// query sequence itself
397  /// Check if a value has been assigned to Query_seq data member.
398  ///
399  /// Data member Query_seq is optional;
400  /// its type is defined as 'typedef string TQuery_seq'
401  /// @return
402  /// - true, if a value has been assigned.
403  /// - false, otherwise.
404  bool IsSetQuery_seq(void) const;
405 
406  /// Check if it is safe to call GetQuery_seq method.
407  ///
408  /// @return
409  /// - true, if the data member is getatable.
410  /// - false, otherwise.
411  bool CanGetQuery_seq(void) const;
412 
413  /// Reset Query_seq data member.
414  void ResetQuery_seq(void);
415 
416  /// Get the Query_seq member data.
417  ///
418  /// @return
419  /// Reference to the member data.
420  const TQuery_seq& GetQuery_seq(void) const;
421 
422  /// Assign a value to Query_seq data member.
423  ///
424  /// @param value
425  /// Value to assign
426  void SetQuery_seq(const TQuery_seq& value);
427  void SetQuery_seq(TQuery_seq&& value);
428 
429  /// Assign a value to Query_seq data member.
430  ///
431  /// @return
432  /// Reference to the data value.
433  TQuery_seq& SetQuery_seq(void);
434 
435  /// search parameters
436  /// Check if a value has been assigned to Param data member.
437  ///
438  /// Data member Param is mandatory;
439  /// its type is defined as 'typedef CParameters TParam'
440  /// @return
441  /// - true, if a value has been assigned.
442  /// - false, otherwise.
443  bool IsSetParam(void) const;
444 
445  /// Check if it is safe to call GetParam method.
446  ///
447  /// @return
448  /// - true, if the data member is getatable.
449  /// - false, otherwise.
450  bool CanGetParam(void) const;
451 
452  /// Reset Param data member.
453  void ResetParam(void);
454 
455  /// Get the Param member data.
456  ///
457  /// @return
458  /// Reference to the member data.
459  const TParam& GetParam(void) const;
460 
461  /// Assign a value to Param data member.
462  ///
463  /// @param value
464  /// Reference to value.
465  void SetParam(TParam& value);
466 
467  /// Assign a value to Param data member.
468  ///
469  /// @return
470  /// Reference to the data value.
471  TParam& SetParam(void);
472 
473  /// Check if a value has been assigned to Iterations data member.
474  ///
475  /// Data member Iterations is mandatory;
476  /// its type is defined as 'typedef list< CRef< CIteration > > TIterations'
477  /// @return
478  /// - true, if a value has been assigned.
479  /// - false, otherwise.
480  bool IsSetIterations(void) const;
481 
482  /// Check if it is safe to call GetIterations method.
483  ///
484  /// @return
485  /// - true, if the data member is getatable.
486  /// - false, otherwise.
487  bool CanGetIterations(void) const;
488 
489  /// Reset Iterations data member.
490  void ResetIterations(void);
491 
492  /// Get the Iterations member data.
493  ///
494  /// @return
495  /// Reference to the member data.
496  const TIterations& GetIterations(void) const;
497 
498  /// Assign a value to Iterations data member.
499  ///
500  /// @return
501  /// Reference to the data value.
502  TIterations& SetIterations(void);
503 
504  /// Mega BLAST search statistics
505  /// Check if a value has been assigned to Mbstat data member.
506  ///
507  /// Data member Mbstat is optional;
508  /// its type is defined as 'typedef CStatistics TMbstat'
509  /// @return
510  /// - true, if a value has been assigned.
511  /// - false, otherwise.
512  bool IsSetMbstat(void) const;
513 
514  /// Check if it is safe to call GetMbstat method.
515  ///
516  /// @return
517  /// - true, if the data member is getatable.
518  /// - false, otherwise.
519  bool CanGetMbstat(void) const;
520 
521  /// Reset Mbstat data member.
522  void ResetMbstat(void);
523 
524  /// Get the Mbstat member data.
525  ///
526  /// @return
527  /// Reference to the member data.
528  const TMbstat& GetMbstat(void) const;
529 
530  /// Assign a value to Mbstat data member.
531  ///
532  /// @param value
533  /// Reference to value.
534  void SetMbstat(TMbstat& value);
535 
536  /// Assign a value to Mbstat data member.
537  ///
538  /// @return
539  /// Reference to the data value.
540  TMbstat& SetMbstat(void);
541 
542  /// Reset the whole object
543  virtual void Reset(void);
544 
545 
546 private:
547  // Prohibit copy constructor and assignment operator
550 
551  // data
552  Uint4 m_set_State[1];
553  string m_Program;
554  string m_Version;
555  string m_Reference;
556  string m_Db;
557  string m_Query_ID;
558  string m_Query_def;
560  string m_Query_seq;
562  list< CRef< CIteration > > m_Iterations;
564 };
565 
566 /* @} */
567 
568 
569 
570 
571 
572 ///////////////////////////////////////////////////////////
573 ///////////////////// inline methods //////////////////////
574 ///////////////////////////////////////////////////////////
575 inline
577 {
578  return ((m_set_State[0] & 0x3) != 0);
579 }
580 
581 inline
583 {
584  return IsSetProgram();
585 }
586 
587 inline
589 {
590  if (!CanGetProgram()) {
591  ThrowUnassigned(0);
592  }
593  return m_Program;
594 }
595 
596 inline
598 {
599  m_Program = value;
600  m_set_State[0] |= 0x3;
601 }
602 
603 inline
605 {
606  m_Program = std::forward<CBlastOutput_Base::TProgram>(value);
607  m_set_State[0] |= 0x3;
608 }
609 
610 inline
612 {
613 #ifdef _DEBUG
614  if (!IsSetProgram()) {
616  }
617 #endif
618  m_set_State[0] |= 0x1;
619  return m_Program;
620 }
621 
622 inline
624 {
625  return ((m_set_State[0] & 0xc) != 0);
626 }
627 
628 inline
630 {
631  return IsSetVersion();
632 }
633 
634 inline
636 {
637  if (!CanGetVersion()) {
638  ThrowUnassigned(1);
639  }
640  return m_Version;
641 }
642 
643 inline
645 {
646  m_Version = value;
647  m_set_State[0] |= 0xc;
648 }
649 
650 inline
652 {
653  m_Version = std::forward<CBlastOutput_Base::TVersion>(value);
654  m_set_State[0] |= 0xc;
655 }
656 
657 inline
659 {
660 #ifdef _DEBUG
661  if (!IsSetVersion()) {
663  }
664 #endif
665  m_set_State[0] |= 0x4;
666  return m_Version;
667 }
668 
669 inline
671 {
672  return ((m_set_State[0] & 0x30) != 0);
673 }
674 
675 inline
677 {
678  return IsSetReference();
679 }
680 
681 inline
683 {
684  if (!CanGetReference()) {
685  ThrowUnassigned(2);
686  }
687  return m_Reference;
688 }
689 
690 inline
692 {
693  m_Reference = value;
694  m_set_State[0] |= 0x30;
695 }
696 
697 inline
699 {
700  m_Reference = std::forward<CBlastOutput_Base::TReference>(value);
701  m_set_State[0] |= 0x30;
702 }
703 
704 inline
706 {
707 #ifdef _DEBUG
708  if (!IsSetReference()) {
710  }
711 #endif
712  m_set_State[0] |= 0x10;
713  return m_Reference;
714 }
715 
716 inline
718 {
719  return ((m_set_State[0] & 0xc0) != 0);
720 }
721 
722 inline
724 {
725  return IsSetDb();
726 }
727 
728 inline
730 {
731  if (!CanGetDb()) {
732  ThrowUnassigned(3);
733  }
734  return m_Db;
735 }
736 
737 inline
739 {
740  m_Db = value;
741  m_set_State[0] |= 0xc0;
742 }
743 
744 inline
746 {
747  m_Db = std::forward<CBlastOutput_Base::TDb>(value);
748  m_set_State[0] |= 0xc0;
749 }
750 
751 inline
753 {
754 #ifdef _DEBUG
755  if (!IsSetDb()) {
757  }
758 #endif
759  m_set_State[0] |= 0x40;
760  return m_Db;
761 }
762 
763 inline
765 {
766  return ((m_set_State[0] & 0x300) != 0);
767 }
768 
769 inline
771 {
772  return IsSetQuery_ID();
773 }
774 
775 inline
777 {
778  if (!CanGetQuery_ID()) {
779  ThrowUnassigned(4);
780  }
781  return m_Query_ID;
782 }
783 
784 inline
786 {
787  m_Query_ID = value;
788  m_set_State[0] |= 0x300;
789 }
790 
791 inline
793 {
794  m_Query_ID = std::forward<CBlastOutput_Base::TQuery_ID>(value);
795  m_set_State[0] |= 0x300;
796 }
797 
798 inline
800 {
801 #ifdef _DEBUG
802  if (!IsSetQuery_ID()) {
804  }
805 #endif
806  m_set_State[0] |= 0x100;
807  return m_Query_ID;
808 }
809 
810 inline
812 {
813  return ((m_set_State[0] & 0xc00) != 0);
814 }
815 
816 inline
818 {
819  return IsSetQuery_def();
820 }
821 
822 inline
824 {
825  if (!CanGetQuery_def()) {
826  ThrowUnassigned(5);
827  }
828  return m_Query_def;
829 }
830 
831 inline
833 {
834  m_Query_def = value;
835  m_set_State[0] |= 0xc00;
836 }
837 
838 inline
840 {
841  m_Query_def = std::forward<CBlastOutput_Base::TQuery_def>(value);
842  m_set_State[0] |= 0xc00;
843 }
844 
845 inline
847 {
848 #ifdef _DEBUG
849  if (!IsSetQuery_def()) {
851  }
852 #endif
853  m_set_State[0] |= 0x400;
854  return m_Query_def;
855 }
856 
857 inline
859 {
860  return ((m_set_State[0] & 0x3000) != 0);
861 }
862 
863 inline
865 {
866  return IsSetQuery_len();
867 }
868 
869 inline
871 {
872  m_Query_len = 0;
873  m_set_State[0] &= ~0x3000;
874 }
875 
876 inline
878 {
879  if (!CanGetQuery_len()) {
880  ThrowUnassigned(6);
881  }
882  return m_Query_len;
883 }
884 
885 inline
887 {
888  m_Query_len = value;
889  m_set_State[0] |= 0x3000;
890 }
891 
892 inline
894 {
895 #ifdef _DEBUG
896  if (!IsSetQuery_len()) {
897  memset(&m_Query_len,UnassignedByte(),sizeof(m_Query_len));
898  }
899 #endif
900  m_set_State[0] |= 0x1000;
901  return m_Query_len;
902 }
903 
904 inline
906 {
907  return ((m_set_State[0] & 0xc000) != 0);
908 }
909 
910 inline
912 {
913  return IsSetQuery_seq();
914 }
915 
916 inline
918 {
919  if (!CanGetQuery_seq()) {
920  ThrowUnassigned(7);
921  }
922  return m_Query_seq;
923 }
924 
925 inline
927 {
928  m_Query_seq = value;
929  m_set_State[0] |= 0xc000;
930 }
931 
932 inline
934 {
935  m_Query_seq = std::forward<CBlastOutput_Base::TQuery_seq>(value);
936  m_set_State[0] |= 0xc000;
937 }
938 
939 inline
941 {
942 #ifdef _DEBUG
943  if (!IsSetQuery_seq()) {
945  }
946 #endif
947  m_set_State[0] |= 0x4000;
948  return m_Query_seq;
949 }
950 
951 inline
953 {
954  return m_Param.NotEmpty();
955 }
956 
957 inline
959 {
960  return true;
961 }
962 
963 inline
965 {
966  if ( !m_Param ) {
967  const_cast<CBlastOutput_Base*>(this)->ResetParam();
968  }
969  return (*m_Param);
970 }
971 
972 inline
974 {
975  if ( !m_Param ) {
976  ResetParam();
977  }
978  return (*m_Param);
979 }
980 
981 inline
983 {
984  return ((m_set_State[0] & 0xc0000) != 0);
985 }
986 
987 inline
989 {
990  return true;
991 }
992 
993 inline
995 {
996  return m_Iterations;
997 }
998 
999 inline
1001 {
1002  m_set_State[0] |= 0x40000;
1003  return m_Iterations;
1004 }
1005 
1006 inline
1008 {
1009  return m_Mbstat.NotEmpty();
1010 }
1011 
1012 inline
1014 {
1015  return IsSetMbstat();
1016 }
1017 
1018 inline
1020 {
1021  if (!CanGetMbstat()) {
1022  ThrowUnassigned(10);
1023  }
1024  return (*m_Mbstat);
1025 }
1026 
1027 ///////////////////////////////////////////////////////////
1028 ////////////////// end of inline methods //////////////////
1029 ///////////////////////////////////////////////////////////
1030 
1031 
1032 
1033 
1034 
1035 END_objects_SCOPE // namespace ncbi::objects::
1036 
1038 
1039 
1040 #endif // OBJECTS_BLASTXML_BLASTOUTPUT_BASE_HPP
CBlastOutput_Base –.
CIteration –.
Definition: Iteration.hpp:66
CParameters –.
Definition: Parameters.hpp:66
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
CStatistics –.
Definition: Statistics.hpp:66
char value[7]
Definition: config.c:431
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
#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_BLASTXML_EXPORT
Definition: ncbi_export.h:344
CBlastOutput_Base(const CBlastOutput_Base &)
TParam & SetParam(void)
Assign a value to Param data member.
CParameters TParam
const TDb & GetDb(void) const
Get the Db member data.
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
void ResetQuery_len(void)
Reset Query_len data member.
bool CanGetIterations(void) const
Check if it is safe to call GetIterations method.
bool IsSetIterations(void) const
Check if a value has been assigned to Iterations data member.
TVersion & SetVersion(void)
Assign a value to Version data member.
const TVersion & GetVersion(void) const
Get the Version member data.
TQuery_seq & SetQuery_seq(void)
Assign a value to Query_seq data member.
TProgram & SetProgram(void)
Assign a value to Program data member.
TQuery_ID & SetQuery_ID(void)
Assign a value to Query_ID data member.
const TProgram & GetProgram(void) const
Get the Program member data.
CSerialObject Tparent
Tparent::CMemberIndex< E_memberIndex, 12 > TmemberIndex
bool CanGetQuery_ID(void) const
Check if it is safe to call GetQuery_ID method.
const TParam & GetParam(void) const
Get the Param member data.
list< CRef< CIteration > > TIterations
bool CanGetQuery_seq(void) const
Check if it is safe to call GetQuery_seq method.
bool CanGetQuery_len(void) const
Check if it is safe to call GetQuery_len method.
bool CanGetParam(void) const
Check if it is safe to call GetParam method.
TQuery_len GetQuery_len(void) const
Get the Query_len member data.
const TMbstat & GetMbstat(void) const
Get the Mbstat member data.
CBlastOutput_Base & operator=(const CBlastOutput_Base &)
CRef< TMbstat > m_Mbstat
TQuery_def & SetQuery_def(void)
Assign a value to Query_def data member.
bool CanGetMbstat(void) const
Check if it is safe to call GetMbstat method.
bool CanGetProgram(void) const
Check if it is safe to call GetProgram method.
CStatistics TMbstat
bool IsSetQuery_def(void) const
Definition line of query Check if a value has been assigned to Query_def data member.
bool IsSetVersion(void) const
Program version Check if a value has been assigned to Version data member.
TDb & SetDb(void)
Assign a value to Db data member.
bool IsSetReference(void) const
Steven, David, Tom and others Check if a value has been assigned to Reference data member.
bool IsSetQuery_ID(void) const
SeqId of query Check if a value has been assigned to Query_ID data member.
bool CanGetReference(void) const
Check if it is safe to call GetReference method.
TQuery_len & SetQuery_len(void)
Assign a value to Query_len data member.
list< CRef< CIteration > > m_Iterations
TIterations & SetIterations(void)
Assign a value to Iterations data member.
bool CanGetQuery_def(void) const
Check if it is safe to call GetQuery_def method.
bool IsSetParam(void) const
search parameters Check if a value has been assigned to Param data member.
bool IsSetDb(void) const
BLAST Database name Check if a value has been assigned to Db data member.
const TQuery_ID & GetQuery_ID(void) const
Get the Query_ID member data.
bool IsSetQuery_seq(void) const
query sequence itself Check if a value has been assigned to Query_seq data member.
void ResetParam(void)
Reset Param data member.
bool CanGetDb(void) const
Check if it is safe to call GetDb method.
bool IsSetProgram(void) const
BLAST program: blastp, tblastx etc.
bool IsSetQuery_len(void) const
length of query sequence Check if a value has been assigned to Query_len data member.
const TQuery_seq & GetQuery_seq(void) const
Get the Query_seq member data.
TReference & SetReference(void)
Assign a value to Reference data member.
const TIterations & GetIterations(void) const
Get the Iterations member data.
CRef< TParam > m_Param
const TQuery_def & GetQuery_def(void) const
Get the Query_def member data.
bool IsSetMbstat(void) const
Mega BLAST search statistics Check if a value has been assigned to Mbstat data member.
const TReference & GetReference(void) const
Get the Reference member data.
Modified on Sun Feb 25 03:05:04 2024 by modify_doxy.py rev. 669887