NCBI C++ ToolKit
Cdd_descr_.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 Cdd_descr_.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/cdd/cdd.asn">cdd.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cdd/cdd.def">cdd.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_CDD_CDD_DESCR_BASE_HPP
42 #define OBJECTS_CDD_CDD_DESCR_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 CCdd_book_ref;
62 class CCdd_id_set;
63 class CCdd_repeat;
64 class CDate;
65 class COrg_ref;
66 class CPub;
67 
68 
69 // generated classes
70 
71 
72 /** @addtogroup dataspec_NCBI_Cdd
73  *
74  * @{
75  */
76 
77 /////////////////////////////////////////////////////////////////////////////
78 /// The description of CDD's refers to the specific set of aligned sequences,
79 /// the region that is being aligned and the information contained in the
80 /// alignment. It may contain a lengthy comment
81 /// describing the function of the domain as well as its origin and all
82 /// other anecdotal information that can't be pressed into a rigid scheme.
83 /// Crosslinks to reference papers available in PubMed are possible as well.
84 /// There can be as many of these as you want in the CDD.
85 ///
86 /// CCdd_descr_Base --
87 ///
88 
90 {
92 public:
93  // constructor
94  CCdd_descr_Base(void);
95  // destructor
96  virtual ~CCdd_descr_Base(void);
97 
98  // type info
100 
101  enum EStatus {
102  eStatus_unassigned = 0,
103  eStatus_finished_ok = 1, ///< a public curated CD
104  eStatus_pending_release = 2, ///< needs work done, not yet released
105  eStatus_other_asis = 3, ///< imported as-is, immediate release
106  eStatus_matrix_only = 4, ///< CD holds a Psi-Blast PSSM only, does not contain alignment data
107  eStatus_update_running = 5, ///< has been flagged for update (in queue)
108  eStatus_auto_updated = 6, ///< update finished, no work necessary
109  eStatus_claimed = 7, ///< is earmarked for curation
110  eStatus_curated_complete = 8, ///< public curated member of a completed family
111  eStatus_other = 255 ///< for CD production?
112  };
113 
114  /// Access to EStatus's attributes (values, names) as defined in spec
115  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EStatus)(void);
116 
118  eCuration_status_unassigned = 0, ///< to record curation status
119  eCuration_status_prein = 1, ///< when CD is checked out from
120  eCuration_status_ofc = 2, ///< the tracking database, for
121  eCuration_status_iac = 3, ///< use within curation software
122  eCuration_status_ofv1 = 4,
123  eCuration_status_iav1 = 5,
124  eCuration_status_ofv2 = 6,
125  eCuration_status_iav2 = 7,
126  eCuration_status_postin = 8,
127  eCuration_status_other = 255
128  };
129 
130  /// Access to ECuration_status's attributes (values, names) as defined in spec
131  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ECuration_status)(void);
132 
134  eReadonly_status_unassigned = 0, ///< to record read-only status
135  eReadonly_status_readonly = 1, ///< when CD is checked out from
136  eReadonly_status_readwrite = 2, ///< the tracking database, for
137  eReadonly_status_other = 255 ///< use within curation software
138  };
139 
140  /// Access to EReadonly_status's attributes (values, names) as defined in spec
141  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EReadonly_status)(void);
142 
143 
144  /// Choice variants.
145  enum E_Choice {
146  e_not_set = 0, ///< No variant selected
147  e_Othername, ///< alternative names for the CDD if domain has several common names
148  e_Category, ///< intracellular, extracellular, etc. to record spatial and/or temporal expression in free-text format
149  e_Comment, ///< this is where descriptions go
150  e_Reference, ///< a citation describing the domain
151  e_Create_date, ///< Date of first creation/dump
152  e_Tax_source, ///< holds the highest common tax node
153  e_Source, ///< the database the seeds were created from, e.g. SMART, PFAM, etc..
155  e_Update_date, ///< Date of last version change
156  e_Scrapbook, ///< for storing curation notes those won't make it into public distributions
157  e_Source_id, ///< for linking back to source db
158  e_Repeats, ///< to record repeat counts
159  e_Old_root, ///< to record short-term history
162  e_Book_ref, ///< links to Entrez/books
163  e_Attribution, ///< add citations and/or author names
164  e_Title ///< hold short descriptive text
165  };
166  /// Maximum+1 value of the choice variant enumerator.
168  e_MaxChoice = 19 ///< == e_Title+1
169  };
170 
171  /// Reset the whole object
172  virtual void Reset(void);
173 
174  /// Reset the selection (set it to e_not_set).
175  virtual void ResetSelection(void);
176 
177  /// Which variant is currently selected.
178  ///
179  /// @return
180  /// Choice state enumerator.
181  E_Choice Which(void) const;
182 
183  /// Verify selection, throw exception if it differs from the expected.
184  ///
185  /// @param index
186  /// Expected selection.
187  void CheckSelected(E_Choice index) const;
188 
189  /// Throw 'InvalidSelection' exception.
190  ///
191  /// @param index
192  /// Expected selection.
193  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
194 
195  /// Retrieve selection name (for diagnostic purposes).
196  ///
197  /// @param index
198  /// One of possible selection states.
199  /// @return
200  /// Name string.
201  static string SelectionName(E_Choice index);
202 
203  /// Select the requested variant if needed.
204  ///
205  /// @param index
206  /// New selection state.
207  /// @param reset
208  /// Flag that defines the resetting of the variant data. The data will
209  /// be reset if either the current selection differs from the new one,
210  /// or the flag is set to eDoResetVariant.
212  /// Select the requested variant if needed,
213  /// allocating CObject variants from memory pool.
214  void Select(E_Choice index,
215  EResetVariant reset,
216  CObjectMemoryPool* pool);
217 
218  // types
219  typedef string TOthername;
220  typedef string TCategory;
221  typedef string TComment;
222  typedef CPub TReference;
225  typedef string TSource;
226  typedef int TStatus;
228  typedef list< string > TScrapbook;
232  typedef int TCuration_status;
233  typedef int TReadonly_status;
236  typedef string TTitle;
237 
238  // getters
239  // setters
240 
241 
242  /// Check if variant Othername is selected.
243  ///
244  /// Othername type is defined as 'typedef string TOthername'.
245  /// @return
246  /// - true, if the variant is selected.
247  /// - false, otherwise.
248  bool IsOthername(void) const;
249 
250  /// Get the variant data.
251  ///
252  /// @return
253  /// Reference to the data.
254  const TOthername& GetOthername(void) const;
255 
256  /// Select the variant.
257  ///
258  /// @return
259  /// Reference to the variant data.
260  TOthername& SetOthername(void);
261 
262  /// Select the variant and set its data.
263  ///
264  /// @param value
265  /// Variant data.
266  void SetOthername(const TOthername& value);
267 
268 
269  /// Check if variant Category is selected.
270  ///
271  /// Category type is defined as 'typedef string TCategory'.
272  /// @return
273  /// - true, if the variant is selected.
274  /// - false, otherwise.
275  bool IsCategory(void) const;
276 
277  /// Get the variant data.
278  ///
279  /// @return
280  /// Reference to the data.
281  const TCategory& GetCategory(void) const;
282 
283  /// Select the variant.
284  ///
285  /// @return
286  /// Reference to the variant data.
287  TCategory& SetCategory(void);
288 
289  /// Select the variant and set its data.
290  ///
291  /// @param value
292  /// Variant data.
293  void SetCategory(const TCategory& value);
294 
295 
296  /// Check if variant Comment is selected.
297  ///
298  /// Comment type is defined as 'typedef string TComment'.
299  /// @return
300  /// - true, if the variant is selected.
301  /// - false, otherwise.
302  bool IsComment(void) const;
303 
304  /// Get the variant data.
305  ///
306  /// @return
307  /// Reference to the data.
308  const TComment& GetComment(void) const;
309 
310  /// Select the variant.
311  ///
312  /// @return
313  /// Reference to the variant data.
314  TComment& SetComment(void);
315 
316  /// Select the variant and set its data.
317  ///
318  /// @param value
319  /// Variant data.
320  void SetComment(const TComment& value);
321 
322 
323  /// Check if variant Reference is selected.
324  ///
325  /// Reference type is defined as 'typedef CPub TReference'.
326  /// @return
327  /// - true, if the variant is selected.
328  /// - false, otherwise.
329  bool IsReference(void) const;
330 
331  /// Get the variant data.
332  ///
333  /// @return
334  /// Reference to the data.
335  const TReference& GetReference(void) const;
336 
337  /// Select the variant.
338  ///
339  /// @return
340  /// Reference to the variant data.
341  TReference& SetReference(void);
342  /// Select the variant and set its data.
343  ///
344  /// @param value
345  /// Reference to the data.
346  void SetReference(TReference& value);
347 
348 
349  /// Check if variant Create_date is selected.
350  ///
351  /// Create_date type is defined as 'typedef CDate TCreate_date'.
352  /// @return
353  /// - true, if the variant is selected.
354  /// - false, otherwise.
355  bool IsCreate_date(void) const;
356 
357  /// Get the variant data.
358  ///
359  /// @return
360  /// Reference to the data.
361  const TCreate_date& GetCreate_date(void) const;
362 
363  /// Select the variant.
364  ///
365  /// @return
366  /// Reference to the variant data.
367  TCreate_date& SetCreate_date(void);
368  /// Select the variant and set its data.
369  ///
370  /// @param value
371  /// Reference to the data.
372  void SetCreate_date(TCreate_date& value);
373 
374 
375  /// Check if variant Tax_source is selected.
376  ///
377  /// Tax_source type is defined as 'typedef COrg_ref TTax_source'.
378  /// @return
379  /// - true, if the variant is selected.
380  /// - false, otherwise.
381  bool IsTax_source(void) const;
382 
383  /// Get the variant data.
384  ///
385  /// @return
386  /// Reference to the data.
387  const TTax_source& GetTax_source(void) const;
388 
389  /// Select the variant.
390  ///
391  /// @return
392  /// Reference to the variant data.
393  TTax_source& SetTax_source(void);
394  /// Select the variant and set its data.
395  ///
396  /// @param value
397  /// Reference to the data.
398  void SetTax_source(TTax_source& value);
399 
400 
401  /// Check if variant Source is selected.
402  ///
403  /// Source type is defined as 'typedef string TSource'.
404  /// @return
405  /// - true, if the variant is selected.
406  /// - false, otherwise.
407  bool IsSource(void) const;
408 
409  /// Get the variant data.
410  ///
411  /// @return
412  /// Reference to the data.
413  const TSource& GetSource(void) const;
414 
415  /// Select the variant.
416  ///
417  /// @return
418  /// Reference to the variant data.
419  TSource& SetSource(void);
420 
421  /// Select the variant and set its data.
422  ///
423  /// @param value
424  /// Variant data.
425  void SetSource(const TSource& value);
426 
427 
428  /// Check if variant Status is selected.
429  ///
430  /// Status type is defined as 'typedef int TStatus'.
431  /// @return
432  /// - true, if the variant is selected.
433  /// - false, otherwise.
434  bool IsStatus(void) const;
435 
436  /// Get the variant data.
437  ///
438  /// @return
439  /// Copy of the variant data.
440  TStatus GetStatus(void) const;
441 
442  /// Select the variant.
443  ///
444  /// @return
445  /// Reference to the variant data.
446  TStatus& SetStatus(void);
447 
448  /// Select the variant and set its data.
449  ///
450  /// @param value
451  /// Variant data.
452  void SetStatus(TStatus value);
453 
454 
455  /// Check if variant Update_date is selected.
456  ///
457  /// Update_date type is defined as 'typedef CDate TUpdate_date'.
458  /// @return
459  /// - true, if the variant is selected.
460  /// - false, otherwise.
461  bool IsUpdate_date(void) const;
462 
463  /// Get the variant data.
464  ///
465  /// @return
466  /// Reference to the data.
467  const TUpdate_date& GetUpdate_date(void) const;
468 
469  /// Select the variant.
470  ///
471  /// @return
472  /// Reference to the variant data.
473  TUpdate_date& SetUpdate_date(void);
474  /// Select the variant and set its data.
475  ///
476  /// @param value
477  /// Reference to the data.
478  void SetUpdate_date(TUpdate_date& value);
479 
480 
481  /// Check if variant Scrapbook is selected.
482  ///
483  /// Scrapbook type is defined as 'typedef list< string > TScrapbook'.
484  /// @return
485  /// - true, if the variant is selected.
486  /// - false, otherwise.
487  bool IsScrapbook(void) const;
488 
489  /// Get the variant data.
490  ///
491  /// @return
492  /// Reference to the data.
493  const TScrapbook& GetScrapbook(void) const;
494 
495  /// Select the variant.
496  ///
497  /// @return
498  /// Reference to the variant data.
499  TScrapbook& SetScrapbook(void);
500 
501 
502  /// Check if variant Source_id is selected.
503  ///
504  /// Source_id type is defined as 'typedef CCdd_id_set TSource_id'.
505  /// @return
506  /// - true, if the variant is selected.
507  /// - false, otherwise.
508  bool IsSource_id(void) const;
509 
510  /// Get the variant data.
511  ///
512  /// @return
513  /// Reference to the data.
514  const TSource_id& GetSource_id(void) const;
515 
516  /// Select the variant.
517  ///
518  /// @return
519  /// Reference to the variant data.
520  TSource_id& SetSource_id(void);
521  /// Select the variant and set its data.
522  ///
523  /// @param value
524  /// Reference to the data.
525  void SetSource_id(TSource_id& value);
526 
527 
528  /// Check if variant Repeats is selected.
529  ///
530  /// Repeats type is defined as 'typedef CCdd_repeat TRepeats'.
531  /// @return
532  /// - true, if the variant is selected.
533  /// - false, otherwise.
534  bool IsRepeats(void) const;
535 
536  /// Get the variant data.
537  ///
538  /// @return
539  /// Reference to the data.
540  const TRepeats& GetRepeats(void) const;
541 
542  /// Select the variant.
543  ///
544  /// @return
545  /// Reference to the variant data.
546  TRepeats& SetRepeats(void);
547  /// Select the variant and set its data.
548  ///
549  /// @param value
550  /// Reference to the data.
551  void SetRepeats(TRepeats& value);
552 
553 
554  /// Check if variant Old_root is selected.
555  ///
556  /// Old_root type is defined as 'typedef CCdd_id_set TOld_root'.
557  /// @return
558  /// - true, if the variant is selected.
559  /// - false, otherwise.
560  bool IsOld_root(void) const;
561 
562  /// Get the variant data.
563  ///
564  /// @return
565  /// Reference to the data.
566  const TOld_root& GetOld_root(void) const;
567 
568  /// Select the variant.
569  ///
570  /// @return
571  /// Reference to the variant data.
572  TOld_root& SetOld_root(void);
573  /// Select the variant and set its data.
574  ///
575  /// @param value
576  /// Reference to the data.
577  void SetOld_root(TOld_root& value);
578 
579 
580  /// Check if variant Curation_status is selected.
581  ///
582  /// Curation_status type is defined as 'typedef int TCuration_status'.
583  /// @return
584  /// - true, if the variant is selected.
585  /// - false, otherwise.
586  bool IsCuration_status(void) const;
587 
588  /// Get the variant data.
589  ///
590  /// @return
591  /// Copy of the variant data.
592  TCuration_status GetCuration_status(void) const;
593 
594  /// Select the variant.
595  ///
596  /// @return
597  /// Reference to the variant data.
598  TCuration_status& SetCuration_status(void);
599 
600  /// Select the variant and set its data.
601  ///
602  /// @param value
603  /// Variant data.
604  void SetCuration_status(TCuration_status value);
605 
606 
607  /// Check if variant Readonly_status is selected.
608  ///
609  /// Readonly_status type is defined as 'typedef int TReadonly_status'.
610  /// @return
611  /// - true, if the variant is selected.
612  /// - false, otherwise.
613  bool IsReadonly_status(void) const;
614 
615  /// Get the variant data.
616  ///
617  /// @return
618  /// Copy of the variant data.
619  TReadonly_status GetReadonly_status(void) const;
620 
621  /// Select the variant.
622  ///
623  /// @return
624  /// Reference to the variant data.
625  TReadonly_status& SetReadonly_status(void);
626 
627  /// Select the variant and set its data.
628  ///
629  /// @param value
630  /// Variant data.
631  void SetReadonly_status(TReadonly_status value);
632 
633 
634  /// Check if variant Book_ref is selected.
635  ///
636  /// Book_ref type is defined as 'typedef CCdd_book_ref TBook_ref'.
637  /// @return
638  /// - true, if the variant is selected.
639  /// - false, otherwise.
640  bool IsBook_ref(void) const;
641 
642  /// Get the variant data.
643  ///
644  /// @return
645  /// Reference to the data.
646  const TBook_ref& GetBook_ref(void) const;
647 
648  /// Select the variant.
649  ///
650  /// @return
651  /// Reference to the variant data.
652  TBook_ref& SetBook_ref(void);
653  /// Select the variant and set its data.
654  ///
655  /// @param value
656  /// Reference to the data.
657  void SetBook_ref(TBook_ref& value);
658 
659 
660  /// Check if variant Attribution is selected.
661  ///
662  /// Attribution type is defined as 'typedef CPub TAttribution'.
663  /// @return
664  /// - true, if the variant is selected.
665  /// - false, otherwise.
666  bool IsAttribution(void) const;
667 
668  /// Get the variant data.
669  ///
670  /// @return
671  /// Reference to the data.
672  const TAttribution& GetAttribution(void) const;
673 
674  /// Select the variant.
675  ///
676  /// @return
677  /// Reference to the variant data.
678  TAttribution& SetAttribution(void);
679  /// Select the variant and set its data.
680  ///
681  /// @param value
682  /// Reference to the data.
683  void SetAttribution(TAttribution& value);
684 
685 
686  /// Check if variant Title is selected.
687  ///
688  /// Title type is defined as 'typedef string TTitle'.
689  /// @return
690  /// - true, if the variant is selected.
691  /// - false, otherwise.
692  bool IsTitle(void) const;
693 
694  /// Get the variant data.
695  ///
696  /// @return
697  /// Reference to the data.
698  const TTitle& GetTitle(void) const;
699 
700  /// Select the variant.
701  ///
702  /// @return
703  /// Reference to the variant data.
704  TTitle& SetTitle(void);
705 
706  /// Select the variant and set its data.
707  ///
708  /// @param value
709  /// Variant data.
710  void SetTitle(const TTitle& value);
711 
712 
713 private:
714  // copy constructor and assignment operator
717  // choice state
719  // helper methods
720  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
721 
722  static const char* const sm_SelectionNames[];
723  // data
724  union {
726  NCBI_NS_NCBI::CUnionBuffer<TScrapbook> m_Scrapbook;
729  NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
730  NCBI_NS_NCBI::CSerialObject *m_object;
731  };
732 };
733 
734 /* @} */
735 
736 
737 
738 
739 
740 ///////////////////////////////////////////////////////////
741 ///////////////////// inline methods //////////////////////
742 ///////////////////////////////////////////////////////////
743 inline
745 {
746  return m_choice;
747 }
748 
749 inline
751 {
752  if ( m_choice != index )
753  ThrowInvalidSelection(index);
754 }
755 
756 inline
757 void CCdd_descr_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
758 {
759  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
760  if ( m_choice != e_not_set )
761  ResetSelection();
762  DoSelect(index, pool);
763  }
764 }
765 
766 inline
767 void CCdd_descr_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
768 {
769  Select(index, reset, 0);
770 }
771 
772 inline
774 {
775  return m_choice == e_Othername;
776 }
777 
778 inline
780 {
782  return *m_string;
783 }
784 
785 inline
787 {
789  return *m_string;
790 }
791 
792 inline
794 {
795  return m_choice == e_Category;
796 }
797 
798 inline
800 {
802  return *m_string;
803 }
804 
805 inline
807 {
809  return *m_string;
810 }
811 
812 inline
814 {
815  return m_choice == e_Comment;
816 }
817 
818 inline
820 {
822  return *m_string;
823 }
824 
825 inline
827 {
829  return *m_string;
830 }
831 
832 inline
834 {
835  return m_choice == e_Reference;
836 }
837 
838 inline
840 {
841  return m_choice == e_Create_date;
842 }
843 
844 inline
846 {
847  return m_choice == e_Tax_source;
848 }
849 
850 inline
852 {
853  return m_choice == e_Source;
854 }
855 
856 inline
858 {
860  return *m_string;
861 }
862 
863 inline
865 {
867  return *m_string;
868 }
869 
870 inline
872 {
873  return m_choice == e_Status;
874 }
875 
876 inline
878 {
880  return m_Status;
881 }
882 
883 inline
885 {
887  return m_Status;
888 }
889 
890 inline
892 {
894  m_Status = value;
895 }
896 
897 inline
899 {
900  return m_choice == e_Update_date;
901 }
902 
903 inline
905 {
906  return m_choice == e_Scrapbook;
907 }
908 
909 inline
911 {
913  return *m_Scrapbook;
914 }
915 
916 inline
918 {
920  return *m_Scrapbook;
921 }
922 
923 inline
925 {
926  return m_choice == e_Source_id;
927 }
928 
929 inline
931 {
932  return m_choice == e_Repeats;
933 }
934 
935 inline
937 {
938  return m_choice == e_Old_root;
939 }
940 
941 inline
943 {
944  return m_choice == e_Curation_status;
945 }
946 
947 inline
949 {
951  return m_Curation_status;
952 }
953 
954 inline
956 {
958  return m_Curation_status;
959 }
960 
961 inline
963 {
966 }
967 
968 inline
970 {
971  return m_choice == e_Readonly_status;
972 }
973 
974 inline
976 {
978  return m_Readonly_status;
979 }
980 
981 inline
983 {
985  return m_Readonly_status;
986 }
987 
988 inline
990 {
993 }
994 
995 inline
997 {
998  return m_choice == e_Book_ref;
999 }
1000 
1001 inline
1003 {
1004  return m_choice == e_Attribution;
1005 }
1006 
1007 inline
1009 {
1010  return m_choice == e_Title;
1011 }
1012 
1013 inline
1015 {
1017  return *m_string;
1018 }
1019 
1020 inline
1022 {
1024  return *m_string;
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_CDD_CDD_DESCR_BASE_HPP
CCdd_book_ref –.
The description of CDD's refers to the specific set of aligned sequences, the region that is being al...
Definition: Cdd_descr_.hpp:90
CCdd_id_set –.
Definition: Cdd_id_set.hpp:66
CCdd_repeat –.
Definition: Cdd_repeat.hpp:66
Definition: Date.hpp:53
Definition: Pub.hpp:56
Base class for all serializable objects.
Definition: serialbase.hpp:150
EResetVariant
Definition: serialbase.hpp:76
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
@ eDoResetVariant
Definition: serialbase.hpp:77
@ eDoNotResetVariant
Definition: serialbase.hpp:78
NCBI_XOBJUTIL_EXPORT string GetTitle(const CBioseq_Handle &hnd, TGetTitleFlags flags=0)
Definition: seqtitle.cpp:106
#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_CDD_EXPORT
Definition: ncbi_export.h:368
NCBI_NS_NCBI::CSerialObject * m_object
Definition: Cdd_descr_.hpp:730
TReadonly_status m_Readonly_status
Definition: Cdd_descr_.hpp:728
E_Choice
Choice variants.
Definition: Cdd_descr_.hpp:145
TReadonly_status m_Readonly_status
Definition: Cdd_descr_.hpp:728
TReadonly_status & SetReadonly_status(void)
Select the variant.
Definition: Cdd_descr_.hpp:982
bool IsTitle(void) const
Check if variant Title is selected.
bool IsAttribution(void) const
Check if variant Attribution is selected.
TScrapbook & SetScrapbook(void)
Select the variant.
Definition: Cdd_descr_.hpp:917
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
Definition: Cdd_descr_.hpp:750
bool IsSource(void) const
Check if variant Source is selected.
Definition: Cdd_descr_.hpp:851
bool IsReference(void) const
Check if variant Reference is selected.
Definition: Cdd_descr_.hpp:833
TTitle & SetTitle(void)
Select the variant.
void ThrowInvalidSelection(E_Choice index) const
Throw 'InvalidSelection' exception.
Definition: Cdd_descr_.cpp:219
bool IsBook_ref(void) const
Check if variant Book_ref is selected.
Definition: Cdd_descr_.hpp:996
E_Choice Which(void) const
Which variant is currently selected.
Definition: Cdd_descr_.hpp:744
bool IsTax_source(void) const
Check if variant Tax_source is selected.
Definition: Cdd_descr_.hpp:845
const TTitle & GetTitle(void) const
Get the variant data.
NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > m_string
Definition: Cdd_descr_.hpp:729
bool IsUpdate_date(void) const
Check if variant Update_date is selected.
Definition: Cdd_descr_.hpp:898
const TSource & GetSource(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:857
bool IsOld_root(void) const
Check if variant Old_root is selected.
Definition: Cdd_descr_.hpp:936
TCuration_status m_Curation_status
Definition: Cdd_descr_.hpp:727
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
E_Choice m_choice
Definition: Cdd_descr_.hpp:718
bool IsSource_id(void) const
Check if variant Source_id is selected.
Definition: Cdd_descr_.hpp:924
CCdd_descr_Base(const CCdd_descr_Base &)
list< string > TScrapbook
Definition: Cdd_descr_.hpp:228
bool IsCreate_date(void) const
Check if variant Create_date is selected.
Definition: Cdd_descr_.hpp:839
const TOthername & GetOthername(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:779
bool IsComment(void) const
Check if variant Comment is selected.
Definition: Cdd_descr_.hpp:813
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
TStatus & SetStatus(void)
Select the variant.
Definition: Cdd_descr_.hpp:884
CCdd_book_ref TBook_ref
Definition: Cdd_descr_.hpp:234
CSerialObject Tparent
Definition: Cdd_descr_.hpp:91
bool IsScrapbook(void) const
Check if variant Scrapbook is selected.
Definition: Cdd_descr_.hpp:904
bool IsOthername(void) const
Check if variant Othername is selected.
Definition: Cdd_descr_.hpp:773
void DoSelect(E_Choice index, CObjectMemoryPool *pool=0)
Definition: Cdd_descr_.cpp:137
virtual void ResetSelection(void)
Reset the selection (set it to e_not_set).
Definition: Cdd_descr_.cpp:107
bool IsStatus(void) const
Check if variant Status is selected.
Definition: Cdd_descr_.hpp:871
NCBI_NS_NCBI::CUnionBuffer< TScrapbook > m_Scrapbook
Definition: Cdd_descr_.hpp:726
TReadonly_status GetReadonly_status(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:975
TStatus GetStatus(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:877
TCuration_status GetCuration_status(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:948
CCdd_id_set TSource_id
Definition: Cdd_descr_.hpp:229
CCdd_descr_Base & operator=(const CCdd_descr_Base &)
TComment & SetComment(void)
Select the variant.
Definition: Cdd_descr_.hpp:826
COrg_ref TTax_source
Definition: Cdd_descr_.hpp:224
NCBI_NS_NCBI::CUnionBuffer< TScrapbook > m_Scrapbook
Definition: Cdd_descr_.hpp:726
TOthername & SetOthername(void)
Select the variant.
Definition: Cdd_descr_.hpp:786
const TCategory & GetCategory(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:799
bool IsRepeats(void) const
Check if variant Repeats is selected.
Definition: Cdd_descr_.hpp:930
const TScrapbook & GetScrapbook(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:910
NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > m_string
Definition: Cdd_descr_.hpp:729
CCdd_id_set TOld_root
Definition: Cdd_descr_.hpp:231
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
Definition: Cdd_descr_.hpp:167
bool IsCuration_status(void) const
Check if variant Curation_status is selected.
Definition: Cdd_descr_.hpp:942
TCuration_status m_Curation_status
Definition: Cdd_descr_.hpp:727
bool IsCategory(void) const
Check if variant Category is selected.
Definition: Cdd_descr_.hpp:793
TCategory & SetCategory(void)
Select the variant.
Definition: Cdd_descr_.hpp:806
TSource & SetSource(void)
Select the variant.
Definition: Cdd_descr_.hpp:864
TCuration_status & SetCuration_status(void)
Select the variant.
Definition: Cdd_descr_.hpp:955
CCdd_repeat TRepeats
Definition: Cdd_descr_.hpp:230
const TComment & GetComment(void) const
Get the variant data.
Definition: Cdd_descr_.hpp:819
bool IsReadonly_status(void) const
Check if variant Readonly_status is selected.
Definition: Cdd_descr_.hpp:969
@ e_Repeats
to record repeat counts
Definition: Cdd_descr_.hpp:158
@ e_Title
hold short descriptive text
Definition: Cdd_descr_.hpp:164
@ e_Comment
this is where descriptions go
Definition: Cdd_descr_.hpp:149
@ e_Reference
a citation describing the domain
Definition: Cdd_descr_.hpp:150
@ e_Source_id
for linking back to source db
Definition: Cdd_descr_.hpp:157
@ e_Othername
alternative names for the CDD if domain has several common names
Definition: Cdd_descr_.hpp:147
@ e_not_set
No variant selected.
Definition: Cdd_descr_.hpp:146
@ e_Book_ref
links to Entrez/books
Definition: Cdd_descr_.hpp:162
@ e_Update_date
Date of last version change.
Definition: Cdd_descr_.hpp:155
@ e_Scrapbook
for storing curation notes those won't make it into public distributions
Definition: Cdd_descr_.hpp:156
@ e_Source
the database the seeds were created from, e.g. SMART, PFAM, etc..
Definition: Cdd_descr_.hpp:153
@ e_Category
intracellular, extracellular, etc. to record spatial and/or temporal expression in free-text format
Definition: Cdd_descr_.hpp:148
@ e_Attribution
add citations and/or author names
Definition: Cdd_descr_.hpp:163
@ e_Tax_source
holds the highest common tax node
Definition: Cdd_descr_.hpp:152
@ e_Old_root
to record short-term history
Definition: Cdd_descr_.hpp:159
@ e_Create_date
Date of first creation/dump.
Definition: Cdd_descr_.hpp:151
@ e_not_set
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
static void SetTitle(CRef< CSeq_entry > entry, string title)
Modified on Sat May 25 14:19:50 2024 by modify_doxy.py rev. 669887