NCBI C++ ToolKit
Pubdesc_.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 Pubdesc_.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/seq/seq.asn">seq.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seq/seq.def">seq.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_SEQ_PUBDESC_BASE_HPP
42 #define OBJECTS_SEQ_PUBDESC_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 // forward declarations
60 class CNumbering;
61 class CPub_equiv;
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_Sequence
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 /// how sequence presented in pub
74 ///
75 /// CPubdesc_Base --
76 ///
77 
79 {
81 public:
82  // constructor
83  CPubdesc_Base(void);
84  // destructor
85  virtual ~CPubdesc_Base(void);
86 
87  // type info
89 
90  /// type of reference in a GenBank record
91  enum EReftype {
92  eReftype_seq = 0, ///< refers to sequence
93  eReftype_sites = 1, ///< refers to unspecified features
94  eReftype_feats = 2, ///< refers to specified features
95  eReftype_no_target = 3 ///< nothing specified (EMBL)
96  };
97 
98  /// Access to EReftype's attributes (values, names) as defined in spec
99  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EReftype)(void);
100 
101  // types
102  typedef CPub_equiv TPub;
103  typedef string TName;
104  typedef string TFig;
105  typedef CNumbering TNum;
106  typedef bool TNumexc;
107  typedef bool TPoly_a;
108  typedef string TMaploc;
109  typedef string TSeq_raw;
110  typedef int TAlign_group;
111  typedef string TComment;
112  typedef int TReftype;
113 
114  // member index
115  enum class E_memberIndex {
116  e__allMandatory = 0,
117  e_pub,
118  e_name,
119  e_fig,
120  e_num,
121  e_numexc,
122  e_poly_a,
123  e_maploc,
124  e_seq_raw,
125  e_align_group,
126  e_comment,
127  e_reftype
128  };
130 
131  // getters
132  // setters
133 
134  /// the citation(s)
135  /// Check if a value has been assigned to Pub data member.
136  ///
137  /// Data member Pub is mandatory;
138  /// its type is defined as 'typedef CPub_equiv TPub'
139  /// @return
140  /// - true, if a value has been assigned.
141  /// - false, otherwise.
142  bool IsSetPub(void) const;
143 
144  /// Check if it is safe to call GetPub method.
145  ///
146  /// @return
147  /// - true, if the data member is getatable.
148  /// - false, otherwise.
149  bool CanGetPub(void) const;
150 
151  /// Reset Pub data member.
152  void ResetPub(void);
153 
154  /// Get the Pub member data.
155  ///
156  /// @return
157  /// Reference to the member data.
158  const TPub& GetPub(void) const;
159 
160  /// Assign a value to Pub data member.
161  ///
162  /// @param value
163  /// Reference to value.
164  void SetPub(TPub& value);
165 
166  /// Assign a value to Pub data member.
167  ///
168  /// @return
169  /// Reference to the data value.
170  TPub& SetPub(void);
171 
172  /// name used in paper
173  /// Check if a value has been assigned to Name data member.
174  ///
175  /// Data member Name is optional;
176  /// its type is defined as 'typedef string TName'
177  /// @return
178  /// - true, if a value has been assigned.
179  /// - false, otherwise.
180  bool IsSetName(void) const;
181 
182  /// Check if it is safe to call GetName method.
183  ///
184  /// @return
185  /// - true, if the data member is getatable.
186  /// - false, otherwise.
187  bool CanGetName(void) const;
188 
189  /// Reset Name data member.
190  void ResetName(void);
191 
192  /// Get the Name member data.
193  ///
194  /// @return
195  /// Reference to the member data.
196  const TName& GetName(void) const;
197 
198  /// Assign a value to Name data member.
199  ///
200  /// @param value
201  /// Value to assign
202  void SetName(const TName& value);
203  void SetName(TName&& value);
204 
205  /// Assign a value to Name data member.
206  ///
207  /// @return
208  /// Reference to the data value.
209  TName& SetName(void);
210 
211  /// figure in paper
212  /// Check if a value has been assigned to Fig data member.
213  ///
214  /// Data member Fig is optional;
215  /// its type is defined as 'typedef string TFig'
216  /// @return
217  /// - true, if a value has been assigned.
218  /// - false, otherwise.
219  bool IsSetFig(void) const;
220 
221  /// Check if it is safe to call GetFig method.
222  ///
223  /// @return
224  /// - true, if the data member is getatable.
225  /// - false, otherwise.
226  bool CanGetFig(void) const;
227 
228  /// Reset Fig data member.
229  void ResetFig(void);
230 
231  /// Get the Fig member data.
232  ///
233  /// @return
234  /// Reference to the member data.
235  const TFig& GetFig(void) const;
236 
237  /// Assign a value to Fig data member.
238  ///
239  /// @param value
240  /// Value to assign
241  void SetFig(const TFig& value);
242  void SetFig(TFig&& value);
243 
244  /// Assign a value to Fig data member.
245  ///
246  /// @return
247  /// Reference to the data value.
248  TFig& SetFig(void);
249 
250  /// numbering from paper
251  /// Check if a value has been assigned to Num data member.
252  ///
253  /// Data member Num is optional;
254  /// its type is defined as 'typedef CNumbering TNum'
255  /// @return
256  /// - true, if a value has been assigned.
257  /// - false, otherwise.
258  bool IsSetNum(void) const;
259 
260  /// Check if it is safe to call GetNum method.
261  ///
262  /// @return
263  /// - true, if the data member is getatable.
264  /// - false, otherwise.
265  bool CanGetNum(void) const;
266 
267  /// Reset Num data member.
268  void ResetNum(void);
269 
270  /// Get the Num member data.
271  ///
272  /// @return
273  /// Reference to the member data.
274  const TNum& GetNum(void) const;
275 
276  /// Assign a value to Num data member.
277  ///
278  /// @param value
279  /// Reference to value.
280  void SetNum(TNum& value);
281 
282  /// Assign a value to Num data member.
283  ///
284  /// @return
285  /// Reference to the data value.
286  TNum& SetNum(void);
287 
288  /// numbering problem with paper
289  /// Check if a value has been assigned to Numexc data member.
290  ///
291  /// Data member Numexc is optional;
292  /// its type is defined as 'typedef bool TNumexc'
293  /// @return
294  /// - true, if a value has been assigned.
295  /// - false, otherwise.
296  bool IsSetNumexc(void) const;
297 
298  /// Check if it is safe to call GetNumexc method.
299  ///
300  /// @return
301  /// - true, if the data member is getatable.
302  /// - false, otherwise.
303  bool CanGetNumexc(void) const;
304 
305  /// Reset Numexc data member.
306  void ResetNumexc(void);
307 
308  /// Get the Numexc member data.
309  ///
310  /// @return
311  /// Copy of the member data.
312  TNumexc GetNumexc(void) const;
313 
314  /// Assign a value to Numexc data member.
315  ///
316  /// @param value
317  /// Value to assign
318  void SetNumexc(TNumexc value);
319 
320  /// Assign a value to Numexc data member.
321  ///
322  /// @return
323  /// Reference to the data value.
324  TNumexc& SetNumexc(void);
325 
326  /// poly A tail indicated in figure?
327  /// Check if a value has been assigned to Poly_a data member.
328  ///
329  /// Data member Poly_a is optional;
330  /// its type is defined as 'typedef bool TPoly_a'
331  /// @return
332  /// - true, if a value has been assigned.
333  /// - false, otherwise.
334  bool IsSetPoly_a(void) const;
335 
336  /// Check if it is safe to call GetPoly_a method.
337  ///
338  /// @return
339  /// - true, if the data member is getatable.
340  /// - false, otherwise.
341  bool CanGetPoly_a(void) const;
342 
343  /// Reset Poly_a data member.
344  void ResetPoly_a(void);
345 
346  /// Get the Poly_a member data.
347  ///
348  /// @return
349  /// Copy of the member data.
350  TPoly_a GetPoly_a(void) const;
351 
352  /// Assign a value to Poly_a data member.
353  ///
354  /// @param value
355  /// Value to assign
356  void SetPoly_a(TPoly_a value);
357 
358  /// Assign a value to Poly_a data member.
359  ///
360  /// @return
361  /// Reference to the data value.
362  TPoly_a& SetPoly_a(void);
363 
364  /// map location reported in paper
365  /// Check if a value has been assigned to Maploc data member.
366  ///
367  /// Data member Maploc is optional;
368  /// its type is defined as 'typedef string TMaploc'
369  /// @return
370  /// - true, if a value has been assigned.
371  /// - false, otherwise.
372  bool IsSetMaploc(void) const;
373 
374  /// Check if it is safe to call GetMaploc method.
375  ///
376  /// @return
377  /// - true, if the data member is getatable.
378  /// - false, otherwise.
379  bool CanGetMaploc(void) const;
380 
381  /// Reset Maploc data member.
382  void ResetMaploc(void);
383 
384  /// Get the Maploc member data.
385  ///
386  /// @return
387  /// Reference to the member data.
388  const TMaploc& GetMaploc(void) const;
389 
390  /// Assign a value to Maploc data member.
391  ///
392  /// @param value
393  /// Value to assign
394  void SetMaploc(const TMaploc& value);
395  void SetMaploc(TMaploc&& value);
396 
397  /// Assign a value to Maploc data member.
398  ///
399  /// @return
400  /// Reference to the data value.
401  TMaploc& SetMaploc(void);
402 
403  /// original sequence from paper
404  /// Check if a value has been assigned to Seq_raw data member.
405  ///
406  /// Data member Seq_raw is optional;
407  /// its type is defined as 'typedef string TSeq_raw'
408  /// @return
409  /// - true, if a value has been assigned.
410  /// - false, otherwise.
411  bool IsSetSeq_raw(void) const;
412 
413  /// Check if it is safe to call GetSeq_raw method.
414  ///
415  /// @return
416  /// - true, if the data member is getatable.
417  /// - false, otherwise.
418  bool CanGetSeq_raw(void) const;
419 
420  /// Reset Seq_raw data member.
421  void ResetSeq_raw(void);
422 
423  /// Get the Seq_raw member data.
424  ///
425  /// @return
426  /// Reference to the member data.
427  const TSeq_raw& GetSeq_raw(void) const;
428 
429  /// Assign a value to Seq_raw data member.
430  ///
431  /// @param value
432  /// Value to assign
433  void SetSeq_raw(const TSeq_raw& value);
434  void SetSeq_raw(TSeq_raw&& value);
435 
436  /// Assign a value to Seq_raw data member.
437  ///
438  /// @return
439  /// Reference to the data value.
440  TSeq_raw& SetSeq_raw(void);
441 
442  /// this seq aligned with others in paper
443  /// Check if a value has been assigned to Align_group data member.
444  ///
445  /// Data member Align_group is optional;
446  /// its type is defined as 'typedef int TAlign_group'
447  /// @return
448  /// - true, if a value has been assigned.
449  /// - false, otherwise.
450  bool IsSetAlign_group(void) const;
451 
452  /// Check if it is safe to call GetAlign_group method.
453  ///
454  /// @return
455  /// - true, if the data member is getatable.
456  /// - false, otherwise.
457  bool CanGetAlign_group(void) const;
458 
459  /// Reset Align_group data member.
460  void ResetAlign_group(void);
461 
462  /// Get the Align_group member data.
463  ///
464  /// @return
465  /// Copy of the member data.
466  TAlign_group GetAlign_group(void) const;
467 
468  /// Assign a value to Align_group data member.
469  ///
470  /// @param value
471  /// Value to assign
472  void SetAlign_group(TAlign_group value);
473 
474  /// Assign a value to Align_group data member.
475  ///
476  /// @return
477  /// Reference to the data value.
478  TAlign_group& SetAlign_group(void);
479 
480  /// any comment on this pub in context
481  /// Check if a value has been assigned to Comment data member.
482  ///
483  /// Data member Comment is optional;
484  /// its type is defined as 'typedef string TComment'
485  /// @return
486  /// - true, if a value has been assigned.
487  /// - false, otherwise.
488  bool IsSetComment(void) const;
489 
490  /// Check if it is safe to call GetComment method.
491  ///
492  /// @return
493  /// - true, if the data member is getatable.
494  /// - false, otherwise.
495  bool CanGetComment(void) const;
496 
497  /// Reset Comment data member.
498  void ResetComment(void);
499 
500  /// Get the Comment member data.
501  ///
502  /// @return
503  /// Reference to the member data.
504  const TComment& GetComment(void) const;
505 
506  /// Assign a value to Comment data member.
507  ///
508  /// @param value
509  /// Value to assign
510  void SetComment(const TComment& value);
511  void SetComment(TComment&& value);
512 
513  /// Assign a value to Comment data member.
514  ///
515  /// @return
516  /// Reference to the data value.
517  TComment& SetComment(void);
518 
519  /// Check if a value has been assigned to Reftype data member.
520  ///
521  /// Data member Reftype is optional with default eReftype_seq;
522  /// its type is defined as 'typedef int TReftype'
523  /// @return
524  /// - true, if a value has been assigned.
525  /// - false, otherwise.
526  bool IsSetReftype(void) const;
527 
528  /// Check if it is safe to call GetReftype method.
529  ///
530  /// @return
531  /// - true, if the data member is getatable.
532  /// - false, otherwise.
533  bool CanGetReftype(void) const;
534 
535  /// Reset Reftype data member.
536  void ResetReftype(void);
537 
538  /// Assign default value to Reftype data member.
539  void SetDefaultReftype(void);
540 
541  /// Get the Reftype member data.
542  ///
543  /// @return
544  /// Copy of the member data.
545  TReftype GetReftype(void) const;
546 
547  /// Assign a value to Reftype data member.
548  ///
549  /// @param value
550  /// Value to assign
551  void SetReftype(TReftype value);
552 
553  /// Assign a value to Reftype data member.
554  ///
555  /// @return
556  /// Reference to the data value.
557  TReftype& SetReftype(void);
558 
559  /// Reset the whole object
560  virtual void Reset(void);
561 
562 
563 private:
564  // Prohibit copy constructor and assignment operator
567 
568  // data
569  Uint4 m_set_State[1];
571  string m_Name;
572  string m_Fig;
574  bool m_Numexc;
575  bool m_Poly_a;
576  string m_Maploc;
577  string m_Seq_raw;
579  string m_Comment;
581 };
582 
583 /* @} */
584 
585 
586 
587 
588 
589 ///////////////////////////////////////////////////////////
590 ///////////////////// inline methods //////////////////////
591 ///////////////////////////////////////////////////////////
592 inline
593 bool CPubdesc_Base::IsSetPub(void) const
594 {
595  return m_Pub.NotEmpty();
596 }
597 
598 inline
599 bool CPubdesc_Base::CanGetPub(void) const
600 {
601  return true;
602 }
603 
604 inline
606 {
607  if ( !m_Pub ) {
608  const_cast<CPubdesc_Base*>(this)->ResetPub();
609  }
610  return (*m_Pub);
611 }
612 
613 inline
615 {
616  if ( !m_Pub ) {
617  ResetPub();
618  }
619  return (*m_Pub);
620 }
621 
622 inline
623 bool CPubdesc_Base::IsSetName(void) const
624 {
625  return ((m_set_State[0] & 0xc) != 0);
626 }
627 
628 inline
630 {
631  return IsSetName();
632 }
633 
634 inline
636 {
637  if (!CanGetName()) {
638  ThrowUnassigned(1);
639  }
640  return m_Name;
641 }
642 
643 inline
645 {
646  m_Name = value;
647  m_set_State[0] |= 0xc;
648 }
649 
650 inline
652 {
653  m_Name = std::forward<CPubdesc_Base::TName>(value);
654  m_set_State[0] |= 0xc;
655 }
656 
657 inline
659 {
660 #ifdef _DEBUG
661  if (!IsSetName()) {
663  }
664 #endif
665  m_set_State[0] |= 0x4;
666  return m_Name;
667 }
668 
669 inline
670 bool CPubdesc_Base::IsSetFig(void) const
671 {
672  return ((m_set_State[0] & 0x30) != 0);
673 }
674 
675 inline
676 bool CPubdesc_Base::CanGetFig(void) const
677 {
678  return IsSetFig();
679 }
680 
681 inline
683 {
684  if (!CanGetFig()) {
685  ThrowUnassigned(2);
686  }
687  return m_Fig;
688 }
689 
690 inline
692 {
693  m_Fig = value;
694  m_set_State[0] |= 0x30;
695 }
696 
697 inline
699 {
700  m_Fig = std::forward<CPubdesc_Base::TFig>(value);
701  m_set_State[0] |= 0x30;
702 }
703 
704 inline
706 {
707 #ifdef _DEBUG
708  if (!IsSetFig()) {
710  }
711 #endif
712  m_set_State[0] |= 0x10;
713  return m_Fig;
714 }
715 
716 inline
717 bool CPubdesc_Base::IsSetNum(void) const
718 {
719  return m_Num.NotEmpty();
720 }
721 
722 inline
723 bool CPubdesc_Base::CanGetNum(void) const
724 {
725  return IsSetNum();
726 }
727 
728 inline
730 {
731  if (!CanGetNum()) {
732  ThrowUnassigned(3);
733  }
734  return (*m_Num);
735 }
736 
737 inline
739 {
740  return ((m_set_State[0] & 0x300) != 0);
741 }
742 
743 inline
745 {
746  return IsSetNumexc();
747 }
748 
749 inline
751 {
752  m_Numexc = 0;
753  m_set_State[0] &= ~0x300;
754 }
755 
756 inline
758 {
759  if (!CanGetNumexc()) {
760  ThrowUnassigned(4);
761  }
762  return m_Numexc;
763 }
764 
765 inline
767 {
768  m_Numexc = value;
769  m_set_State[0] |= 0x300;
770 }
771 
772 inline
774 {
775 #ifdef _DEBUG
776  if (!IsSetNumexc()) {
777  memset(&m_Numexc,UnassignedByte(),sizeof(m_Numexc));
778  }
779 #endif
780  m_set_State[0] |= 0x100;
781  return m_Numexc;
782 }
783 
784 inline
786 {
787  return ((m_set_State[0] & 0xc00) != 0);
788 }
789 
790 inline
792 {
793  return IsSetPoly_a();
794 }
795 
796 inline
798 {
799  m_Poly_a = 0;
800  m_set_State[0] &= ~0xc00;
801 }
802 
803 inline
805 {
806  if (!CanGetPoly_a()) {
807  ThrowUnassigned(5);
808  }
809  return m_Poly_a;
810 }
811 
812 inline
814 {
815  m_Poly_a = value;
816  m_set_State[0] |= 0xc00;
817 }
818 
819 inline
821 {
822 #ifdef _DEBUG
823  if (!IsSetPoly_a()) {
824  memset(&m_Poly_a,UnassignedByte(),sizeof(m_Poly_a));
825  }
826 #endif
827  m_set_State[0] |= 0x400;
828  return m_Poly_a;
829 }
830 
831 inline
833 {
834  return ((m_set_State[0] & 0x3000) != 0);
835 }
836 
837 inline
839 {
840  return IsSetMaploc();
841 }
842 
843 inline
845 {
846  if (!CanGetMaploc()) {
847  ThrowUnassigned(6);
848  }
849  return m_Maploc;
850 }
851 
852 inline
854 {
855  m_Maploc = value;
856  m_set_State[0] |= 0x3000;
857 }
858 
859 inline
861 {
862  m_Maploc = std::forward<CPubdesc_Base::TMaploc>(value);
863  m_set_State[0] |= 0x3000;
864 }
865 
866 inline
868 {
869 #ifdef _DEBUG
870  if (!IsSetMaploc()) {
872  }
873 #endif
874  m_set_State[0] |= 0x1000;
875  return m_Maploc;
876 }
877 
878 inline
880 {
881  return ((m_set_State[0] & 0xc000) != 0);
882 }
883 
884 inline
886 {
887  return IsSetSeq_raw();
888 }
889 
890 inline
892 {
893  if (!CanGetSeq_raw()) {
894  ThrowUnassigned(7);
895  }
896  return m_Seq_raw;
897 }
898 
899 inline
901 {
902  m_Seq_raw = value;
903  m_set_State[0] |= 0xc000;
904 }
905 
906 inline
908 {
909  m_Seq_raw = std::forward<CPubdesc_Base::TSeq_raw>(value);
910  m_set_State[0] |= 0xc000;
911 }
912 
913 inline
915 {
916 #ifdef _DEBUG
917  if (!IsSetSeq_raw()) {
919  }
920 #endif
921  m_set_State[0] |= 0x4000;
922  return m_Seq_raw;
923 }
924 
925 inline
927 {
928  return ((m_set_State[0] & 0x30000) != 0);
929 }
930 
931 inline
933 {
934  return IsSetAlign_group();
935 }
936 
937 inline
939 {
940  m_Align_group = 0;
941  m_set_State[0] &= ~0x30000;
942 }
943 
944 inline
946 {
947  if (!CanGetAlign_group()) {
948  ThrowUnassigned(8);
949  }
950  return m_Align_group;
951 }
952 
953 inline
955 {
957  m_set_State[0] |= 0x30000;
958 }
959 
960 inline
962 {
963 #ifdef _DEBUG
964  if (!IsSetAlign_group()) {
965  memset(&m_Align_group,UnassignedByte(),sizeof(m_Align_group));
966  }
967 #endif
968  m_set_State[0] |= 0x10000;
969  return m_Align_group;
970 }
971 
972 inline
974 {
975  return ((m_set_State[0] & 0xc0000) != 0);
976 }
977 
978 inline
980 {
981  return IsSetComment();
982 }
983 
984 inline
986 {
987  if (!CanGetComment()) {
988  ThrowUnassigned(9);
989  }
990  return m_Comment;
991 }
992 
993 inline
995 {
996  m_Comment = value;
997  m_set_State[0] |= 0xc0000;
998 }
999 
1000 inline
1002 {
1003  m_Comment = std::forward<CPubdesc_Base::TComment>(value);
1004  m_set_State[0] |= 0xc0000;
1005 }
1006 
1007 inline
1009 {
1010 #ifdef _DEBUG
1011  if (!IsSetComment()) {
1013  }
1014 #endif
1015  m_set_State[0] |= 0x40000;
1016  return m_Comment;
1017 }
1018 
1019 inline
1021 {
1022  return ((m_set_State[0] & 0x300000) != 0);
1023 }
1024 
1025 inline
1027 {
1028  return true;
1029 }
1030 
1031 inline
1033 {
1035  m_set_State[0] &= ~0x300000;
1036 }
1037 
1038 inline
1040 {
1041  ResetReftype();
1042 }
1043 
1044 inline
1046 {
1047  return m_Reftype;
1048 }
1049 
1050 inline
1052 {
1053  m_Reftype = value;
1054  m_set_State[0] |= 0x300000;
1055 }
1056 
1057 inline
1059 {
1060 #ifdef _DEBUG
1061  if (!IsSetReftype()) {
1062  memset(&m_Reftype,UnassignedByte(),sizeof(m_Reftype));
1063  }
1064 #endif
1065  m_set_State[0] |= 0x100000;
1066  return m_Reftype;
1067 }
1068 
1069 ///////////////////////////////////////////////////////////
1070 ////////////////// end of inline methods //////////////////
1071 ///////////////////////////////////////////////////////////
1072 
1073 
1074 
1075 
1076 
1077 END_objects_SCOPE // namespace ncbi::objects::
1078 
1080 
1081 
1082 #endif // OBJECTS_SEQ_PUBDESC_BASE_HPP
CNumbering –.
Definition: Numbering.hpp:66
how sequence presented in pub
Definition: Pubdesc_.hpp:79
CRef –.
Definition: ncbiobj.hpp:618
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_SEQ_EXPORT
Definition: ncbi_export.h:825
CPub_equiv TPub
Definition: Pubdesc_.hpp:102
TName & SetName(void)
Assign a value to Name data member.
Definition: Pubdesc_.hpp:658
bool IsSetComment(void) const
any comment on this pub in context Check if a value has been assigned to Comment data member.
Definition: Pubdesc_.hpp:973
string m_Fig
Definition: Pubdesc_.hpp:572
void ResetPoly_a(void)
Reset Poly_a data member.
Definition: Pubdesc_.hpp:797
TFig & SetFig(void)
Assign a value to Fig data member.
Definition: Pubdesc_.hpp:705
CNumbering TNum
Definition: Pubdesc_.hpp:105
CSerialObject Tparent
Definition: Pubdesc_.hpp:80
string TSeq_raw
Definition: Pubdesc_.hpp:109
bool CanGetNum(void) const
Check if it is safe to call GetNum method.
Definition: Pubdesc_.hpp:723
TPub & SetPub(void)
Assign a value to Pub data member.
Definition: Pubdesc_.hpp:614
TAlign_group GetAlign_group(void) const
Get the Align_group member data.
Definition: Pubdesc_.hpp:945
EReftype
type of reference in a GenBank record
Definition: Pubdesc_.hpp:91
bool CanGetPub(void) const
Check if it is safe to call GetPub method.
Definition: Pubdesc_.hpp:599
const TComment & GetComment(void) const
Get the Comment member data.
Definition: Pubdesc_.hpp:985
TPoly_a GetPoly_a(void) const
Get the Poly_a member data.
Definition: Pubdesc_.hpp:804
string m_Name
Definition: Pubdesc_.hpp:571
TNumexc & SetNumexc(void)
Assign a value to Numexc data member.
Definition: Pubdesc_.hpp:773
Tparent::CMemberIndex< E_memberIndex, 12 > TmemberIndex
Definition: Pubdesc_.hpp:129
bool IsSetFig(void) const
figure in paper Check if a value has been assigned to Fig data member.
Definition: Pubdesc_.hpp:670
bool CanGetReftype(void) const
Check if it is safe to call GetReftype method.
Definition: Pubdesc_.hpp:1026
bool IsSetNumexc(void) const
numbering problem with paper Check if a value has been assigned to Numexc data member.
Definition: Pubdesc_.hpp:738
bool CanGetName(void) const
Check if it is safe to call GetName method.
Definition: Pubdesc_.hpp:629
const TName & GetName(void) const
Get the Name member data.
Definition: Pubdesc_.hpp:635
bool CanGetFig(void) const
Check if it is safe to call GetFig method.
Definition: Pubdesc_.hpp:676
TComment & SetComment(void)
Assign a value to Comment data member.
Definition: Pubdesc_.hpp:1008
void ResetNumexc(void)
Reset Numexc data member.
Definition: Pubdesc_.hpp:750
bool IsSetName(void) const
name used in paper Check if a value has been assigned to Name data member.
Definition: Pubdesc_.hpp:623
void ResetPub(void)
Reset Pub data member.
Definition: Pubdesc_.cpp:63
void ResetAlign_group(void)
Reset Align_group data member.
Definition: Pubdesc_.hpp:938
bool IsSetMaploc(void) const
map location reported in paper Check if a value has been assigned to Maploc data member.
Definition: Pubdesc_.hpp:832
Uint4 m_set_State[1]
Definition: Pubdesc_.hpp:569
bool CanGetAlign_group(void) const
Check if it is safe to call GetAlign_group method.
Definition: Pubdesc_.hpp:932
CRef< TNum > m_Num
Definition: Pubdesc_.hpp:573
TReftype & SetReftype(void)
Assign a value to Reftype data member.
Definition: Pubdesc_.hpp:1058
bool IsSetSeq_raw(void) const
original sequence from paper Check if a value has been assigned to Seq_raw data member.
Definition: Pubdesc_.hpp:879
DECLARE_INTERNAL_TYPE_INFO()
string m_Maploc
Definition: Pubdesc_.hpp:576
const TFig & GetFig(void) const
Get the Fig member data.
Definition: Pubdesc_.hpp:682
CPubdesc_Base(const CPubdesc_Base &)
TAlign_group & SetAlign_group(void)
Assign a value to Align_group data member.
Definition: Pubdesc_.hpp:961
string m_Seq_raw
Definition: Pubdesc_.hpp:577
const TSeq_raw & GetSeq_raw(void) const
Get the Seq_raw member data.
Definition: Pubdesc_.hpp:891
TMaploc & SetMaploc(void)
Assign a value to Maploc data member.
Definition: Pubdesc_.hpp:867
string TName
Definition: Pubdesc_.hpp:103
TNumexc GetNumexc(void) const
Get the Numexc member data.
Definition: Pubdesc_.hpp:757
TSeq_raw & SetSeq_raw(void)
Assign a value to Seq_raw data member.
Definition: Pubdesc_.hpp:914
bool CanGetSeq_raw(void) const
Check if it is safe to call GetSeq_raw method.
Definition: Pubdesc_.hpp:885
bool IsSetPub(void) const
the citation(s) Check if a value has been assigned to Pub data member.
Definition: Pubdesc_.hpp:593
bool CanGetComment(void) const
Check if it is safe to call GetComment method.
Definition: Pubdesc_.hpp:979
bool IsSetNum(void) const
numbering from paper Check if a value has been assigned to Num data member.
Definition: Pubdesc_.hpp:717
bool CanGetPoly_a(void) const
Check if it is safe to call GetPoly_a method.
Definition: Pubdesc_.hpp:791
CRef< TPub > m_Pub
Definition: Pubdesc_.hpp:570
string m_Comment
Definition: Pubdesc_.hpp:579
TReftype GetReftype(void) const
Get the Reftype member data.
Definition: Pubdesc_.hpp:1045
void SetDefaultReftype(void)
Assign default value to Reftype data member.
Definition: Pubdesc_.hpp:1039
TPoly_a & SetPoly_a(void)
Assign a value to Poly_a data member.
Definition: Pubdesc_.hpp:820
string TMaploc
Definition: Pubdesc_.hpp:108
bool CanGetMaploc(void) const
Check if it is safe to call GetMaploc method.
Definition: Pubdesc_.hpp:838
const TNum & GetNum(void) const
Get the Num member data.
Definition: Pubdesc_.hpp:729
bool CanGetNumexc(void) const
Check if it is safe to call GetNumexc method.
Definition: Pubdesc_.hpp:744
const TPub & GetPub(void) const
Get the Pub member data.
Definition: Pubdesc_.hpp:605
bool IsSetAlign_group(void) const
this seq aligned with others in paper Check if a value has been assigned to Align_group data member.
Definition: Pubdesc_.hpp:926
bool IsSetPoly_a(void) const
poly A tail indicated in figure? Check if a value has been assigned to Poly_a data member.
Definition: Pubdesc_.hpp:785
CPubdesc_Base & operator=(const CPubdesc_Base &)
bool IsSetReftype(void) const
Check if a value has been assigned to Reftype data member.
Definition: Pubdesc_.hpp:1020
void ResetReftype(void)
Reset Reftype data member.
Definition: Pubdesc_.hpp:1032
string TComment
Definition: Pubdesc_.hpp:111
const TMaploc & GetMaploc(void) const
Get the Maploc member data.
Definition: Pubdesc_.hpp:844
@ eReftype_seq
refers to sequence
Definition: Pubdesc_.hpp:92
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sun Apr 14 05:27:28 2024 by modify_doxy.py rev. 669887