NCBI C++ ToolKit
PC_AssayTargetInfo_.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 PC_AssayTargetInfo_.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/pcassay2/pcassay2.asn">pcassay2.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcassay2/pcassay2.def">pcassay2.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_PCASSAY2_PC_ASSAYTARGETINFO_BASE_HPP
42 #define OBJECTS_PCASSAY2_PC_ASSAYTARGETINFO_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 CBioSource;
62 
63 #ifndef BEGIN_pcassay2_SCOPE
64 # define BEGIN_pcassay2_SCOPE BEGIN_SCOPE(pcassay2)
65 # define END_pcassay2_SCOPE END_SCOPE(pcassay2)
66 #endif
67 BEGIN_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
68 
69 
70 // generated classes
71 
72 
73 /** @addtogroup dataspec_NCBI_PCAssay2
74  *
75  * @{
76  */
77 
78 /////////////////////////////////////////////////////////////////////////////
79 /// Molecular target information provides by organization describes the functionality of the target,
80 /// facilitates the linking between PubChem bioassays, and the linking between target molecule to other NCBI resources
81 ///
82 /// CPC_AssayTargetInfo_Base --
83 ///
84 
86 {
88 public:
89  // constructor
91  // destructor
93 
94  // type info
96 
97  /////////////////////////////////////////////////////////////////////////////
98  /// database and identifier of the target molecule
99  ///
100  /// C_Mol_id --
101  ///
102 
103  class C_Mol_id : public CSerialObject
104  {
106  public:
107  // constructor
108  C_Mol_id(void);
109  // destructor
110  ~C_Mol_id(void);
111 
112  // type info
114 
115 
116  /// Choice variants.
117  enum E_Choice {
118  e_not_set = 0, ///< No variant selected
119  e_Gene_id, ///< target is a NCBI Gene ID
120  e_Protein_accession, ///< target is a NCBI Protein Accession
121  e_Nucleotide_accession, ///< target is a NCBI Nucleotide Accession
122  e_Other, ///< target is beyond supported type (format = TYPE::RESOURCE::IDENTIFIER)
123  e_Tax_id ///< target is a NCBI Taxonomy ID
124  };
125  /// Maximum+1 value of the choice variant enumerator.
127  e_MaxChoice = 6 ///< == e_Tax_id+1
128  };
129 
130  /// Reset the whole object
131  void Reset(void);
132 
133  /// Reset the selection (set it to e_not_set).
134  void ResetSelection(void);
135 
136  /// Which variant is currently selected.
137  ///
138  /// @return
139  /// Choice state enumerator.
140  E_Choice Which(void) const;
141 
142  /// Verify selection, throw exception if it differs from the expected.
143  ///
144  /// @param index
145  /// Expected selection.
146  void CheckSelected(E_Choice index) const;
147 
148  /// Throw 'InvalidSelection' exception.
149  ///
150  /// @param index
151  /// Expected selection.
152  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
153 
154  /// Retrieve selection name (for diagnostic purposes).
155  ///
156  /// @param index
157  /// One of possible selection states.
158  /// @return
159  /// Name string.
160  static string SelectionName(E_Choice index);
161 
162  /// Select the requested variant if needed.
163  ///
164  /// @param index
165  /// New selection state.
166  /// @param reset
167  /// Flag that defines the resetting of the variant data. The data will
168  /// be reset if either the current selection differs from the new one,
169  /// or the flag is set to eDoResetVariant.
171  /// Select the requested variant if needed,
172  /// allocating CObject variants from memory pool.
173  void Select(E_Choice index,
174  EResetVariant reset,
175  CObjectMemoryPool* pool);
176 
177  // types
178  typedef int TGene_id;
179  typedef string TProtein_accession;
180  typedef string TNucleotide_accession;
181  typedef string TOther;
182  typedef int TTax_id;
183 
184  // getters
185  // setters
186 
187 
188  /// Check if variant Gene_id is selected.
189  ///
190  /// Gene_id type is defined as 'typedef int TGene_id'.
191  /// @return
192  /// - true, if the variant is selected.
193  /// - false, otherwise.
194  bool IsGene_id(void) const;
195 
196  /// Get the variant data.
197  ///
198  /// @return
199  /// Copy of the variant data.
200  TGene_id GetGene_id(void) const;
201 
202  /// Select the variant.
203  ///
204  /// @return
205  /// Reference to the variant data.
206  TGene_id& SetGene_id(void);
207 
208  /// Select the variant and set its data.
209  ///
210  /// @param value
211  /// Variant data.
212  void SetGene_id(TGene_id value);
213 
214 
215  /// Check if variant Protein_accession is selected.
216  ///
217  /// Protein_accession type is defined as 'typedef string TProtein_accession'.
218  /// @return
219  /// - true, if the variant is selected.
220  /// - false, otherwise.
221  bool IsProtein_accession(void) const;
222 
223  /// Get the variant data.
224  ///
225  /// @return
226  /// Reference to the data.
227  const TProtein_accession& GetProtein_accession(void) const;
228 
229  /// Select the variant.
230  ///
231  /// @return
232  /// Reference to the variant data.
234 
235  /// Select the variant and set its data.
236  ///
237  /// @param value
238  /// Variant data.
240 
241 
242  /// Check if variant Nucleotide_accession is selected.
243  ///
244  /// Nucleotide_accession type is defined as 'typedef string TNucleotide_accession'.
245  /// @return
246  /// - true, if the variant is selected.
247  /// - false, otherwise.
248  bool IsNucleotide_accession(void) const;
249 
250  /// Get the variant data.
251  ///
252  /// @return
253  /// Reference to the data.
255 
256  /// Select the variant.
257  ///
258  /// @return
259  /// Reference to the variant data.
261 
262  /// Select the variant and set its data.
263  ///
264  /// @param value
265  /// Variant data.
267 
268 
269  /// Check if variant Other is selected.
270  ///
271  /// Other type is defined as 'typedef string TOther'.
272  /// @return
273  /// - true, if the variant is selected.
274  /// - false, otherwise.
275  bool IsOther(void) const;
276 
277  /// Get the variant data.
278  ///
279  /// @return
280  /// Reference to the data.
281  const TOther& GetOther(void) const;
282 
283  /// Select the variant.
284  ///
285  /// @return
286  /// Reference to the variant data.
287  TOther& SetOther(void);
288 
289  /// Select the variant and set its data.
290  ///
291  /// @param value
292  /// Variant data.
293  void SetOther(const TOther& value);
294 
295 
296  /// Check if variant Tax_id is selected.
297  ///
298  /// Tax_id type is defined as 'typedef int TTax_id'.
299  /// @return
300  /// - true, if the variant is selected.
301  /// - false, otherwise.
302  bool IsTax_id(void) const;
303 
304  /// Get the variant data.
305  ///
306  /// @return
307  /// Copy of the variant data.
308  TTax_id GetTax_id(void) const;
309 
310  /// Select the variant.
311  ///
312  /// @return
313  /// Reference to the variant data.
314  TTax_id& SetTax_id(void);
315 
316  /// Select the variant and set its data.
317  ///
318  /// @param value
319  /// Variant data.
320  void SetTax_id(TTax_id value);
321 
322 
323  private:
324  // copy constructor and assignment operator
325  C_Mol_id(const C_Mol_id& );
327  // choice state
329  // helper methods
330  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
331 
332  static const char* const sm_SelectionNames[];
333  // data
334  union {
337  NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
339  };
340  };
341  // types
343  typedef C_Mol_id TMol_id;
344  typedef objects::CBioSource TOrganism;
346  typedef list< CStringUTF8 > TComment;
347 
348  // member index
349  enum class E_memberIndex {
350  e__allMandatory = 0,
351  e_name,
352  e_mol_id,
353  e_organism,
354  e_descr,
355  e_comment
356  };
358 
359  // getters
360  // setters
361 
362  /// Molecular name of target
363  /// Check if a value has been assigned to Name data member.
364  ///
365  /// Data member Name is mandatory;
366  /// its type is defined as 'typedef CStringUTF8 TName'
367  /// @return
368  /// - true, if a value has been assigned.
369  /// - false, otherwise.
370  bool IsSetName(void) const;
371 
372  /// Check if it is safe to call GetName method.
373  ///
374  /// @return
375  /// - true, if the data member is getatable.
376  /// - false, otherwise.
377  bool CanGetName(void) const;
378 
379  /// Reset Name data member.
380  void ResetName(void);
381 
382  /// Get the Name member data.
383  ///
384  /// @return
385  /// Reference to the member data.
386  const TName& GetName(void) const;
387 
388  /// Assign a value to Name data member.
389  ///
390  /// @param value
391  /// Value to assign
392  void SetName(const TName& value);
393  void SetName(TName&& value);
394 
395  /// Assign a value to Name data member.
396  ///
397  /// @return
398  /// Reference to the data value.
399  TName& SetName(void);
400 
401  /// Check if a value has been assigned to Mol_id data member.
402  ///
403  /// Data member Mol_id is mandatory;
404  /// its type is defined as 'typedef C_Mol_id TMol_id'
405  /// @return
406  /// - true, if a value has been assigned.
407  /// - false, otherwise.
408  bool IsSetMol_id(void) const;
409 
410  /// Check if it is safe to call GetMol_id method.
411  ///
412  /// @return
413  /// - true, if the data member is getatable.
414  /// - false, otherwise.
415  bool CanGetMol_id(void) const;
416 
417  /// Reset Mol_id data member.
418  void ResetMol_id(void);
419 
420  /// Get the Mol_id member data.
421  ///
422  /// @return
423  /// Reference to the member data.
424  const TMol_id& GetMol_id(void) const;
425 
426  /// Assign a value to Mol_id data member.
427  ///
428  /// @param value
429  /// Reference to value.
430  void SetMol_id(TMol_id& value);
431 
432  /// Assign a value to Mol_id data member.
433  ///
434  /// @return
435  /// Reference to the data value.
437 
438  /// Target Organism
439  /// Check if a value has been assigned to Organism data member.
440  ///
441  /// Data member Organism is optional;
442  /// its type is defined as 'typedef objects::CBioSource TOrganism'
443  /// @return
444  /// - true, if a value has been assigned.
445  /// - false, otherwise.
446  bool IsSetOrganism(void) const;
447 
448  /// Check if it is safe to call GetOrganism method.
449  ///
450  /// @return
451  /// - true, if the data member is getatable.
452  /// - false, otherwise.
453  bool CanGetOrganism(void) const;
454 
455  /// Reset Organism data member.
456  void ResetOrganism(void);
457 
458  /// Get the Organism member data.
459  ///
460  /// @return
461  /// Reference to the member data.
462  const TOrganism& GetOrganism(void) const;
463 
464  /// Assign a value to Organism data member.
465  ///
466  /// @param value
467  /// Reference to value.
469 
470  /// Assign a value to Organism data member.
471  ///
472  /// @return
473  /// Reference to the data value.
475 
476  /// Target Description (e.g., cellular functionality and location)
477  /// Check if a value has been assigned to Descr data member.
478  ///
479  /// Data member Descr is optional;
480  /// its type is defined as 'typedef CStringUTF8 TDescr'
481  /// @return
482  /// - true, if a value has been assigned.
483  /// - false, otherwise.
484  bool IsSetDescr(void) const;
485 
486  /// Check if it is safe to call GetDescr method.
487  ///
488  /// @return
489  /// - true, if the data member is getatable.
490  /// - false, otherwise.
491  bool CanGetDescr(void) const;
492 
493  /// Reset Descr data member.
494  void ResetDescr(void);
495 
496  /// Get the Descr member data.
497  ///
498  /// @return
499  /// Reference to the member data.
500  const TDescr& GetDescr(void) const;
501 
502  /// Assign a value to Descr data member.
503  ///
504  /// @param value
505  /// Value to assign
506  void SetDescr(const TDescr& value);
508 
509  /// Assign a value to Descr data member.
510  ///
511  /// @return
512  /// Reference to the data value.
513  TDescr& SetDescr(void);
514 
515  /// Comments or Additional Information
516  /// Check if a value has been assigned to Comment data member.
517  ///
518  /// Data member Comment is optional;
519  /// its type is defined as 'typedef list< CStringUTF8 > TComment'
520  /// @return
521  /// - true, if a value has been assigned.
522  /// - false, otherwise.
523  bool IsSetComment(void) const;
524 
525  /// Check if it is safe to call GetComment method.
526  ///
527  /// @return
528  /// - true, if the data member is getatable.
529  /// - false, otherwise.
530  bool CanGetComment(void) const;
531 
532  /// Reset Comment data member.
533  void ResetComment(void);
534 
535  /// Get the Comment member data.
536  ///
537  /// @return
538  /// Reference to the member data.
539  const TComment& GetComment(void) const;
540 
541  /// Assign a value to Comment data member.
542  ///
543  /// @return
544  /// Reference to the data value.
546 
547  /// Reset the whole object
548  virtual void Reset(void);
549 
550 
551 private:
552  // Prohibit copy constructor and assignment operator
555 
556  // data
557  Uint4 m_set_State[1];
562  list< CStringUTF8 > m_Comment;
563 };
564 
565 /* @} */
566 
567 
568 
569 
570 
571 ///////////////////////////////////////////////////////////
572 ///////////////////// inline methods //////////////////////
573 ///////////////////////////////////////////////////////////
574 inline
576 {
577  return m_choice;
578 }
579 
580 inline
582 {
583  if ( m_choice != index )
584  ThrowInvalidSelection(index);
585 }
586 
587 inline
588 void CPC_AssayTargetInfo_Base::C_Mol_id::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
589 {
590  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
591  if ( m_choice != e_not_set )
592  ResetSelection();
593  DoSelect(index, pool);
594  }
595 }
596 
597 inline
599 {
600  Select(index, reset, 0);
601 }
602 
603 inline
605 {
606  return m_choice == e_Gene_id;
607 }
608 
609 inline
611 {
612  CheckSelected(e_Gene_id);
613  return m_Gene_id;
614 }
615 
616 inline
618 {
619  Select(e_Gene_id, NCBI_NS_NCBI::eDoNotResetVariant);
620  return m_Gene_id;
621 }
622 
623 inline
625 {
626  Select(e_Gene_id, NCBI_NS_NCBI::eDoNotResetVariant);
627  m_Gene_id = value;
628 }
629 
630 inline
632 {
633  return m_choice == e_Protein_accession;
634 }
635 
636 inline
638 {
639  CheckSelected(e_Protein_accession);
640  return *m_string;
641 }
642 
643 inline
645 {
646  Select(e_Protein_accession, NCBI_NS_NCBI::eDoNotResetVariant);
647  return *m_string;
648 }
649 
650 inline
652 {
653  return m_choice == e_Nucleotide_accession;
654 }
655 
656 inline
658 {
659  CheckSelected(e_Nucleotide_accession);
660  return *m_string;
661 }
662 
663 inline
665 {
666  Select(e_Nucleotide_accession, NCBI_NS_NCBI::eDoNotResetVariant);
667  return *m_string;
668 }
669 
670 inline
672 {
673  return m_choice == e_Other;
674 }
675 
676 inline
678 {
679  CheckSelected(e_Other);
680  return *m_string;
681 }
682 
683 inline
685 {
686  Select(e_Other, NCBI_NS_NCBI::eDoNotResetVariant);
687  return *m_string;
688 }
689 
690 inline
692 {
693  return m_choice == e_Tax_id;
694 }
695 
696 inline
698 {
699  CheckSelected(e_Tax_id);
700  return m_Tax_id;
701 }
702 
703 inline
705 {
706  Select(e_Tax_id, NCBI_NS_NCBI::eDoNotResetVariant);
707  return m_Tax_id;
708 }
709 
710 inline
712 {
713  Select(e_Tax_id, NCBI_NS_NCBI::eDoNotResetVariant);
714  m_Tax_id = value;
715 }
716 
717 inline
719 {
720  return ((m_set_State[0] & 0x3) != 0);
721 }
722 
723 inline
725 {
726  return IsSetName();
727 }
728 
729 inline
731 {
732  if (!CanGetName()) {
733  ThrowUnassigned(0);
734  }
735  return m_Name;
736 }
737 
738 inline
740 {
741  m_Name = value;
742  m_set_State[0] |= 0x3;
743 }
744 
745 inline
747 {
748  m_Name = std::forward<CPC_AssayTargetInfo_Base::TName>(value);
749  m_set_State[0] |= 0x3;
750 }
751 
752 inline
754 {
755 #ifdef _DEBUG
756  if (!IsSetName()) {
758  }
759 #endif
760  m_set_State[0] |= 0x1;
761  return m_Name;
762 }
763 
764 inline
766 {
767  return m_Mol_id.NotEmpty();
768 }
769 
770 inline
772 {
773  return true;
774 }
775 
776 inline
778 {
779  if ( !m_Mol_id ) {
780  const_cast<CPC_AssayTargetInfo_Base*>(this)->ResetMol_id();
781  }
782  return (*m_Mol_id);
783 }
784 
785 inline
787 {
788  if ( !m_Mol_id ) {
789  ResetMol_id();
790  }
791  return (*m_Mol_id);
792 }
793 
794 inline
796 {
797  return m_Organism.NotEmpty();
798 }
799 
800 inline
802 {
803  return IsSetOrganism();
804 }
805 
806 inline
808 {
809  if (!CanGetOrganism()) {
810  ThrowUnassigned(2);
811  }
812  return (*m_Organism);
813 }
814 
815 inline
817 {
818  return ((m_set_State[0] & 0xc0) != 0);
819 }
820 
821 inline
823 {
824  return IsSetDescr();
825 }
826 
827 inline
829 {
830  if (!CanGetDescr()) {
831  ThrowUnassigned(3);
832  }
833  return m_Descr;
834 }
835 
836 inline
838 {
839  m_Descr = value;
840  m_set_State[0] |= 0xc0;
841 }
842 
843 inline
845 {
846  m_Descr = std::forward<CPC_AssayTargetInfo_Base::TDescr>(value);
847  m_set_State[0] |= 0xc0;
848 }
849 
850 inline
852 {
853 #ifdef _DEBUG
854  if (!IsSetDescr()) {
856  }
857 #endif
858  m_set_State[0] |= 0x40;
859  return m_Descr;
860 }
861 
862 inline
864 {
865  return ((m_set_State[0] & 0x300) != 0);
866 }
867 
868 inline
870 {
871  return true;
872 }
873 
874 inline
876 {
877  return m_Comment;
878 }
879 
880 inline
882 {
883  m_set_State[0] |= 0x100;
884  return m_Comment;
885 }
886 
887 ///////////////////////////////////////////////////////////
888 ////////////////// end of inline methods //////////////////
889 ///////////////////////////////////////////////////////////
890 
891 
892 
893 
894 
895 END_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
896 
897 END_objects_SCOPE // namespace ncbi::objects::
898 
900 
901 
902 #endif // OBJECTS_PCASSAY2_PC_ASSAYTARGETINFO_BASE_HPP
database and identifier of the target molecule
Molecular target information provides by organization describes the functionality of the target,...
Base class for all serializable objects.
Definition: serialbase.hpp:150
static CStringUTF8 UnassignedStringUTF8(void)
Definition: serialbase.hpp:178
void ThrowUnassigned(TMemberIndex index) const
EResetVariant
Definition: serialbase.hpp:76
@ eDoResetVariant
Definition: serialbase.hpp:77
@ eDoNotResetVariant
Definition: serialbase.hpp:78
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
std::string CStringUTF8
Definition: ncbistl.hpp:254
bool IsGene_id(void) const
Check if variant Gene_id is selected.
void SetName(const TName &value)
Assign a value to Name data member.
TGene_id GetGene_id(void) const
Get the variant data.
NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > m_string
virtual ~CPC_AssayTargetInfo_Base(void)
TGene_id & SetGene_id(void)
Select the variant.
bool IsSetMol_id(void) const
Check if a value has been assigned to Mol_id data member.
bool CanGetName(void) const
Check if it is safe to call GetName method.
void ResetSelection(void)
Reset the selection (set it to e_not_set).
TTax_id GetTax_id(void) const
Get the variant data.
bool CanGetDescr(void) const
Check if it is safe to call GetDescr method.
bool IsOther(void) const
Check if variant Other is selected.
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
C_Mol_id & operator=(const C_Mol_id &)
CPC_AssayTargetInfo_Base(const CPC_AssayTargetInfo_Base &)
const TMol_id & GetMol_id(void) const
Get the Mol_id member data.
void SetDescr(const TDescr &value)
Assign a value to Descr data member.
CPC_AssayTargetInfo_Base & operator=(const CPC_AssayTargetInfo_Base &)
TComment & SetComment(void)
Assign a value to Comment data member.
bool IsSetDescr(void) const
Target Description (e.g., cellular functionality and location) Check if a value has been assigned to ...
const TNucleotide_accession & GetNucleotide_accession(void) const
Get the variant data.
static const char *const sm_SelectionNames[]
bool IsSetName(void) const
Molecular name of target Check if a value has been assigned to Name data member.
TProtein_accession & SetProtein_accession(void)
Select the variant.
const TComment & GetComment(void) const
Get the Comment member data.
const TProtein_accession & GetProtein_accession(void) const
Get the variant data.
void ResetComment(void)
Reset Comment data member.
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
virtual void Reset(void)
Reset the whole object.
TDescr & SetDescr(void)
Assign a value to Descr data member.
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
void ResetName(void)
Reset Name data member.
void SetDescr(TDescr &&value)
TOrganism & SetOrganism(void)
Assign a value to Organism data member.
const TOther & GetOther(void) const
Get the variant data.
bool IsNucleotide_accession(void) const
Check if variant Nucleotide_accession is selected.
bool CanGetMol_id(void) const
Check if it is safe to call GetMol_id method.
TTax_id & SetTax_id(void)
Select the variant.
static string SelectionName(E_Choice index)
Retrieve selection name (for diagnostic purposes).
void ResetOrganism(void)
Reset Organism data member.
void SetOrganism(TOrganism &value)
Assign a value to Organism data member.
void DoSelect(E_Choice index, CObjectMemoryPool *pool=0)
const TOrganism & GetOrganism(void) const
Get the Organism member data.
bool CanGetOrganism(void) const
Check if it is safe to call GetOrganism method.
bool IsSetOrganism(void) const
Target Organism Check if a value has been assigned to Organism data member.
bool IsSetComment(void) const
Comments or Additional Information Check if a value has been assigned to Comment data member.
bool IsProtein_accession(void) const
Check if variant Protein_accession is selected.
void ResetDescr(void)
Reset Descr data member.
TOther & SetOther(void)
Select the variant.
void SetName(TName &&value)
bool IsTax_id(void) const
Check if variant Tax_id is selected.
const TDescr & GetDescr(void) const
Get the Descr member data.
Tparent::CMemberIndex< E_memberIndex, 6 > TmemberIndex
bool CanGetComment(void) const
Check if it is safe to call GetComment method.
TName & SetName(void)
Assign a value to Name data member.
void ResetMol_id(void)
Reset Mol_id data member.
void ThrowInvalidSelection(E_Choice index) const
Throw 'InvalidSelection' exception.
TNucleotide_accession & SetNucleotide_accession(void)
Select the variant.
E_Choice Which(void) const
Which variant is currently selected.
void Reset(void)
Reset the whole object.
const TName & GetName(void) const
Get the Name member data.
TMol_id & SetMol_id(void)
Assign a value to Mol_id data member.
@ e_Nucleotide_accession
target is a NCBI Nucleotide Accession
@ e_Tax_id
target is a NCBI Taxonomy ID
@ e_Protein_accession
target is a NCBI Protein Accession
@ e_Other
target is beyond supported type (format = TYPE::RESOURCE::IDENTIFIER)
bool IsSetMol_id(void) const
NCBI database identifier of the target molecule Check if a value has been assigned to Mol_id data mem...
bool CanGetName(void) const
Check if it is safe to call GetName method.
bool CanGetDescr(void) const
Check if it is safe to call GetDescr method.
const TDescr & GetDescr(void) const
Get the Descr member data.
TMol_id GetMol_id(void) const
Get the Mol_id member data.
TComment & SetComment(void)
Assign a value to Comment data member.
bool IsSetDescr(void) const
Target Description (e.g., cellular functionality and location) Check if a value has been assigned to ...
bool IsSetName(void) const
Molecular name of target Check if a value has been assigned to Name data member.
bool CanGetMol_id(void) const
Check if it is safe to call GetMol_id method.
const TComment & GetComment(void) const
Get the Comment member data.
TDescr & SetDescr(void)
Assign a value to Descr data member.
const TOrganism & GetOrganism(void) const
Get the Organism member data.
bool CanGetOrganism(void) const
Check if it is safe to call GetOrganism method.
bool IsSetOrganism(void) const
Target Organism Check if a value has been assigned to Organism data member.
bool IsSetComment(void) const
Comments or Additional Information Check if a value has been assigned to Comment data member.
TName & SetName(void)
Assign a value to Name data member.
const TName & GetName(void) const
Get the Name member data.
bool CanGetComment(void) const
Check if it is safe to call GetComment method.
void ResetMol_id(void)
Reset Mol_id data member.
TMol_id & SetMol_id(void)
Assign a value to Mol_id data member.
@ e_not_set
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
#define END_pcassay2_SCOPE
#define BEGIN_pcassay2_SCOPE
Modified on Mon Jun 17 05:09:28 2024 by modify_doxy.py rev. 669887