NCBI C++ ToolKit
Ss_.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 Ss_.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/docsum/docsum.asn">docsum.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/docsum/docsum.def">docsum.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_DOCSUM_SS_BASE_HPP
42 #define OBJECTS_DOCSUM_SS_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 // generated classes
60 
61 
62 /** @addtogroup dataspec_Docsum_3_4
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///data for an individual submission to dbSNP
69 ///
70 /// CSs_Base --
71 ///
72 
74 {
76 public:
77  // constructor
78  CSs_Base(void);
79  // destructor
80  virtual ~CSs_Base(void);
81 
82  // type info
84 
85  /////////////////////////////////////////////////////////////////////////////
86  ///
87  /// C_Attlist --
88  ///
89 
91  {
93  public:
94  // constructor
95  C_Attlist(void);
96  // destructor
97  ~C_Attlist(void);
98 
99  // type info
101 
102  ///SubSNP classification by type of
103  /// variation
105  eAttlist_subSnpClass_snp = 1,
106  eAttlist_subSnpClass_in_del = 2,
107  eAttlist_subSnpClass_heterozygous = 3,
108  eAttlist_subSnpClass_microsatellite = 4,
109  eAttlist_subSnpClass_named_locus = 5,
110  eAttlist_subSnpClass_no_variation = 6,
111  eAttlist_subSnpClass_mixed = 7,
112  eAttlist_subSnpClass_multinucleotide_polymorphism = 8
113  };
114 
115  /// Access to EAttlist_subSnpClass's attributes (values, names) as defined in spec
116  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_subSnpClass)(void);
117 
118  ///orientation of refsnp cluster members to refsnp cluster
119  /// sequence
121  eAttlist_orient_forward = 1,
122  eAttlist_orient_reverse = 2
123  };
124 
125  /// Access to EAttlist_orient's attributes (values, names) as defined in spec
126  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_orient)(void);
127 
128  ///strand is defined as TOP/BOTTOM by nature of flanking
129  /// nucleotide sequence
131  eAttlist_strand_top = 1,
132  eAttlist_strand_bottom = 2
133  };
134 
135  /// Access to EAttlist_strand's attributes (values, names) as defined in spec
136  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_strand)(void);
137 
139  eAttlist_molType_genomic = 1,
140  eAttlist_molType_cDNA = 2,
141  eAttlist_molType_mito = 3,
142  eAttlist_molType_chloro = 4,
143  eAttlist_molType_unknown = 5
144  };
145 
146  /// Access to EAttlist_molType's attributes (values, names) as defined in spec
147  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_molType)(void);
148 
149  ///class of method used to assay for the
150  /// variation
152  eAttlist_methodClass_dHPLC = 1,
153  eAttlist_methodClass_hybridize = 2,
154  eAttlist_methodClass_computed = 3,
155  eAttlist_methodClass_sSCP = 4,
156  eAttlist_methodClass_other = 5,
157  eAttlist_methodClass_unknown = 6,
158  eAttlist_methodClass_rFLP = 7,
159  eAttlist_methodClass_sequence = 8
160  };
161 
162  /// Access to EAttlist_methodClass's attributes (values, names) as defined in spec
163  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_methodClass)(void);
164 
165  ///subsnp has been experimentally validated by
166  /// submitter
168  eAttlist_validated_by_submitter = 1,
169  eAttlist_validated_by_frequency = 2,
170  eAttlist_validated_by_cluster = 3
171  };
172 
173  /// Access to EAttlist_validated's attributes (values, names) as defined in spec
174  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_validated)(void);
175 
176  // types
177  typedef Int8 TSsId;
178  typedef string THandle;
179  typedef int TBatchId;
180  typedef string TLocSnpId;
185  typedef int TBuildId;
188  typedef string TLinkoutUrl;
189  typedef string TSsAlias;
190  typedef int TAlleleOrigin;
191  typedef string TClinicalSignificance;
192 
193  // member index
194  enum class E_memberIndex {
195  e__allMandatory = 0,
196  e_ssId,
197  e_handle,
198  e_batchId,
199  e_locSnpId,
200  e_subSnpClass,
201  e_orient,
202  e_strand,
203  e_molType,
204  e_buildId,
205  e_methodClass,
206  e_validated,
207  e_linkoutUrl,
208  e_ssAlias,
209  e_alleleOrigin,
210  e_clinicalSignificance
211  };
213 
214  // getters
215  // setters
216 
217  ///dbSNP accession number for submission
218  /// Check if a value has been assigned to SsId data member.
219  ///
220  /// Data member SsId is mandatory;
221  /// its type is defined as 'typedef Int8 TSsId'
222  /// @return
223  /// - true, if a value has been assigned.
224  /// - false, otherwise.
225  bool IsSetSsId(void) const;
226 
227  /// Check if it is safe to call GetSsId method.
228  ///
229  /// @return
230  /// - true, if the data member is getatable.
231  /// - false, otherwise.
232  bool CanGetSsId(void) const;
233 
234  /// Reset SsId data member.
235  void ResetSsId(void);
236 
237  /// Get the SsId member data.
238  ///
239  /// @return
240  /// Copy of the member data.
241  TSsId GetSsId(void) const;
242 
243  /// Assign a value to SsId data member.
244  ///
245  /// @param value
246  /// Value to assign
247  void SetSsId(TSsId value);
248 
249  /// Assign a value to SsId data member.
250  ///
251  /// @return
252  /// Reference to the data value.
253  TSsId& SetSsId(void);
254 
255  ///Tag for the submitting laboratory
256  /// Check if a value has been assigned to Handle data member.
257  ///
258  /// Data member Handle is mandatory;
259  /// its type is defined as 'typedef string THandle'
260  /// @return
261  /// - true, if a value has been assigned.
262  /// - false, otherwise.
263  bool IsSetHandle(void) const;
264 
265  /// Check if it is safe to call GetHandle method.
266  ///
267  /// @return
268  /// - true, if the data member is getatable.
269  /// - false, otherwise.
270  bool CanGetHandle(void) const;
271 
272  /// Reset Handle data member.
273  void ResetHandle(void);
274 
275  /// Get the Handle member data.
276  ///
277  /// @return
278  /// Reference to the member data.
279  const THandle& GetHandle(void) const;
280 
281  /// Assign a value to Handle data member.
282  ///
283  /// @param value
284  /// Value to assign
285  void SetHandle(const THandle& value);
287 
288  /// Assign a value to Handle data member.
289  ///
290  /// @return
291  /// Reference to the data value.
292  THandle& SetHandle(void);
293 
294  ///dbSNP number for batch submission
295  /// Check if a value has been assigned to BatchId data member.
296  ///
297  /// Data member BatchId is mandatory;
298  /// its type is defined as 'typedef int TBatchId'
299  /// @return
300  /// - true, if a value has been assigned.
301  /// - false, otherwise.
302  bool IsSetBatchId(void) const;
303 
304  /// Check if it is safe to call GetBatchId method.
305  ///
306  /// @return
307  /// - true, if the data member is getatable.
308  /// - false, otherwise.
309  bool CanGetBatchId(void) const;
310 
311  /// Reset BatchId data member.
312  void ResetBatchId(void);
313 
314  /// Get the BatchId member data.
315  ///
316  /// @return
317  /// Copy of the member data.
318  TBatchId GetBatchId(void) const;
319 
320  /// Assign a value to BatchId data member.
321  ///
322  /// @param value
323  /// Value to assign
324  void SetBatchId(TBatchId value);
325 
326  /// Assign a value to BatchId data member.
327  ///
328  /// @return
329  /// Reference to the data value.
330  TBatchId& SetBatchId(void);
331 
332  ///submission (ss#) submitter ID
333  /// Check if a value has been assigned to LocSnpId data member.
334  ///
335  /// Data member LocSnpId is optional;
336  /// its type is defined as 'typedef string TLocSnpId'
337  /// @return
338  /// - true, if a value has been assigned.
339  /// - false, otherwise.
340  bool IsSetLocSnpId(void) const;
341 
342  /// Check if it is safe to call GetLocSnpId method.
343  ///
344  /// @return
345  /// - true, if the data member is getatable.
346  /// - false, otherwise.
347  bool CanGetLocSnpId(void) const;
348 
349  /// Reset LocSnpId data member.
350  void ResetLocSnpId(void);
351 
352  /// Get the LocSnpId member data.
353  ///
354  /// @return
355  /// Reference to the member data.
356  const TLocSnpId& GetLocSnpId(void) const;
357 
358  /// Assign a value to LocSnpId data member.
359  ///
360  /// @param value
361  /// Value to assign
362  void SetLocSnpId(const TLocSnpId& value);
363  void SetLocSnpId(TLocSnpId&& value);
364 
365  /// Assign a value to LocSnpId data member.
366  ///
367  /// @return
368  /// Reference to the data value.
369  TLocSnpId& SetLocSnpId(void);
370 
371  /// Check if a value has been assigned to SubSnpClass data member.
372  ///
373  /// Data member SubSnpClass is optional;
374  /// its type is defined as 'typedef EAttlist_subSnpClass TSubSnpClass'
375  /// @return
376  /// - true, if a value has been assigned.
377  /// - false, otherwise.
378  bool IsSetSubSnpClass(void) const;
379 
380  /// Check if it is safe to call GetSubSnpClass method.
381  ///
382  /// @return
383  /// - true, if the data member is getatable.
384  /// - false, otherwise.
385  bool CanGetSubSnpClass(void) const;
386 
387  /// Reset SubSnpClass data member.
388  void ResetSubSnpClass(void);
389 
390  /// Get the SubSnpClass member data.
391  ///
392  /// @return
393  /// Copy of the member data.
394  TSubSnpClass GetSubSnpClass(void) const;
395 
396  /// Assign a value to SubSnpClass data member.
397  ///
398  /// @param value
399  /// Value to assign
400  void SetSubSnpClass(TSubSnpClass value);
401 
402  /// Assign a value to SubSnpClass data member.
403  ///
404  /// @return
405  /// Reference to the data value.
406  TSubSnpClass& SetSubSnpClass(void);
407 
408  /// Check if a value has been assigned to Orient data member.
409  ///
410  /// Data member Orient is optional;
411  /// its type is defined as 'typedef EAttlist_orient TOrient'
412  /// @return
413  /// - true, if a value has been assigned.
414  /// - false, otherwise.
415  bool IsSetOrient(void) const;
416 
417  /// Check if it is safe to call GetOrient method.
418  ///
419  /// @return
420  /// - true, if the data member is getatable.
421  /// - false, otherwise.
422  bool CanGetOrient(void) const;
423 
424  /// Reset Orient data member.
425  void ResetOrient(void);
426 
427  /// Get the Orient member data.
428  ///
429  /// @return
430  /// Copy of the member data.
431  TOrient GetOrient(void) const;
432 
433  /// Assign a value to Orient data member.
434  ///
435  /// @param value
436  /// Value to assign
437  void SetOrient(TOrient value);
438 
439  /// Assign a value to Orient data member.
440  ///
441  /// @return
442  /// Reference to the data value.
443  TOrient& SetOrient(void);
444 
445  /// Check if a value has been assigned to Strand data member.
446  ///
447  /// Data member Strand is optional;
448  /// its type is defined as 'typedef EAttlist_strand TStrand'
449  /// @return
450  /// - true, if a value has been assigned.
451  /// - false, otherwise.
452  bool IsSetStrand(void) const;
453 
454  /// Check if it is safe to call GetStrand method.
455  ///
456  /// @return
457  /// - true, if the data member is getatable.
458  /// - false, otherwise.
459  bool CanGetStrand(void) const;
460 
461  /// Reset Strand data member.
462  void ResetStrand(void);
463 
464  /// Get the Strand member data.
465  ///
466  /// @return
467  /// Copy of the member data.
468  TStrand GetStrand(void) const;
469 
470  /// Assign a value to Strand data member.
471  ///
472  /// @param value
473  /// Value to assign
474  void SetStrand(TStrand value);
475 
476  /// Assign a value to Strand data member.
477  ///
478  /// @return
479  /// Reference to the data value.
480  TStrand& SetStrand(void);
481 
482  ///moltype from Batch table
483  /// Check if a value has been assigned to MolType data member.
484  ///
485  /// Data member MolType is optional;
486  /// its type is defined as 'typedef EAttlist_molType TMolType'
487  /// @return
488  /// - true, if a value has been assigned.
489  /// - false, otherwise.
490  bool IsSetMolType(void) const;
491 
492  /// Check if it is safe to call GetMolType method.
493  ///
494  /// @return
495  /// - true, if the data member is getatable.
496  /// - false, otherwise.
497  bool CanGetMolType(void) const;
498 
499  /// Reset MolType data member.
500  void ResetMolType(void);
501 
502  /// Get the MolType member data.
503  ///
504  /// @return
505  /// Copy of the member data.
506  TMolType GetMolType(void) const;
507 
508  /// Assign a value to MolType data member.
509  ///
510  /// @param value
511  /// Value to assign
512  void SetMolType(TMolType value);
513 
514  /// Assign a value to MolType data member.
515  ///
516  /// @return
517  /// Reference to the data value.
518  TMolType& SetMolType(void);
519 
520  ///dbSNP build number when ss# was added to a refSNP (rs#)
521  /// cluster
522  /// Check if a value has been assigned to BuildId data member.
523  ///
524  /// Data member BuildId is optional;
525  /// its type is defined as 'typedef int TBuildId'
526  /// @return
527  /// - true, if a value has been assigned.
528  /// - false, otherwise.
529  bool IsSetBuildId(void) const;
530 
531  /// Check if it is safe to call GetBuildId method.
532  ///
533  /// @return
534  /// - true, if the data member is getatable.
535  /// - false, otherwise.
536  bool CanGetBuildId(void) const;
537 
538  /// Reset BuildId data member.
539  void ResetBuildId(void);
540 
541  /// Get the BuildId member data.
542  ///
543  /// @return
544  /// Copy of the member data.
545  TBuildId GetBuildId(void) const;
546 
547  /// Assign a value to BuildId data member.
548  ///
549  /// @param value
550  /// Value to assign
551  void SetBuildId(TBuildId value);
552 
553  /// Assign a value to BuildId data member.
554  ///
555  /// @return
556  /// Reference to the data value.
557  TBuildId& SetBuildId(void);
558 
559  /// Check if a value has been assigned to MethodClass data member.
560  ///
561  /// Data member MethodClass is optional;
562  /// its type is defined as 'typedef EAttlist_methodClass TMethodClass'
563  /// @return
564  /// - true, if a value has been assigned.
565  /// - false, otherwise.
566  bool IsSetMethodClass(void) const;
567 
568  /// Check if it is safe to call GetMethodClass method.
569  ///
570  /// @return
571  /// - true, if the data member is getatable.
572  /// - false, otherwise.
573  bool CanGetMethodClass(void) const;
574 
575  /// Reset MethodClass data member.
576  void ResetMethodClass(void);
577 
578  /// Get the MethodClass member data.
579  ///
580  /// @return
581  /// Copy of the member data.
582  TMethodClass GetMethodClass(void) const;
583 
584  /// Assign a value to MethodClass data member.
585  ///
586  /// @param value
587  /// Value to assign
588  void SetMethodClass(TMethodClass value);
589 
590  /// Assign a value to MethodClass data member.
591  ///
592  /// @return
593  /// Reference to the data value.
594  TMethodClass& SetMethodClass(void);
595 
596  /// Check if a value has been assigned to Validated data member.
597  ///
598  /// Data member Validated is optional;
599  /// its type is defined as 'typedef EAttlist_validated TValidated'
600  /// @return
601  /// - true, if a value has been assigned.
602  /// - false, otherwise.
603  bool IsSetValidated(void) const;
604 
605  /// Check if it is safe to call GetValidated method.
606  ///
607  /// @return
608  /// - true, if the data member is getatable.
609  /// - false, otherwise.
610  bool CanGetValidated(void) const;
611 
612  /// Reset Validated data member.
613  void ResetValidated(void);
614 
615  /// Get the Validated member data.
616  ///
617  /// @return
618  /// Copy of the member data.
619  TValidated GetValidated(void) const;
620 
621  /// Assign a value to Validated data member.
622  ///
623  /// @param value
624  /// Value to assign
625  void SetValidated(TValidated value);
626 
627  /// Assign a value to Validated data member.
628  ///
629  /// @return
630  /// Reference to the data value.
631  TValidated& SetValidated(void);
632 
633  ///append loc-snp-id to this base URL to construct a pointer to
634  /// submitter data.
635  /// Check if a value has been assigned to LinkoutUrl data member.
636  ///
637  /// Data member LinkoutUrl is optional;
638  /// its type is defined as 'typedef string TLinkoutUrl'
639  /// @return
640  /// - true, if a value has been assigned.
641  /// - false, otherwise.
642  bool IsSetLinkoutUrl(void) const;
643 
644  /// Check if it is safe to call GetLinkoutUrl method.
645  ///
646  /// @return
647  /// - true, if the data member is getatable.
648  /// - false, otherwise.
649  bool CanGetLinkoutUrl(void) const;
650 
651  /// Reset LinkoutUrl data member.
652  void ResetLinkoutUrl(void);
653 
654  /// Get the LinkoutUrl member data.
655  ///
656  /// @return
657  /// Reference to the member data.
658  const TLinkoutUrl& GetLinkoutUrl(void) const;
659 
660  /// Assign a value to LinkoutUrl data member.
661  ///
662  /// @param value
663  /// Value to assign
664  void SetLinkoutUrl(const TLinkoutUrl& value);
665  void SetLinkoutUrl(TLinkoutUrl&& value);
666 
667  /// Assign a value to LinkoutUrl data member.
668  ///
669  /// @return
670  /// Reference to the data value.
671  TLinkoutUrl& SetLinkoutUrl(void);
672 
673  /// Check if a value has been assigned to SsAlias data member.
674  ///
675  /// Data member SsAlias is optional;
676  /// its type is defined as 'typedef string TSsAlias'
677  /// @return
678  /// - true, if a value has been assigned.
679  /// - false, otherwise.
680  bool IsSetSsAlias(void) const;
681 
682  /// Check if it is safe to call GetSsAlias method.
683  ///
684  /// @return
685  /// - true, if the data member is getatable.
686  /// - false, otherwise.
687  bool CanGetSsAlias(void) const;
688 
689  /// Reset SsAlias data member.
690  void ResetSsAlias(void);
691 
692  /// Get the SsAlias member data.
693  ///
694  /// @return
695  /// Reference to the member data.
696  const TSsAlias& GetSsAlias(void) const;
697 
698  /// Assign a value to SsAlias data member.
699  ///
700  /// @param value
701  /// Value to assign
702  void SetSsAlias(const TSsAlias& value);
703  void SetSsAlias(TSsAlias&& value);
704 
705  /// Assign a value to SsAlias data member.
706  ///
707  /// @return
708  /// Reference to the data value.
709  TSsAlias& SetSsAlias(void);
710 
711  /// <xsd:simpleType>
712  /// <xsd:restriction base="xsd:string">
713  /// <xsd:enumeration value="unknown"/>
714  /// <xsd:enumeration value="germline"/>
715  /// <xsd:enumeration value="somatic"/>
716  /// <xsd:enumeration value="inherited"/>
717  /// <xsd:enumeration value="paternal"/>
718  /// <xsd:enumeration value="maternal"/>
719  /// <xsd:enumeration value="de-novo"/>
720  /// <xsd:enumeration value="other"/>
721  /// </xsd:restriction>
722  /// </xsd:simpleType>
723  /// Check if a value has been assigned to AlleleOrigin data member.
724  ///
725  /// Data member AlleleOrigin is optional;
726  /// its type is defined as 'typedef int TAlleleOrigin'
727  /// @return
728  /// - true, if a value has been assigned.
729  /// - false, otherwise.
730  bool IsSetAlleleOrigin(void) const;
731 
732  /// Check if it is safe to call GetAlleleOrigin method.
733  ///
734  /// @return
735  /// - true, if the data member is getatable.
736  /// - false, otherwise.
737  bool CanGetAlleleOrigin(void) const;
738 
739  /// Reset AlleleOrigin data member.
740  void ResetAlleleOrigin(void);
741 
742  /// Get the AlleleOrigin member data.
743  ///
744  /// @return
745  /// Copy of the member data.
746  TAlleleOrigin GetAlleleOrigin(void) const;
747 
748  /// Assign a value to AlleleOrigin data member.
749  ///
750  /// @param value
751  /// Value to assign
752  void SetAlleleOrigin(TAlleleOrigin value);
753 
754  /// Assign a value to AlleleOrigin data member.
755  ///
756  /// @return
757  /// Reference to the data value.
758  TAlleleOrigin& SetAlleleOrigin(void);
759 
760  /// <xsd:simpleType>
761  /// <xsd:restriction base="xsd:string">
762  /// <xsd:enumeration value="unknown"/>
763  /// <xsd:enumeration value="untested"/>
764  /// <xsd:enumeration value="non-pathogenic"/>
765  /// <xsd:enumeration value="probable-non-pathogenic"/>
766  /// <xsd:enumeration value="probable-pathogenic"/>
767  /// <xsd:enumeration value="pathogenic"/>
768  /// <xsd:enumeration value="other"/>
769  /// </xsd:restriction>
770  /// </xsd:simpleType>
771  /// Check if a value has been assigned to ClinicalSignificance data member.
772  ///
773  /// Data member ClinicalSignificance is optional;
774  /// its type is defined as 'typedef string TClinicalSignificance'
775  /// @return
776  /// - true, if a value has been assigned.
777  /// - false, otherwise.
778  bool IsSetClinicalSignificance(void) const;
779 
780  /// Check if it is safe to call GetClinicalSignificance method.
781  ///
782  /// @return
783  /// - true, if the data member is getatable.
784  /// - false, otherwise.
785  bool CanGetClinicalSignificance(void) const;
786 
787  /// Reset ClinicalSignificance data member.
788  void ResetClinicalSignificance(void);
789 
790  /// Get the ClinicalSignificance member data.
791  ///
792  /// @return
793  /// Reference to the member data.
794  const TClinicalSignificance& GetClinicalSignificance(void) const;
795 
796  /// Assign a value to ClinicalSignificance data member.
797  ///
798  /// @param value
799  /// Value to assign
800  void SetClinicalSignificance(const TClinicalSignificance& value);
801  void SetClinicalSignificance(TClinicalSignificance&& value);
802 
803  /// Assign a value to ClinicalSignificance data member.
804  ///
805  /// @return
806  /// Reference to the data value.
807  TClinicalSignificance& SetClinicalSignificance(void);
808 
809  /// Reset the whole object
810  void Reset(void);
811 
812 
813  private:
814  // Prohibit copy constructor and assignment operator
817 
818  // data
819  Uint4 m_set_State[1];
821  string m_Handle;
823  string m_LocSnpId;
831  string m_LinkoutUrl;
832  string m_SsAlias;
835  };
836  /////////////////////////////////////////////////////////////////////////////
837  ///
838  /// C_Sequence --
839  ///
840 
842  {
844  public:
845  // constructor
846  C_Sequence(void);
847  // destructor
848  ~C_Sequence(void);
849 
850  // type info
852 
853  // types
854  typedef string TSeq5;
855  typedef string TObserved;
856  typedef string TSeq3;
857 
858  // member index
859  enum class E_memberIndex {
860  e__allMandatory = 0,
861  e_seq5,
862  e_observed,
863  e_seq3
864  };
866 
867  // getters
868  // setters
869 
870  ///5' sequence that flanks the
871  /// variation
872  /// Check if a value has been assigned to Seq5 data member.
873  ///
874  /// Data member Seq5 is optional;
875  /// its type is defined as 'typedef string TSeq5'
876  /// @return
877  /// - true, if a value has been assigned.
878  /// - false, otherwise.
879  bool IsSetSeq5(void) const;
880 
881  /// Check if it is safe to call GetSeq5 method.
882  ///
883  /// @return
884  /// - true, if the data member is getatable.
885  /// - false, otherwise.
886  bool CanGetSeq5(void) const;
887 
888  /// Reset Seq5 data member.
889  void ResetSeq5(void);
890 
891  /// Get the Seq5 member data.
892  ///
893  /// @return
894  /// Reference to the member data.
895  const TSeq5& GetSeq5(void) const;
896 
897  /// Assign a value to Seq5 data member.
898  ///
899  /// @param value
900  /// Value to assign
901  void SetSeq5(const TSeq5& value);
902  void SetSeq5(TSeq5&& value);
903 
904  /// Assign a value to Seq5 data member.
905  ///
906  /// @return
907  /// Reference to the data value.
908  TSeq5& SetSeq5(void);
909 
910  ///list of all nucleotide alleles observed in
911  /// ss-list members, correcting for reverse complementation of
912  /// memebers reported in reverse orientation
913  /// Check if a value has been assigned to Observed data member.
914  ///
915  /// Data member Observed is mandatory;
916  /// its type is defined as 'typedef string TObserved'
917  /// @return
918  /// - true, if a value has been assigned.
919  /// - false, otherwise.
920  bool IsSetObserved(void) const;
921 
922  /// Check if it is safe to call GetObserved method.
923  ///
924  /// @return
925  /// - true, if the data member is getatable.
926  /// - false, otherwise.
927  bool CanGetObserved(void) const;
928 
929  /// Reset Observed data member.
930  void ResetObserved(void);
931 
932  /// Get the Observed member data.
933  ///
934  /// @return
935  /// Reference to the member data.
936  const TObserved& GetObserved(void) const;
937 
938  /// Assign a value to Observed data member.
939  ///
940  /// @param value
941  /// Value to assign
942  void SetObserved(const TObserved& value);
943  void SetObserved(TObserved&& value);
944 
945  /// Assign a value to Observed data member.
946  ///
947  /// @return
948  /// Reference to the data value.
949  TObserved& SetObserved(void);
950 
951  ///3' sequence that flanks the
952  /// variation
953  /// Check if a value has been assigned to Seq3 data member.
954  ///
955  /// Data member Seq3 is optional;
956  /// its type is defined as 'typedef string TSeq3'
957  /// @return
958  /// - true, if a value has been assigned.
959  /// - false, otherwise.
960  bool IsSetSeq3(void) const;
961 
962  /// Check if it is safe to call GetSeq3 method.
963  ///
964  /// @return
965  /// - true, if the data member is getatable.
966  /// - false, otherwise.
967  bool CanGetSeq3(void) const;
968 
969  /// Reset Seq3 data member.
970  void ResetSeq3(void);
971 
972  /// Get the Seq3 member data.
973  ///
974  /// @return
975  /// Reference to the member data.
976  const TSeq3& GetSeq3(void) const;
977 
978  /// Assign a value to Seq3 data member.
979  ///
980  /// @param value
981  /// Value to assign
982  void SetSeq3(const TSeq3& value);
983  void SetSeq3(TSeq3&& value);
984 
985  /// Assign a value to Seq3 data member.
986  ///
987  /// @return
988  /// Reference to the data value.
989  TSeq3& SetSeq3(void);
990 
991  /// Reset the whole object
992  void Reset(void);
993 
994 
995  private:
996  // Prohibit copy constructor and assignment operator
999 
1000  // data
1001  Uint4 m_set_State[1];
1002  string m_Seq5;
1003  string m_Observed;
1004  string m_Seq3;
1005  };
1006  // types
1009 
1010  // member index
1011  enum class E_memberIndex {
1012  e__allMandatory = 0,
1013  e_attlist,
1014  e_sequence
1015  };
1017 
1018  // getters
1019  // setters
1020 
1021  /// Check if a value has been assigned to Attlist data member.
1022  ///
1023  /// Data member Attlist is mandatory;
1024  /// its type is defined as 'typedef C_Attlist TAttlist'
1025  /// @return
1026  /// - true, if a value has been assigned.
1027  /// - false, otherwise.
1028  bool IsSetAttlist(void) const;
1029 
1030  /// Check if it is safe to call GetAttlist method.
1031  ///
1032  /// @return
1033  /// - true, if the data member is getatable.
1034  /// - false, otherwise.
1035  bool CanGetAttlist(void) const;
1036 
1037  /// Reset Attlist data member.
1038  void ResetAttlist(void);
1039 
1040  /// Get the Attlist member data.
1041  ///
1042  /// @return
1043  /// Reference to the member data.
1044  const TAttlist& GetAttlist(void) const;
1045 
1046  /// Assign a value to Attlist data member.
1047  ///
1048  /// @param value
1049  /// Reference to value.
1050  void SetAttlist(TAttlist& value);
1051 
1052  /// Assign a value to Attlist data member.
1053  ///
1054  /// @return
1055  /// Reference to the data value.
1056  TAttlist& SetAttlist(void);
1057 
1058  /// Check if a value has been assigned to Sequence data member.
1059  ///
1060  /// Data member Sequence is mandatory;
1061  /// its type is defined as 'typedef C_Sequence TSequence'
1062  /// @return
1063  /// - true, if a value has been assigned.
1064  /// - false, otherwise.
1065  bool IsSetSequence(void) const;
1066 
1067  /// Check if it is safe to call GetSequence method.
1068  ///
1069  /// @return
1070  /// - true, if the data member is getatable.
1071  /// - false, otherwise.
1072  bool CanGetSequence(void) const;
1073 
1074  /// Reset Sequence data member.
1075  void ResetSequence(void);
1076 
1077  /// Get the Sequence member data.
1078  ///
1079  /// @return
1080  /// Reference to the member data.
1081  const TSequence& GetSequence(void) const;
1082 
1083  /// Assign a value to Sequence data member.
1084  ///
1085  /// @param value
1086  /// Reference to value.
1087  void SetSequence(TSequence& value);
1088 
1089  /// Assign a value to Sequence data member.
1090  ///
1091  /// @return
1092  /// Reference to the data value.
1093  TSequence& SetSequence(void);
1094 
1095  /// Reset the whole object
1096  virtual void Reset(void);
1097 
1098 
1099 private:
1100  // Prohibit copy constructor and assignment operator
1103 
1104  // data
1105  Uint4 m_set_State[1];
1108 };
1109 
1110 /* @} */
1111 
1112 
1113 
1114 
1115 
1116 ///////////////////////////////////////////////////////////
1117 ///////////////////// inline methods //////////////////////
1118 ///////////////////////////////////////////////////////////
1119 inline
1121 {
1122  return ((m_set_State[0] & 0x3) != 0);
1123 }
1124 
1125 inline
1127 {
1128  return IsSetSsId();
1129 }
1130 
1131 inline
1133 {
1134  m_SsId = 0;
1135  m_set_State[0] &= ~0x3;
1136 }
1137 
1138 inline
1140 {
1141  if (!CanGetSsId()) {
1142  ThrowUnassigned(0);
1143  }
1144  return m_SsId;
1145 }
1146 
1147 inline
1149 {
1150  m_SsId = value;
1151  m_set_State[0] |= 0x3;
1152 }
1153 
1154 inline
1156 {
1157 #ifdef _DEBUG
1158  if (!IsSetSsId()) {
1159  memset(&m_SsId,UnassignedByte(),sizeof(m_SsId));
1160  }
1161 #endif
1162  m_set_State[0] |= 0x1;
1163  return m_SsId;
1164 }
1165 
1166 inline
1168 {
1169  return ((m_set_State[0] & 0xc) != 0);
1170 }
1171 
1172 inline
1174 {
1175  return IsSetHandle();
1176 }
1177 
1178 inline
1180 {
1181  if (!CanGetHandle()) {
1182  ThrowUnassigned(1);
1183  }
1184  return m_Handle;
1185 }
1186 
1187 inline
1189 {
1190  m_Handle = value;
1191  m_set_State[0] |= 0xc;
1192 }
1193 
1194 inline
1196 {
1197  m_Handle = std::forward<CSs_Base::C_Attlist::THandle>(value);
1198  m_set_State[0] |= 0xc;
1199 }
1200 
1201 inline
1203 {
1204 #ifdef _DEBUG
1205  if (!IsSetHandle()) {
1206  m_Handle = UnassignedString();
1207  }
1208 #endif
1209  m_set_State[0] |= 0x4;
1210  return m_Handle;
1211 }
1212 
1213 inline
1215 {
1216  return ((m_set_State[0] & 0x30) != 0);
1217 }
1218 
1219 inline
1221 {
1222  return IsSetBatchId();
1223 }
1224 
1225 inline
1227 {
1228  m_BatchId = 0;
1229  m_set_State[0] &= ~0x30;
1230 }
1231 
1232 inline
1234 {
1235  if (!CanGetBatchId()) {
1236  ThrowUnassigned(2);
1237  }
1238  return m_BatchId;
1239 }
1240 
1241 inline
1243 {
1244  m_BatchId = value;
1245  m_set_State[0] |= 0x30;
1246 }
1247 
1248 inline
1250 {
1251 #ifdef _DEBUG
1252  if (!IsSetBatchId()) {
1253  memset(&m_BatchId,UnassignedByte(),sizeof(m_BatchId));
1254  }
1255 #endif
1256  m_set_State[0] |= 0x10;
1257  return m_BatchId;
1258 }
1259 
1260 inline
1262 {
1263  return ((m_set_State[0] & 0xc0) != 0);
1264 }
1265 
1266 inline
1268 {
1269  return IsSetLocSnpId();
1270 }
1271 
1272 inline
1274 {
1275  if (!CanGetLocSnpId()) {
1276  ThrowUnassigned(3);
1277  }
1278  return m_LocSnpId;
1279 }
1280 
1281 inline
1283 {
1284  m_LocSnpId = value;
1285  m_set_State[0] |= 0xc0;
1286 }
1287 
1288 inline
1290 {
1291  m_LocSnpId = std::forward<CSs_Base::C_Attlist::TLocSnpId>(value);
1292  m_set_State[0] |= 0xc0;
1293 }
1294 
1295 inline
1297 {
1298 #ifdef _DEBUG
1299  if (!IsSetLocSnpId()) {
1300  m_LocSnpId = UnassignedString();
1301  }
1302 #endif
1303  m_set_State[0] |= 0x40;
1304  return m_LocSnpId;
1305 }
1306 
1307 inline
1309 {
1310  return ((m_set_State[0] & 0x300) != 0);
1311 }
1312 
1313 inline
1315 {
1316  return IsSetSubSnpClass();
1317 }
1318 
1319 inline
1321 {
1322  m_SubSnpClass = (EAttlist_subSnpClass)(0);
1323  m_set_State[0] &= ~0x300;
1324 }
1325 
1326 inline
1328 {
1329  if (!CanGetSubSnpClass()) {
1330  ThrowUnassigned(4);
1331  }
1332  return m_SubSnpClass;
1333 }
1334 
1335 inline
1337 {
1338  m_SubSnpClass = value;
1339  m_set_State[0] |= 0x300;
1340 }
1341 
1342 inline
1344 {
1345 #ifdef _DEBUG
1346  if (!IsSetSubSnpClass()) {
1347  memset(&m_SubSnpClass,UnassignedByte(),sizeof(m_SubSnpClass));
1348  }
1349 #endif
1350  m_set_State[0] |= 0x100;
1351  return m_SubSnpClass;
1352 }
1353 
1354 inline
1356 {
1357  return ((m_set_State[0] & 0xc00) != 0);
1358 }
1359 
1360 inline
1362 {
1363  return IsSetOrient();
1364 }
1365 
1366 inline
1368 {
1369  m_Orient = (EAttlist_orient)(0);
1370  m_set_State[0] &= ~0xc00;
1371 }
1372 
1373 inline
1375 {
1376  if (!CanGetOrient()) {
1377  ThrowUnassigned(5);
1378  }
1379  return m_Orient;
1380 }
1381 
1382 inline
1384 {
1385  m_Orient = value;
1386  m_set_State[0] |= 0xc00;
1387 }
1388 
1389 inline
1391 {
1392 #ifdef _DEBUG
1393  if (!IsSetOrient()) {
1394  memset(&m_Orient,UnassignedByte(),sizeof(m_Orient));
1395  }
1396 #endif
1397  m_set_State[0] |= 0x400;
1398  return m_Orient;
1399 }
1400 
1401 inline
1403 {
1404  return ((m_set_State[0] & 0x3000) != 0);
1405 }
1406 
1407 inline
1409 {
1410  return IsSetStrand();
1411 }
1412 
1413 inline
1415 {
1416  m_Strand = (EAttlist_strand)(0);
1417  m_set_State[0] &= ~0x3000;
1418 }
1419 
1420 inline
1422 {
1423  if (!CanGetStrand()) {
1424  ThrowUnassigned(6);
1425  }
1426  return m_Strand;
1427 }
1428 
1429 inline
1431 {
1432  m_Strand = value;
1433  m_set_State[0] |= 0x3000;
1434 }
1435 
1436 inline
1438 {
1439 #ifdef _DEBUG
1440  if (!IsSetStrand()) {
1441  memset(&m_Strand,UnassignedByte(),sizeof(m_Strand));
1442  }
1443 #endif
1444  m_set_State[0] |= 0x1000;
1445  return m_Strand;
1446 }
1447 
1448 inline
1450 {
1451  return ((m_set_State[0] & 0xc000) != 0);
1452 }
1453 
1454 inline
1456 {
1457  return IsSetMolType();
1458 }
1459 
1460 inline
1462 {
1463  m_MolType = (EAttlist_molType)(0);
1464  m_set_State[0] &= ~0xc000;
1465 }
1466 
1467 inline
1469 {
1470  if (!CanGetMolType()) {
1471  ThrowUnassigned(7);
1472  }
1473  return m_MolType;
1474 }
1475 
1476 inline
1478 {
1479  m_MolType = value;
1480  m_set_State[0] |= 0xc000;
1481 }
1482 
1483 inline
1485 {
1486 #ifdef _DEBUG
1487  if (!IsSetMolType()) {
1488  memset(&m_MolType,UnassignedByte(),sizeof(m_MolType));
1489  }
1490 #endif
1491  m_set_State[0] |= 0x4000;
1492  return m_MolType;
1493 }
1494 
1495 inline
1497 {
1498  return ((m_set_State[0] & 0x30000) != 0);
1499 }
1500 
1501 inline
1503 {
1504  return IsSetBuildId();
1505 }
1506 
1507 inline
1509 {
1510  m_BuildId = 0;
1511  m_set_State[0] &= ~0x30000;
1512 }
1513 
1514 inline
1516 {
1517  if (!CanGetBuildId()) {
1518  ThrowUnassigned(8);
1519  }
1520  return m_BuildId;
1521 }
1522 
1523 inline
1525 {
1526  m_BuildId = value;
1527  m_set_State[0] |= 0x30000;
1528 }
1529 
1530 inline
1532 {
1533 #ifdef _DEBUG
1534  if (!IsSetBuildId()) {
1535  memset(&m_BuildId,UnassignedByte(),sizeof(m_BuildId));
1536  }
1537 #endif
1538  m_set_State[0] |= 0x10000;
1539  return m_BuildId;
1540 }
1541 
1542 inline
1544 {
1545  return ((m_set_State[0] & 0xc0000) != 0);
1546 }
1547 
1548 inline
1550 {
1551  return IsSetMethodClass();
1552 }
1553 
1554 inline
1556 {
1557  m_MethodClass = (EAttlist_methodClass)(0);
1558  m_set_State[0] &= ~0xc0000;
1559 }
1560 
1561 inline
1563 {
1564  if (!CanGetMethodClass()) {
1565  ThrowUnassigned(9);
1566  }
1567  return m_MethodClass;
1568 }
1569 
1570 inline
1572 {
1573  m_MethodClass = value;
1574  m_set_State[0] |= 0xc0000;
1575 }
1576 
1577 inline
1579 {
1580 #ifdef _DEBUG
1581  if (!IsSetMethodClass()) {
1582  memset(&m_MethodClass,UnassignedByte(),sizeof(m_MethodClass));
1583  }
1584 #endif
1585  m_set_State[0] |= 0x40000;
1586  return m_MethodClass;
1587 }
1588 
1589 inline
1591 {
1592  return ((m_set_State[0] & 0x300000) != 0);
1593 }
1594 
1595 inline
1597 {
1598  return IsSetValidated();
1599 }
1600 
1601 inline
1603 {
1604  m_Validated = (EAttlist_validated)(0);
1605  m_set_State[0] &= ~0x300000;
1606 }
1607 
1608 inline
1610 {
1611  if (!CanGetValidated()) {
1612  ThrowUnassigned(10);
1613  }
1614  return m_Validated;
1615 }
1616 
1617 inline
1619 {
1620  m_Validated = value;
1621  m_set_State[0] |= 0x300000;
1622 }
1623 
1624 inline
1626 {
1627 #ifdef _DEBUG
1628  if (!IsSetValidated()) {
1629  memset(&m_Validated,UnassignedByte(),sizeof(m_Validated));
1630  }
1631 #endif
1632  m_set_State[0] |= 0x100000;
1633  return m_Validated;
1634 }
1635 
1636 inline
1638 {
1639  return ((m_set_State[0] & 0xc00000) != 0);
1640 }
1641 
1642 inline
1644 {
1645  return IsSetLinkoutUrl();
1646 }
1647 
1648 inline
1650 {
1651  if (!CanGetLinkoutUrl()) {
1652  ThrowUnassigned(11);
1653  }
1654  return m_LinkoutUrl;
1655 }
1656 
1657 inline
1659 {
1660  m_LinkoutUrl = value;
1661  m_set_State[0] |= 0xc00000;
1662 }
1663 
1664 inline
1666 {
1667  m_LinkoutUrl = std::forward<CSs_Base::C_Attlist::TLinkoutUrl>(value);
1668  m_set_State[0] |= 0xc00000;
1669 }
1670 
1671 inline
1673 {
1674 #ifdef _DEBUG
1675  if (!IsSetLinkoutUrl()) {
1676  m_LinkoutUrl = UnassignedString();
1677  }
1678 #endif
1679  m_set_State[0] |= 0x400000;
1680  return m_LinkoutUrl;
1681 }
1682 
1683 inline
1685 {
1686  return ((m_set_State[0] & 0x3000000) != 0);
1687 }
1688 
1689 inline
1691 {
1692  return IsSetSsAlias();
1693 }
1694 
1695 inline
1697 {
1698  if (!CanGetSsAlias()) {
1699  ThrowUnassigned(12);
1700  }
1701  return m_SsAlias;
1702 }
1703 
1704 inline
1706 {
1707  m_SsAlias = value;
1708  m_set_State[0] |= 0x3000000;
1709 }
1710 
1711 inline
1713 {
1714  m_SsAlias = std::forward<CSs_Base::C_Attlist::TSsAlias>(value);
1715  m_set_State[0] |= 0x3000000;
1716 }
1717 
1718 inline
1720 {
1721 #ifdef _DEBUG
1722  if (!IsSetSsAlias()) {
1723  m_SsAlias = UnassignedString();
1724  }
1725 #endif
1726  m_set_State[0] |= 0x1000000;
1727  return m_SsAlias;
1728 }
1729 
1730 inline
1732 {
1733  return ((m_set_State[0] & 0xc000000) != 0);
1734 }
1735 
1736 inline
1738 {
1739  return IsSetAlleleOrigin();
1740 }
1741 
1742 inline
1744 {
1745  m_AlleleOrigin = 0;
1746  m_set_State[0] &= ~0xc000000;
1747 }
1748 
1749 inline
1751 {
1752  if (!CanGetAlleleOrigin()) {
1753  ThrowUnassigned(13);
1754  }
1755  return m_AlleleOrigin;
1756 }
1757 
1758 inline
1760 {
1761  m_AlleleOrigin = value;
1762  m_set_State[0] |= 0xc000000;
1763 }
1764 
1765 inline
1767 {
1768 #ifdef _DEBUG
1769  if (!IsSetAlleleOrigin()) {
1770  memset(&m_AlleleOrigin,UnassignedByte(),sizeof(m_AlleleOrigin));
1771  }
1772 #endif
1773  m_set_State[0] |= 0x4000000;
1774  return m_AlleleOrigin;
1775 }
1776 
1777 inline
1779 {
1780  return ((m_set_State[0] & 0x30000000) != 0);
1781 }
1782 
1783 inline
1785 {
1786  return IsSetClinicalSignificance();
1787 }
1788 
1789 inline
1791 {
1792  if (!CanGetClinicalSignificance()) {
1793  ThrowUnassigned(14);
1794  }
1795  return m_ClinicalSignificance;
1796 }
1797 
1798 inline
1800 {
1801  m_ClinicalSignificance = value;
1802  m_set_State[0] |= 0x30000000;
1803 }
1804 
1805 inline
1807 {
1808  m_ClinicalSignificance = std::forward<CSs_Base::C_Attlist::TClinicalSignificance>(value);
1809  m_set_State[0] |= 0x30000000;
1810 }
1811 
1812 inline
1814 {
1815 #ifdef _DEBUG
1816  if (!IsSetClinicalSignificance()) {
1817  m_ClinicalSignificance = UnassignedString();
1818  }
1819 #endif
1820  m_set_State[0] |= 0x10000000;
1821  return m_ClinicalSignificance;
1822 }
1823 
1824 inline
1826 {
1827  return ((m_set_State[0] & 0x3) != 0);
1828 }
1829 
1830 inline
1832 {
1833  return IsSetSeq5();
1834 }
1835 
1836 inline
1838 {
1839  if (!CanGetSeq5()) {
1840  ThrowUnassigned(0);
1841  }
1842  return m_Seq5;
1843 }
1844 
1845 inline
1847 {
1848  m_Seq5 = value;
1849  m_set_State[0] |= 0x3;
1850 }
1851 
1852 inline
1854 {
1855  m_Seq5 = std::forward<CSs_Base::C_Sequence::TSeq5>(value);
1856  m_set_State[0] |= 0x3;
1857 }
1858 
1859 inline
1861 {
1862 #ifdef _DEBUG
1863  if (!IsSetSeq5()) {
1864  m_Seq5 = UnassignedString();
1865  }
1866 #endif
1867  m_set_State[0] |= 0x1;
1868  return m_Seq5;
1869 }
1870 
1871 inline
1873 {
1874  return ((m_set_State[0] & 0xc) != 0);
1875 }
1876 
1877 inline
1879 {
1880  return IsSetObserved();
1881 }
1882 
1883 inline
1885 {
1886  if (!CanGetObserved()) {
1887  ThrowUnassigned(1);
1888  }
1889  return m_Observed;
1890 }
1891 
1892 inline
1894 {
1895  m_Observed = value;
1896  m_set_State[0] |= 0xc;
1897 }
1898 
1899 inline
1901 {
1902  m_Observed = std::forward<CSs_Base::C_Sequence::TObserved>(value);
1903  m_set_State[0] |= 0xc;
1904 }
1905 
1906 inline
1908 {
1909 #ifdef _DEBUG
1910  if (!IsSetObserved()) {
1911  m_Observed = UnassignedString();
1912  }
1913 #endif
1914  m_set_State[0] |= 0x4;
1915  return m_Observed;
1916 }
1917 
1918 inline
1920 {
1921  return ((m_set_State[0] & 0x30) != 0);
1922 }
1923 
1924 inline
1926 {
1927  return IsSetSeq3();
1928 }
1929 
1930 inline
1932 {
1933  if (!CanGetSeq3()) {
1934  ThrowUnassigned(2);
1935  }
1936  return m_Seq3;
1937 }
1938 
1939 inline
1941 {
1942  m_Seq3 = value;
1943  m_set_State[0] |= 0x30;
1944 }
1945 
1946 inline
1948 {
1949  m_Seq3 = std::forward<CSs_Base::C_Sequence::TSeq3>(value);
1950  m_set_State[0] |= 0x30;
1951 }
1952 
1953 inline
1955 {
1956 #ifdef _DEBUG
1957  if (!IsSetSeq3()) {
1958  m_Seq3 = UnassignedString();
1959  }
1960 #endif
1961  m_set_State[0] |= 0x10;
1962  return m_Seq3;
1963 }
1964 
1965 inline
1966 bool CSs_Base::IsSetAttlist(void) const
1967 {
1968  return m_Attlist.NotEmpty();
1969 }
1970 
1971 inline
1972 bool CSs_Base::CanGetAttlist(void) const
1973 {
1974  return true;
1975 }
1976 
1977 inline
1979 {
1980  if ( !m_Attlist ) {
1981  const_cast<CSs_Base*>(this)->ResetAttlist();
1982  }
1983  return (*m_Attlist);
1984 }
1985 
1986 inline
1988 {
1989  if ( !m_Attlist ) {
1990  ResetAttlist();
1991  }
1992  return (*m_Attlist);
1993 }
1994 
1995 inline
1996 bool CSs_Base::IsSetSequence(void) const
1997 {
1998  return m_Sequence.NotEmpty();
1999 }
2000 
2001 inline
2003 {
2004  return true;
2005 }
2006 
2007 inline
2009 {
2010  if ( !m_Sequence ) {
2011  const_cast<CSs_Base*>(this)->ResetSequence();
2012  }
2013  return (*m_Sequence);
2014 }
2015 
2016 inline
2018 {
2019  if ( !m_Sequence ) {
2020  ResetSequence();
2021  }
2022  return (*m_Sequence);
2023 }
2024 
2025 ///////////////////////////////////////////////////////////
2026 ////////////////// end of inline methods //////////////////
2027 ///////////////////////////////////////////////////////////
2028 
2029 
2030 
2031 
2032 
2033 END_objects_SCOPE // namespace ncbi::objects::
2034 
2036 
2037 
2038 #endif // OBJECTS_DOCSUM_SS_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
C_Attlist –.
Definition: Ss_.hpp:91
C_Sequence –.
Definition: Ss_.hpp:842
data for an individual submission to dbSNP
Definition: Ss_.hpp:74
SBlastSequence GetSequence(const objects::CSeq_loc &sl, EBlastEncoding encoding, objects::CScope *scope, objects::ENa_strand strand=objects::eNa_strand_plus, ESentinelType sentinel=eSentinels, std::string *warnings=NULL)
Retrieves a sequence using the object manager.
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
ENa_strand GetStrand(const CSeq_loc &loc, CScope *scope=0)
Returns eNa_strand_unknown if multiple Bioseqs in loc Returns eNa_strand_other if multiple strands in...
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
int64_t Int8
8-byte (64-bit) signed integer
Definition: ncbitype.h:104
#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_DOCSUM_EXPORT
Definition: ncbi_export.h:456
TBatchId GetBatchId(void) const
Get the BatchId member data.
Definition: Ss_.hpp:1233
TClinicalSignificance & SetClinicalSignificance(void)
Assign a value to ClinicalSignificance data member.
Definition: Ss_.hpp:1813
EAttlist_subSnpClass m_SubSnpClass
Definition: Ss_.hpp:824
bool CanGetAttlist(void) const
Check if it is safe to call GetAttlist method.
Definition: Ss_.hpp:1972
CSerialObject Tparent
Definition: Ss_.hpp:843
C_Attlist(const C_Attlist &)
TObserved & SetObserved(void)
Assign a value to Observed data member.
Definition: Ss_.hpp:1907
TSequence & SetSequence(void)
Assign a value to Sequence data member.
Definition: Ss_.hpp:2017
E_memberIndex
Definition: Ss_.hpp:1011
string TObserved
Definition: Ss_.hpp:855
void SetHandle(THandle &&value)
EAttlist_orient m_Orient
Definition: Ss_.hpp:825
TAlleleOrigin & SetAlleleOrigin(void)
Assign a value to AlleleOrigin data member.
Definition: Ss_.hpp:1766
EAttlist_strand m_Strand
Definition: Ss_.hpp:826
void ResetBatchId(void)
Reset BatchId data member.
Definition: Ss_.hpp:1226
bool IsSetLinkoutUrl(void) const
append loc-snp-id to this base URL to construct a pointer to submitter data.
Definition: Ss_.hpp:1637
const TLinkoutUrl & GetLinkoutUrl(void) const
Get the LinkoutUrl member data.
Definition: Ss_.hpp:1649
EAttlist_subSnpClass
SubSNP classification by type of variation.
Definition: Ss_.hpp:104
TStrand & SetStrand(void)
Assign a value to Strand data member.
Definition: Ss_.hpp:1437
string m_Handle
Definition: Ss_.hpp:821
TMethodClass & SetMethodClass(void)
Assign a value to MethodClass data member.
Definition: Ss_.hpp:1578
EAttlist_strand
strand is defined as TOP/BOTTOM by nature of flanking nucleotide sequence
Definition: Ss_.hpp:130
Uint4 m_set_State[1]
Definition: Ss_.hpp:819
C_Attlist TAttlist
Definition: Ss_.hpp:1007
bool CanGetClinicalSignificance(void) const
Check if it is safe to call GetClinicalSignificance method.
Definition: Ss_.hpp:1784
bool IsSetClinicalSignificance(void) const
<xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="unknown"/> <xsd:enumerat...
Definition: Ss_.hpp:1778
TBuildId GetBuildId(void) const
Get the BuildId member data.
Definition: Ss_.hpp:1515
void ResetSequence(void)
Reset Sequence data member.
Definition: Ss_.cpp:271
C_Sequence(const C_Sequence &)
const TSeq3 & GetSeq3(void) const
Get the Seq3 member data.
Definition: Ss_.hpp:1931
DECLARE_INTERNAL_TYPE_INFO()
bool IsSetAttlist(void) const
Check if a value has been assigned to Attlist data member.
Definition: Ss_.hpp:1966
bool IsSetBatchId(void) const
dbSNP number for batch submission Check if a value has been assigned to BatchId data member.
Definition: Ss_.hpp:1214
TAlleleOrigin GetAlleleOrigin(void) const
Get the AlleleOrigin member data.
Definition: Ss_.hpp:1750
const TLocSnpId & GetLocSnpId(void) const
Get the LocSnpId member data.
Definition: Ss_.hpp:1273
string TLocSnpId
Definition: Ss_.hpp:180
bool CanGetOrient(void) const
Check if it is safe to call GetOrient method.
Definition: Ss_.hpp:1361
TOrient & SetOrient(void)
Assign a value to Orient data member.
Definition: Ss_.hpp:1390
TBuildId & SetBuildId(void)
Assign a value to BuildId data member.
Definition: Ss_.hpp:1531
CRef< TSequence > m_Sequence
Definition: Ss_.hpp:1107
const TSeq5 & GetSeq5(void) const
Get the Seq5 member data.
Definition: Ss_.hpp:1837
void SetHandle(const THandle &value)
Assign a value to Handle data member.
bool CanGetBuildId(void) const
Check if it is safe to call GetBuildId method.
Definition: Ss_.hpp:1502
EAttlist_orient
orientation of refsnp cluster members to refsnp cluster sequence
Definition: Ss_.hpp:120
EAttlist_validated
subsnp has been experimentally validated by submitter
Definition: Ss_.hpp:167
bool CanGetSequence(void) const
Check if it is safe to call GetSequence method.
Definition: Ss_.hpp:2002
Uint4 m_set_State[1]
Definition: Ss_.hpp:1105
bool CanGetValidated(void) const
Check if it is safe to call GetValidated method.
Definition: Ss_.hpp:1596
void ResetAlleleOrigin(void)
Reset AlleleOrigin data member.
Definition: Ss_.hpp:1743
bool IsSetHandle(void) const
Tag for the submitting laboratory Check if a value has been assigned to Handle data member.
Definition: Ss_.hpp:1167
TMolType & SetMolType(void)
Assign a value to MolType data member.
Definition: Ss_.hpp:1484
const TObserved & GetObserved(void) const
Get the Observed member data.
Definition: Ss_.hpp:1884
TValidated & SetValidated(void)
Assign a value to Validated data member.
Definition: Ss_.hpp:1625
C_Sequence & operator=(const C_Sequence &)
TLocSnpId & SetLocSnpId(void)
Assign a value to LocSnpId data member.
Definition: Ss_.hpp:1296
const TClinicalSignificance & GetClinicalSignificance(void) const
Get the ClinicalSignificance member data.
Definition: Ss_.hpp:1790
void ResetAttlist(void)
Reset Attlist data member.
Definition: Ss_.cpp:257
TStrand GetStrand(void) const
Get the Strand member data.
Definition: Ss_.hpp:1421
bool CanGetBatchId(void) const
Check if it is safe to call GetBatchId method.
Definition: Ss_.hpp:1220
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Definition: Ss_.hpp:1016
bool CanGetHandle(void) const
Check if it is safe to call GetHandle method.
Definition: Ss_.hpp:1173
Tparent::CMemberIndex< E_memberIndex, 16 > TmemberIndex
Definition: Ss_.hpp:212
const THandle & GetHandle(void) const
Get the Handle member data.
Definition: Ss_.hpp:1179
void ResetOrient(void)
Reset Orient data member.
Definition: Ss_.hpp:1367
const TSsAlias & GetSsAlias(void) const
Get the SsAlias member data.
Definition: Ss_.hpp:1696
void ResetMolType(void)
Reset MolType data member.
Definition: Ss_.hpp:1461
CSs_Base & operator=(const CSs_Base &)
C_Attlist & operator=(const C_Attlist &)
void ResetSsId(void)
Reset SsId data member.
Definition: Ss_.hpp:1132
TBatchId & SetBatchId(void)
Assign a value to BatchId data member.
Definition: Ss_.hpp:1249
CRef< TAttlist > m_Attlist
Definition: Ss_.hpp:1106
string TSsAlias
Definition: Ss_.hpp:189
bool CanGetAlleleOrigin(void) const
Check if it is safe to call GetAlleleOrigin method.
Definition: Ss_.hpp:1737
TAttlist & SetAttlist(void)
Assign a value to Attlist data member.
Definition: Ss_.hpp:1987
void ResetStrand(void)
Reset Strand data member.
Definition: Ss_.hpp:1414
bool IsSetSeq5(void) const
5' sequence that flanks the variation Check if a value has been assigned to Seq5 data member.
Definition: Ss_.hpp:1825
string m_SsAlias
Definition: Ss_.hpp:832
void ResetMethodClass(void)
Reset MethodClass data member.
Definition: Ss_.hpp:1555
bool IsSetSeq3(void) const
3' sequence that flanks the variation Check if a value has been assigned to Seq3 data member.
Definition: Ss_.hpp:1919
TSsId GetSsId(void) const
Get the SsId member data.
Definition: Ss_.hpp:1139
TSsId & SetSsId(void)
Assign a value to SsId data member.
Definition: Ss_.hpp:1155
bool IsSetAlleleOrigin(void) const
<xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="unknown"/> <xsd:enumerat...
Definition: Ss_.hpp:1731
bool CanGetSsId(void) const
Check if it is safe to call GetSsId method.
Definition: Ss_.hpp:1126
bool IsSetObserved(void) const
list of all nucleotide alleles observed in ss-list members, correcting for reverse complementation of...
Definition: Ss_.hpp:1872
bool CanGetLocSnpId(void) const
Check if it is safe to call GetLocSnpId method.
Definition: Ss_.hpp:1267
EAttlist_molType TMolType
Definition: Ss_.hpp:184
TSubSnpClass & SetSubSnpClass(void)
Assign a value to SubSnpClass data member.
Definition: Ss_.hpp:1343
bool IsSetOrient(void) const
Check if a value has been assigned to Orient data member.
Definition: Ss_.hpp:1355
bool IsSetSsId(void) const
dbSNP accession number for submission Check if a value has been assigned to SsId data member.
Definition: Ss_.hpp:1120
EAttlist_molType m_MolType
Definition: Ss_.hpp:827
CSerialObject Tparent
Definition: Ss_.hpp:75
EAttlist_validated m_Validated
Definition: Ss_.hpp:830
EAttlist_methodClass
class of method used to assay for the variation
Definition: Ss_.hpp:151
bool CanGetLinkoutUrl(void) const
Check if it is safe to call GetLinkoutUrl method.
Definition: Ss_.hpp:1643
EAttlist_subSnpClass TSubSnpClass
Definition: Ss_.hpp:181
bool CanGetSeq5(void) const
Check if it is safe to call GetSeq5 method.
Definition: Ss_.hpp:1831
bool CanGetObserved(void) const
Check if it is safe to call GetObserved method.
Definition: Ss_.hpp:1878
string THandle
Definition: Ss_.hpp:178
TSsAlias & SetSsAlias(void)
Assign a value to SsAlias data member.
Definition: Ss_.hpp:1719
bool CanGetSsAlias(void) const
Check if it is safe to call GetSsAlias method.
Definition: Ss_.hpp:1690
TSubSnpClass GetSubSnpClass(void) const
Get the SubSnpClass member data.
Definition: Ss_.hpp:1327
bool IsSetSsAlias(void) const
Check if a value has been assigned to SsAlias data member.
Definition: Ss_.hpp:1684
bool CanGetSeq3(void) const
Check if it is safe to call GetSeq3 method.
Definition: Ss_.hpp:1925
void ResetValidated(void)
Reset Validated data member.
Definition: Ss_.hpp:1602
THandle & SetHandle(void)
Assign a value to Handle data member.
Definition: Ss_.hpp:1202
string TLinkoutUrl
Definition: Ss_.hpp:188
bool CanGetStrand(void) const
Check if it is safe to call GetStrand method.
Definition: Ss_.hpp:1408
EAttlist_methodClass TMethodClass
Definition: Ss_.hpp:186
TMethodClass GetMethodClass(void) const
Get the MethodClass member data.
Definition: Ss_.hpp:1562
bool IsSetLocSnpId(void) const
submission (ss#) submitter ID Check if a value has been assigned to LocSnpId data member.
Definition: Ss_.hpp:1261
void ResetBuildId(void)
Reset BuildId data member.
Definition: Ss_.hpp:1508
EAttlist_orient TOrient
Definition: Ss_.hpp:182
bool IsSetMolType(void) const
moltype from Batch table Check if a value has been assigned to MolType data member.
Definition: Ss_.hpp:1449
TMolType GetMolType(void) const
Get the MolType member data.
Definition: Ss_.hpp:1468
string m_LocSnpId
Definition: Ss_.hpp:823
bool IsSetSubSnpClass(void) const
Check if a value has been assigned to SubSnpClass data member.
Definition: Ss_.hpp:1308
bool IsSetStrand(void) const
Check if a value has been assigned to Strand data member.
Definition: Ss_.hpp:1402
string TClinicalSignificance
Definition: Ss_.hpp:191
bool CanGetSubSnpClass(void) const
Check if it is safe to call GetSubSnpClass method.
Definition: Ss_.hpp:1314
bool IsSetBuildId(void) const
dbSNP build number when ss# was added to a refSNP (rs#) cluster Check if a value has been assigned to...
Definition: Ss_.hpp:1496
TValidated GetValidated(void) const
Get the Validated member data.
Definition: Ss_.hpp:1609
CSerialObject Tparent
Definition: Ss_.hpp:92
TLinkoutUrl & SetLinkoutUrl(void)
Assign a value to LinkoutUrl data member.
Definition: Ss_.hpp:1672
TSeq3 & SetSeq3(void)
Assign a value to Seq3 data member.
Definition: Ss_.hpp:1954
string m_ClinicalSignificance
Definition: Ss_.hpp:834
bool IsSetValidated(void) const
Check if a value has been assigned to Validated data member.
Definition: Ss_.hpp:1590
CSs_Base(const CSs_Base &)
const TSequence & GetSequence(void) const
Get the Sequence member data.
Definition: Ss_.hpp:2008
EAttlist_validated TValidated
Definition: Ss_.hpp:187
bool CanGetMethodClass(void) const
Check if it is safe to call GetMethodClass method.
Definition: Ss_.hpp:1549
const TAttlist & GetAttlist(void) const
Get the Attlist member data.
Definition: Ss_.hpp:1978
bool CanGetMolType(void) const
Check if it is safe to call GetMolType method.
Definition: Ss_.hpp:1455
TSeq5 & SetSeq5(void)
Assign a value to Seq5 data member.
Definition: Ss_.hpp:1860
EAttlist_strand TStrand
Definition: Ss_.hpp:183
void ResetSubSnpClass(void)
Reset SubSnpClass data member.
Definition: Ss_.hpp:1320
bool IsSetSequence(void) const
Check if a value has been assigned to Sequence data member.
Definition: Ss_.hpp:1996
C_Sequence TSequence
Definition: Ss_.hpp:1008
EAttlist_methodClass m_MethodClass
Definition: Ss_.hpp:829
bool IsSetMethodClass(void) const
Check if a value has been assigned to MethodClass data member.
Definition: Ss_.hpp:1543
Tparent::CMemberIndex< E_memberIndex, 4 > TmemberIndex
Definition: Ss_.hpp:865
string m_LinkoutUrl
Definition: Ss_.hpp:831
TOrient GetOrient(void) const
Get the Orient member data.
Definition: Ss_.hpp:1374
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Sep 04 14:59:04 2024 by modify_doxy.py rev. 669887