NCBI C++ ToolKit
VariantProperties_.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 VariantProperties_.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/seqfeat/seqfeat.asn">seqfeat.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqfeat/seqfeat.def">seqfeat.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_SEQFEAT_VARIANTPROPERTIES_BASE_HPP
42 #define OBJECTS_SEQFEAT_VARIANTPROPERTIES_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
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_NCBI_Variation
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///
69 ///
70 ///
71 ///
72 ///
73 ///
74 ///
75 ///
76 ///
77 ///
78 ///
79 ///
80 ///
81 ///
82 ///
83 ///
84 ///
85 ///
86 ///
87 /// Historically, the dbSNP definitions document data structures used in the
88 /// processing and annotation of variations by the dbSNP group. The intention
89 /// is to provide information to clients that reflect internal information
90 /// produced during the mapping of SNPs
91 ///
92 ///
93 ///
94 ///
95 ///
96 ///
97 ///
98 ///
99 ///
100 ///
101 ///
102 ///
103 ///
104 ///
105 ///
106 ///
107 ///
108 ///
109 ///
110 ///
111 /// CVariantProperties_Base --
112 ///
113 
115 {
117 public:
118  // constructor
120  // destructor
121  virtual ~CVariantProperties_Base(void);
122 
123  // type info
125 
126  /// NOTE:
127  /// The format for most of these values is as an integer
128  /// Unless otherwise noted, these integers represent a bitwise OR (= simple
129  /// sum) of the possible values, and as such, these values represent the
130  /// specific bit flags that may be set for each of the possible attributes
131  /// here.
133  eResource_link_preserved = 1, ///< Clinical, Pubmed, Cited, (0x01)
134  eResource_link_provisional = 2, ///< Provisional Third Party Annotations (0x02)
135  eResource_link_has3D = 4, ///< Has 3D strcture SNP3D table (0x04)
136  eResource_link_submitterLinkout = 8, ///< SNP->SubSNP->Batch link_out (0x08)
137  eResource_link_clinical = 16, ///< Clinical if LSDB, OMIM, TPA, Diagnostic (0x10)
138  eResource_link_genotypeKit = 32 ///< Marker exists on high density genotyping kit (0x20)
139  };
140 
141  /// Access to EResource_link's attributes (values, names) as defined in spec
142  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EResource_link)(void);
143 
145  eGene_location_in_gene = 1, ///< Sequence intervals covered by a gene ID but not having an aligned transcript (0x01)
146  eGene_location_near_gene_5 = 2, ///< Within 2kb of the 5' end of a gene feature
147  eGene_location_near_gene_3 = 4, ///< Within 0.5kb of the 3' end of a gene feature
148  eGene_location_intron = 8, ///< In Intron (0x08)
149  eGene_location_donor = 16, ///< In donor splice-site (0x10)
150  eGene_location_acceptor = 32, ///< In acceptor splice-site (0x20)
151  eGene_location_utr_5 = 64, ///< In 5' UTR (0x40)
152  eGene_location_utr_3 = 128, ///< In 3' UTR (0x80)
153  eGene_location_in_start_codon = 256, ///< the variant is observed in a start codon (0x100)
154  eGene_location_in_stop_codon = 512, ///< the variant is observed in a stop codon (0x200)
155  eGene_location_intergenic = 1024, ///< variant located between genes (0x400)
156  eGene_location_conserved_noncoding = 2048 ///< variant is located in a conserved non-coding region (0x800)
157  };
158 
159  /// Access to EGene_location's attributes (values, names) as defined in spec
160  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EGene_location)(void);
161 
162  enum EEffect {
163  eEffect_no_change = 0, ///< known to cause no functional changes since 0 does not combine with any other bit value, 'no-change' specifically implies that there are no consequences
164  eEffect_synonymous = 1, ///< one allele in the set does not change the encoded amino acid (0x1)
165  eEffect_nonsense = 2, ///< one allele in the set changes to STOP codon (TER). (0x2)
166  eEffect_missense = 4, ///< one allele in the set changes protein peptide (0x4)
167  eEffect_frameshift = 8, ///< one allele in the set changes all downstream amino acids (0x8)
168  eEffect_up_regulator = 16, ///< the variant causes increased transcription (0x10)
169  eEffect_down_regulator = 32, ///< the variant causes decreased transcription (0x20)
170  eEffect_methylation = 64,
171  eEffect_stop_gain = 128, ///< reference codon is not stop codon, but the snp variant allele changes the codon to a terminating codon.
172  eEffect_stop_loss = 256 ///< reverse of STOP-GAIN: reference codon is a stop codon, but a snp variant allele changes the codon to a non-terminating codon.
173  };
174 
175  /// Access to EEffect's attributes (values, names) as defined in spec
176  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EEffect)(void);
177 
178  enum EMapping {
179  eMapping_has_other_snp = 1, ///< Another SNP has the same mapped positions on reference assembly (0x01)
180  eMapping_has_assembly_conflict = 2, ///< Weight 1 or 2 SNPs that map to different chromosomes on different assemblies (0x02)
181  eMapping_is_assembly_specific = 4 ///< Only maps to 1 assembly (0x04)
182  };
183 
184  /// Access to EMapping's attributes (values, names) as defined in spec
185  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EMapping)(void);
186 
187  /// map-weight captures specificity of placement
188  /// NOTE: This is *NOT* a bitfield
189  enum EMap_weight {
190  eMap_weight_is_uniquely_placed = 1,
191  eMap_weight_placed_twice_on_same_chrom = 2,
192  eMap_weight_placed_twice_on_diff_chrom = 3,
193  eMap_weight_many_placements = 10
194  };
195 
196  /// Access to EMap_weight's attributes (values, names) as defined in spec
197  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EMap_weight)(void);
198 
200  eFrequency_based_validation_is_mutation = 1, ///< low frequency variation that is cited in journal or other reputable sources (0x01)
201  eFrequency_based_validation_above_5pct_all = 2, ///< >5% minor allele freq in each and all populations (0x02)
202  eFrequency_based_validation_above_5pct_1plus = 4, ///< >5% minor allele freq in 1+ populations (0x04)
203  eFrequency_based_validation_validated = 8, ///< Bit is set if the variant has a minor allele observed in two or more separate chromosomes
204  eFrequency_based_validation_above_1pct_all = 16, ///< >1% minor allele freq in each and all populations (0x10)
205  eFrequency_based_validation_above_1pct_1plus = 32 ///< >1% minor allele freq in 1+ populations (0x20)
206  };
207 
208  /// Access to EFrequency_based_validation's attributes (values, names) as defined in spec
209  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EFrequency_based_validation)(void);
210 
211  enum EGenotype {
212  eGenotype_in_haplotype_set = 1, ///< Exists in a haplotype tagging set (0x01)
213  eGenotype_has_genotypes = 2 ///< SNP has individual genotype (0x02)
214  };
215 
216  /// Access to EGenotype's attributes (values, names) as defined in spec
217  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EGenotype)(void);
218 
220  eQuality_check_contig_allele_missing = 1, ///< Reference sequence allele at the mapped position is not present in the SNP allele list, adjusted for orientation (0x01)
221  eQuality_check_withdrawn_by_submitter = 2, ///< One member SS is withdrawn by submitter (0x02)
222  eQuality_check_non_overlapping_alleles = 4, ///< RS set has 2+ alleles from different submissions and these sets share no alleles in common (0x04)
223  eQuality_check_strain_specific = 8, ///< Straing specific fixed difference (0x08)
224  eQuality_check_genotype_conflict = 16 ///< Has Genotype Conflict (0x10)
225  };
226 
227  /// Access to EQuality_check's attributes (values, names) as defined in spec
228  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EQuality_check)(void);
229 
230  enum EConfidence {
231  eConfidence_unknown = 0,
232  eConfidence_likely_artifact = 1,
233  eConfidence_other = 255
234  };
235 
236  /// Access to EConfidence's attributes (values, names) as defined in spec
237  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EConfidence)(void);
238 
239  /// origin of this allele, if known
240  /// note that these are powers-of-two, and represent bits; thus, we can
241  /// represent more than one state simultaneously through a bitwise OR
243  eAllele_origin_unknown = 0,
244  eAllele_origin_germline = 1,
245  eAllele_origin_somatic = 2,
246  eAllele_origin_inherited = 4,
247  eAllele_origin_paternal = 8,
248  eAllele_origin_maternal = 16,
249  eAllele_origin_de_novo = 32,
250  eAllele_origin_biparental = 64,
251  eAllele_origin_uniparental = 128,
252  eAllele_origin_not_tested = 256,
253  eAllele_origin_tested_inconclusive = 512,
254  eAllele_origin_not_reported = 1024,
255  eAllele_origin_other = 1073741824 ///< stopper - 2^31
256  };
257 
258  /// Access to EAllele_origin's attributes (values, names) as defined in spec
259  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAllele_origin)(void);
260 
261  /// observed allele state, if known
262  /// NOTE: THIS IS NOT A BITFIELD!
264  eAllele_state_unknown = 0,
265  eAllele_state_homozygous = 1,
266  eAllele_state_heterozygous = 2,
267  eAllele_state_hemizygous = 3,
268  eAllele_state_nullizygous = 4,
269  eAllele_state_other = 255
270  };
271 
272  /// Access to EAllele_state's attributes (values, names) as defined in spec
273  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAllele_state)(void);
274 
275  // types
276  typedef int TVersion;
277  typedef int TResource_link;
278  typedef int TGene_location;
279  typedef int TEffect;
280  typedef int TMapping;
281  typedef int TMap_weight;
283  typedef int TGenotype;
284  typedef list< int > TProject_data;
285  typedef int TQuality_check;
286  typedef int TConfidence;
287  typedef bool TOther_validation;
288  typedef int TAllele_origin;
289  typedef int TAllele_state;
290  typedef double TAllele_frequency;
291  typedef bool TIs_ancestral_allele;
292 
293  // member index
294  enum class E_memberIndex {
295  e__allMandatory = 0,
296  e_version,
297  e_resource_link,
298  e_gene_location,
299  e_effect,
300  e_mapping,
301  e_map_weight,
302  e_frequency_based_validation,
303  e_genotype,
304  e_project_data,
305  e_quality_check,
306  e_confidence,
307  e_other_validation,
308  e_allele_origin,
309  e_allele_state,
310  e_allele_frequency,
311  e_is_ancestral_allele
312  };
314 
315  // getters
316  // setters
317 
318  /// Check if a value has been assigned to Version data member.
319  ///
320  /// Data member Version is mandatory;
321  /// its type is defined as 'typedef int TVersion'
322  /// @return
323  /// - true, if a value has been assigned.
324  /// - false, otherwise.
325  bool IsSetVersion(void) const;
326 
327  /// Check if it is safe to call GetVersion method.
328  ///
329  /// @return
330  /// - true, if the data member is getatable.
331  /// - false, otherwise.
332  bool CanGetVersion(void) const;
333 
334  /// Reset Version data member.
335  void ResetVersion(void);
336 
337  /// Get the Version member data.
338  ///
339  /// @return
340  /// Copy of the member data.
341  TVersion GetVersion(void) const;
342 
343  /// Assign a value to Version data member.
344  ///
345  /// @param value
346  /// Value to assign
347  void SetVersion(TVersion value);
348 
349  /// Assign a value to Version data member.
350  ///
351  /// @return
352  /// Reference to the data value.
353  TVersion& SetVersion(void);
354 
355  /// Check if a value has been assigned to Resource_link data member.
356  ///
357  /// Data member Resource_link is optional;
358  /// its type is defined as 'typedef int TResource_link'
359  /// @return
360  /// - true, if a value has been assigned.
361  /// - false, otherwise.
362  bool IsSetResource_link(void) const;
363 
364  /// Check if it is safe to call GetResource_link method.
365  ///
366  /// @return
367  /// - true, if the data member is getatable.
368  /// - false, otherwise.
369  bool CanGetResource_link(void) const;
370 
371  /// Reset Resource_link data member.
372  void ResetResource_link(void);
373 
374  /// Get the Resource_link member data.
375  ///
376  /// @return
377  /// Copy of the member data.
378  TResource_link GetResource_link(void) const;
379 
380  /// Assign a value to Resource_link data member.
381  ///
382  /// @param value
383  /// Value to assign
384  void SetResource_link(TResource_link value);
385 
386  /// Assign a value to Resource_link data member.
387  ///
388  /// @return
389  /// Reference to the data value.
390  TResource_link& SetResource_link(void);
391 
392  /// Check if a value has been assigned to Gene_location data member.
393  ///
394  /// Data member Gene_location is optional;
395  /// its type is defined as 'typedef int TGene_location'
396  /// @return
397  /// - true, if a value has been assigned.
398  /// - false, otherwise.
399  bool IsSetGene_location(void) const;
400 
401  /// Check if it is safe to call GetGene_location method.
402  ///
403  /// @return
404  /// - true, if the data member is getatable.
405  /// - false, otherwise.
406  bool CanGetGene_location(void) const;
407 
408  /// Reset Gene_location data member.
409  void ResetGene_location(void);
410 
411  /// Get the Gene_location member data.
412  ///
413  /// @return
414  /// Copy of the member data.
415  TGene_location GetGene_location(void) const;
416 
417  /// Assign a value to Gene_location data member.
418  ///
419  /// @param value
420  /// Value to assign
421  void SetGene_location(TGene_location value);
422 
423  /// Assign a value to Gene_location data member.
424  ///
425  /// @return
426  /// Reference to the data value.
427  TGene_location& SetGene_location(void);
428 
429  /// Check if a value has been assigned to Effect data member.
430  ///
431  /// Data member Effect is optional;
432  /// its type is defined as 'typedef int TEffect'
433  /// @return
434  /// - true, if a value has been assigned.
435  /// - false, otherwise.
436  bool IsSetEffect(void) const;
437 
438  /// Check if it is safe to call GetEffect method.
439  ///
440  /// @return
441  /// - true, if the data member is getatable.
442  /// - false, otherwise.
443  bool CanGetEffect(void) const;
444 
445  /// Reset Effect data member.
446  void ResetEffect(void);
447 
448  /// Get the Effect member data.
449  ///
450  /// @return
451  /// Copy of the member data.
452  TEffect GetEffect(void) const;
453 
454  /// Assign a value to Effect data member.
455  ///
456  /// @param value
457  /// Value to assign
458  void SetEffect(TEffect value);
459 
460  /// Assign a value to Effect data member.
461  ///
462  /// @return
463  /// Reference to the data value.
464  TEffect& SetEffect(void);
465 
466  /// Check if a value has been assigned to Mapping data member.
467  ///
468  /// Data member Mapping is optional;
469  /// its type is defined as 'typedef int TMapping'
470  /// @return
471  /// - true, if a value has been assigned.
472  /// - false, otherwise.
473  bool IsSetMapping(void) const;
474 
475  /// Check if it is safe to call GetMapping method.
476  ///
477  /// @return
478  /// - true, if the data member is getatable.
479  /// - false, otherwise.
480  bool CanGetMapping(void) const;
481 
482  /// Reset Mapping data member.
483  void ResetMapping(void);
484 
485  /// Get the Mapping member data.
486  ///
487  /// @return
488  /// Copy of the member data.
489  TMapping GetMapping(void) const;
490 
491  /// Assign a value to Mapping data member.
492  ///
493  /// @param value
494  /// Value to assign
495  void SetMapping(TMapping value);
496 
497  /// Assign a value to Mapping data member.
498  ///
499  /// @return
500  /// Reference to the data value.
501  TMapping& SetMapping(void);
502 
503  /// Check if a value has been assigned to Map_weight data member.
504  ///
505  /// Data member Map_weight is optional;
506  /// its type is defined as 'typedef int TMap_weight'
507  /// @return
508  /// - true, if a value has been assigned.
509  /// - false, otherwise.
510  bool IsSetMap_weight(void) const;
511 
512  /// Check if it is safe to call GetMap_weight method.
513  ///
514  /// @return
515  /// - true, if the data member is getatable.
516  /// - false, otherwise.
517  bool CanGetMap_weight(void) const;
518 
519  /// Reset Map_weight data member.
520  void ResetMap_weight(void);
521 
522  /// Get the Map_weight member data.
523  ///
524  /// @return
525  /// Copy of the member data.
526  TMap_weight GetMap_weight(void) const;
527 
528  /// Assign a value to Map_weight data member.
529  ///
530  /// @param value
531  /// Value to assign
532  void SetMap_weight(TMap_weight value);
533 
534  /// Assign a value to Map_weight data member.
535  ///
536  /// @return
537  /// Reference to the data value.
538  TMap_weight& SetMap_weight(void);
539 
540  /// Check if a value has been assigned to Frequency_based_validation data member.
541  ///
542  /// Data member Frequency_based_validation is optional;
543  /// its type is defined as 'typedef int TFrequency_based_validation'
544  /// @return
545  /// - true, if a value has been assigned.
546  /// - false, otherwise.
547  bool IsSetFrequency_based_validation(void) const;
548 
549  /// Check if it is safe to call GetFrequency_based_validation method.
550  ///
551  /// @return
552  /// - true, if the data member is getatable.
553  /// - false, otherwise.
554  bool CanGetFrequency_based_validation(void) const;
555 
556  /// Reset Frequency_based_validation data member.
557  void ResetFrequency_based_validation(void);
558 
559  /// Get the Frequency_based_validation member data.
560  ///
561  /// @return
562  /// Copy of the member data.
563  TFrequency_based_validation GetFrequency_based_validation(void) const;
564 
565  /// Assign a value to Frequency_based_validation data member.
566  ///
567  /// @param value
568  /// Value to assign
569  void SetFrequency_based_validation(TFrequency_based_validation value);
570 
571  /// Assign a value to Frequency_based_validation data member.
572  ///
573  /// @return
574  /// Reference to the data value.
575  TFrequency_based_validation& SetFrequency_based_validation(void);
576 
577  /// Check if a value has been assigned to Genotype data member.
578  ///
579  /// Data member Genotype is optional;
580  /// its type is defined as 'typedef int TGenotype'
581  /// @return
582  /// - true, if a value has been assigned.
583  /// - false, otherwise.
584  bool IsSetGenotype(void) const;
585 
586  /// Check if it is safe to call GetGenotype method.
587  ///
588  /// @return
589  /// - true, if the data member is getatable.
590  /// - false, otherwise.
591  bool CanGetGenotype(void) const;
592 
593  /// Reset Genotype data member.
594  void ResetGenotype(void);
595 
596  /// Get the Genotype member data.
597  ///
598  /// @return
599  /// Copy of the member data.
600  TGenotype GetGenotype(void) const;
601 
602  /// Assign a value to Genotype data member.
603  ///
604  /// @param value
605  /// Value to assign
606  void SetGenotype(TGenotype value);
607 
608  /// Assign a value to Genotype data member.
609  ///
610  /// @return
611  /// Reference to the data value.
612  TGenotype& SetGenotype(void);
613 
614  /// project IDs are IDs from BioProjects
615  /// in order to report information about project relationships, we
616  /// require projects to be registered
617  /// This field in many ways duplicates dbxrefs; however, the
618  /// intention of this field is to more adequately reflect
619  /// ownership and data source
620  ///
621  /// 11/9/2010: DO NOT USE
622  /// This field was changed in the spec in a breaking way; using it will
623  /// break clients. We are officially suppressing / abandoning this field.
624  /// Clients who need to use this should instead place the data in
625  /// Seq-feat.dbxref, using the db name 'BioProject'
626  /// Check if a value has been assigned to Project_data data member.
627  ///
628  /// Data member Project_data is optional;
629  /// its type is defined as 'typedef list< int > TProject_data'
630  /// @return
631  /// - true, if a value has been assigned.
632  /// - false, otherwise.
633  bool IsSetProject_data(void) const;
634 
635  /// Check if it is safe to call GetProject_data method.
636  ///
637  /// @return
638  /// - true, if the data member is getatable.
639  /// - false, otherwise.
640  bool CanGetProject_data(void) const;
641 
642  /// Reset Project_data data member.
643  void ResetProject_data(void);
644 
645  /// Get the Project_data member data.
646  ///
647  /// @return
648  /// Reference to the member data.
649  const TProject_data& GetProject_data(void) const;
650 
651  /// Assign a value to Project_data data member.
652  ///
653  /// @return
654  /// Reference to the data value.
655  TProject_data& SetProject_data(void);
656 
657  /// Check if a value has been assigned to Quality_check data member.
658  ///
659  /// Data member Quality_check is optional;
660  /// its type is defined as 'typedef int TQuality_check'
661  /// @return
662  /// - true, if a value has been assigned.
663  /// - false, otherwise.
664  bool IsSetQuality_check(void) const;
665 
666  /// Check if it is safe to call GetQuality_check method.
667  ///
668  /// @return
669  /// - true, if the data member is getatable.
670  /// - false, otherwise.
671  bool CanGetQuality_check(void) const;
672 
673  /// Reset Quality_check data member.
674  void ResetQuality_check(void);
675 
676  /// Get the Quality_check member data.
677  ///
678  /// @return
679  /// Copy of the member data.
680  TQuality_check GetQuality_check(void) const;
681 
682  /// Assign a value to Quality_check data member.
683  ///
684  /// @param value
685  /// Value to assign
686  void SetQuality_check(TQuality_check value);
687 
688  /// Assign a value to Quality_check data member.
689  ///
690  /// @return
691  /// Reference to the data value.
692  TQuality_check& SetQuality_check(void);
693 
694  /// Check if a value has been assigned to Confidence data member.
695  ///
696  /// Data member Confidence is optional;
697  /// its type is defined as 'typedef int TConfidence'
698  /// @return
699  /// - true, if a value has been assigned.
700  /// - false, otherwise.
701  bool IsSetConfidence(void) const;
702 
703  /// Check if it is safe to call GetConfidence method.
704  ///
705  /// @return
706  /// - true, if the data member is getatable.
707  /// - false, otherwise.
708  bool CanGetConfidence(void) const;
709 
710  /// Reset Confidence data member.
711  void ResetConfidence(void);
712 
713  /// Get the Confidence member data.
714  ///
715  /// @return
716  /// Copy of the member data.
717  TConfidence GetConfidence(void) const;
718 
719  /// Assign a value to Confidence data member.
720  ///
721  /// @param value
722  /// Value to assign
723  void SetConfidence(TConfidence value);
724 
725  /// Assign a value to Confidence data member.
726  ///
727  /// @return
728  /// Reference to the data value.
729  TConfidence& SetConfidence(void);
730 
731  /// has this variant been validated?
732  /// While a boolean flag offers no subtle distinctions of validation
733  /// methods, occasionally it is only known as a single boolean value
734  /// NOTE: this flag is redundant and should be omitted if more comprehensive
735  /// validation information is present
736  /// Check if a value has been assigned to Other_validation data member.
737  ///
738  /// Data member Other_validation is optional;
739  /// its type is defined as 'typedef bool TOther_validation'
740  /// @return
741  /// - true, if a value has been assigned.
742  /// - false, otherwise.
743  bool IsSetOther_validation(void) const;
744 
745  /// Check if it is safe to call GetOther_validation method.
746  ///
747  /// @return
748  /// - true, if the data member is getatable.
749  /// - false, otherwise.
750  bool CanGetOther_validation(void) const;
751 
752  /// Reset Other_validation data member.
753  void ResetOther_validation(void);
754 
755  /// Get the Other_validation member data.
756  ///
757  /// @return
758  /// Copy of the member data.
759  TOther_validation GetOther_validation(void) const;
760 
761  /// Assign a value to Other_validation data member.
762  ///
763  /// @param value
764  /// Value to assign
765  void SetOther_validation(TOther_validation value);
766 
767  /// Assign a value to Other_validation data member.
768  ///
769  /// @return
770  /// Reference to the data value.
771  TOther_validation& SetOther_validation(void);
772 
773  /// Check if a value has been assigned to Allele_origin data member.
774  ///
775  /// Data member Allele_origin is optional;
776  /// its type is defined as 'typedef int TAllele_origin'
777  /// @return
778  /// - true, if a value has been assigned.
779  /// - false, otherwise.
780  bool IsSetAllele_origin(void) const;
781 
782  /// Check if it is safe to call GetAllele_origin method.
783  ///
784  /// @return
785  /// - true, if the data member is getatable.
786  /// - false, otherwise.
787  bool CanGetAllele_origin(void) const;
788 
789  /// Reset Allele_origin data member.
790  void ResetAllele_origin(void);
791 
792  /// Get the Allele_origin member data.
793  ///
794  /// @return
795  /// Copy of the member data.
796  TAllele_origin GetAllele_origin(void) const;
797 
798  /// Assign a value to Allele_origin data member.
799  ///
800  /// @param value
801  /// Value to assign
802  void SetAllele_origin(TAllele_origin value);
803 
804  /// Assign a value to Allele_origin data member.
805  ///
806  /// @return
807  /// Reference to the data value.
808  TAllele_origin& SetAllele_origin(void);
809 
810  /// Check if a value has been assigned to Allele_state data member.
811  ///
812  /// Data member Allele_state is optional;
813  /// its type is defined as 'typedef int TAllele_state'
814  /// @return
815  /// - true, if a value has been assigned.
816  /// - false, otherwise.
817  bool IsSetAllele_state(void) const;
818 
819  /// Check if it is safe to call GetAllele_state method.
820  ///
821  /// @return
822  /// - true, if the data member is getatable.
823  /// - false, otherwise.
824  bool CanGetAllele_state(void) const;
825 
826  /// Reset Allele_state data member.
827  void ResetAllele_state(void);
828 
829  /// Get the Allele_state member data.
830  ///
831  /// @return
832  /// Copy of the member data.
833  TAllele_state GetAllele_state(void) const;
834 
835  /// Assign a value to Allele_state data member.
836  ///
837  /// @param value
838  /// Value to assign
839  void SetAllele_state(TAllele_state value);
840 
841  /// Assign a value to Allele_state data member.
842  ///
843  /// @return
844  /// Reference to the data value.
845  TAllele_state& SetAllele_state(void);
846 
847  /// NOTE:
848  /// 'allele-frequency' here refers to the minor allele frequency of the
849  /// default population
850  /// Check if a value has been assigned to Allele_frequency data member.
851  ///
852  /// Data member Allele_frequency is optional;
853  /// its type is defined as 'typedef double TAllele_frequency'
854  /// @return
855  /// - true, if a value has been assigned.
856  /// - false, otherwise.
857  bool IsSetAllele_frequency(void) const;
858 
859  /// Check if it is safe to call GetAllele_frequency method.
860  ///
861  /// @return
862  /// - true, if the data member is getatable.
863  /// - false, otherwise.
864  bool CanGetAllele_frequency(void) const;
865 
866  /// Reset Allele_frequency data member.
867  void ResetAllele_frequency(void);
868 
869  /// Get the Allele_frequency member data.
870  ///
871  /// @return
872  /// Copy of the member data.
873  TAllele_frequency GetAllele_frequency(void) const;
874 
875  /// Assign a value to Allele_frequency data member.
876  ///
877  /// @param value
878  /// Value to assign
879  void SetAllele_frequency(TAllele_frequency value);
880 
881  /// Assign a value to Allele_frequency data member.
882  ///
883  /// @return
884  /// Reference to the data value.
885  TAllele_frequency& SetAllele_frequency(void);
886 
887  /// is this variant the ancestral allele?
888  /// Check if a value has been assigned to Is_ancestral_allele data member.
889  ///
890  /// Data member Is_ancestral_allele is optional;
891  /// its type is defined as 'typedef bool TIs_ancestral_allele'
892  /// @return
893  /// - true, if a value has been assigned.
894  /// - false, otherwise.
895  bool IsSetIs_ancestral_allele(void) const;
896 
897  /// Check if it is safe to call GetIs_ancestral_allele method.
898  ///
899  /// @return
900  /// - true, if the data member is getatable.
901  /// - false, otherwise.
902  bool CanGetIs_ancestral_allele(void) const;
903 
904  /// Reset Is_ancestral_allele data member.
905  void ResetIs_ancestral_allele(void);
906 
907  /// Get the Is_ancestral_allele member data.
908  ///
909  /// @return
910  /// Copy of the member data.
911  TIs_ancestral_allele GetIs_ancestral_allele(void) const;
912 
913  /// Assign a value to Is_ancestral_allele data member.
914  ///
915  /// @param value
916  /// Value to assign
917  void SetIs_ancestral_allele(TIs_ancestral_allele value);
918 
919  /// Assign a value to Is_ancestral_allele data member.
920  ///
921  /// @return
922  /// Reference to the data value.
923  TIs_ancestral_allele& SetIs_ancestral_allele(void);
924 
925  /// Reset the whole object
926  virtual void Reset(void);
927 
928 
929 private:
930  // Prohibit copy constructor and assignment operator
933 
934  // data
935  Uint4 m_set_State[1];
939  int m_Effect;
944  list< int > m_Project_data;
952 };
953 
954 /* @} */
955 
956 
957 
958 
959 
960 ///////////////////////////////////////////////////////////
961 ///////////////////// inline methods //////////////////////
962 ///////////////////////////////////////////////////////////
963 inline
965 {
966  return ((m_set_State[0] & 0x3) != 0);
967 }
968 
969 inline
971 {
972  return IsSetVersion();
973 }
974 
975 inline
977 {
978  m_Version = 0;
979  m_set_State[0] &= ~0x3;
980 }
981 
982 inline
984 {
985  if (!CanGetVersion()) {
986  ThrowUnassigned(0);
987  }
988  return m_Version;
989 }
990 
991 inline
993 {
994  m_Version = value;
995  m_set_State[0] |= 0x3;
996 }
997 
998 inline
1000 {
1001 #ifdef _DEBUG
1002  if (!IsSetVersion()) {
1003  memset(&m_Version,UnassignedByte(),sizeof(m_Version));
1004  }
1005 #endif
1006  m_set_State[0] |= 0x1;
1007  return m_Version;
1008 }
1009 
1010 inline
1012 {
1013  return ((m_set_State[0] & 0xc) != 0);
1014 }
1015 
1016 inline
1018 {
1019  return IsSetResource_link();
1020 }
1021 
1022 inline
1024 {
1026  m_set_State[0] &= ~0xc;
1027 }
1028 
1029 inline
1031 {
1032  if (!CanGetResource_link()) {
1033  ThrowUnassigned(1);
1034  }
1035  return m_Resource_link;
1036 }
1037 
1038 inline
1040 {
1042  m_set_State[0] |= 0xc;
1043 }
1044 
1045 inline
1047 {
1048 #ifdef _DEBUG
1049  if (!IsSetResource_link()) {
1050  memset(&m_Resource_link,UnassignedByte(),sizeof(m_Resource_link));
1051  }
1052 #endif
1053  m_set_State[0] |= 0x4;
1054  return m_Resource_link;
1055 }
1056 
1057 inline
1059 {
1060  return ((m_set_State[0] & 0x30) != 0);
1061 }
1062 
1063 inline
1065 {
1066  return IsSetGene_location();
1067 }
1068 
1069 inline
1071 {
1073  m_set_State[0] &= ~0x30;
1074 }
1075 
1076 inline
1078 {
1079  if (!CanGetGene_location()) {
1080  ThrowUnassigned(2);
1081  }
1082  return m_Gene_location;
1083 }
1084 
1085 inline
1087 {
1089  m_set_State[0] |= 0x30;
1090 }
1091 
1092 inline
1094 {
1095 #ifdef _DEBUG
1096  if (!IsSetGene_location()) {
1097  memset(&m_Gene_location,UnassignedByte(),sizeof(m_Gene_location));
1098  }
1099 #endif
1100  m_set_State[0] |= 0x10;
1101  return m_Gene_location;
1102 }
1103 
1104 inline
1106 {
1107  return ((m_set_State[0] & 0xc0) != 0);
1108 }
1109 
1110 inline
1112 {
1113  return IsSetEffect();
1114 }
1115 
1116 inline
1118 {
1119  m_Effect = (EEffect)(0);
1120  m_set_State[0] &= ~0xc0;
1121 }
1122 
1123 inline
1125 {
1126  if (!CanGetEffect()) {
1127  ThrowUnassigned(3);
1128  }
1129  return m_Effect;
1130 }
1131 
1132 inline
1134 {
1135  m_Effect = value;
1136  m_set_State[0] |= 0xc0;
1137 }
1138 
1139 inline
1141 {
1142 #ifdef _DEBUG
1143  if (!IsSetEffect()) {
1144  memset(&m_Effect,UnassignedByte(),sizeof(m_Effect));
1145  }
1146 #endif
1147  m_set_State[0] |= 0x40;
1148  return m_Effect;
1149 }
1150 
1151 inline
1153 {
1154  return ((m_set_State[0] & 0x300) != 0);
1155 }
1156 
1157 inline
1159 {
1160  return IsSetMapping();
1161 }
1162 
1163 inline
1165 {
1166  m_Mapping = (EMapping)(0);
1167  m_set_State[0] &= ~0x300;
1168 }
1169 
1170 inline
1172 {
1173  if (!CanGetMapping()) {
1174  ThrowUnassigned(4);
1175  }
1176  return m_Mapping;
1177 }
1178 
1179 inline
1181 {
1182  m_Mapping = value;
1183  m_set_State[0] |= 0x300;
1184 }
1185 
1186 inline
1188 {
1189 #ifdef _DEBUG
1190  if (!IsSetMapping()) {
1191  memset(&m_Mapping,UnassignedByte(),sizeof(m_Mapping));
1192  }
1193 #endif
1194  m_set_State[0] |= 0x100;
1195  return m_Mapping;
1196 }
1197 
1198 inline
1200 {
1201  return ((m_set_State[0] & 0xc00) != 0);
1202 }
1203 
1204 inline
1206 {
1207  return IsSetMap_weight();
1208 }
1209 
1210 inline
1212 {
1213  m_Map_weight = (EMap_weight)(0);
1214  m_set_State[0] &= ~0xc00;
1215 }
1216 
1217 inline
1219 {
1220  if (!CanGetMap_weight()) {
1221  ThrowUnassigned(5);
1222  }
1223  return m_Map_weight;
1224 }
1225 
1226 inline
1228 {
1229  m_Map_weight = value;
1230  m_set_State[0] |= 0xc00;
1231 }
1232 
1233 inline
1235 {
1236 #ifdef _DEBUG
1237  if (!IsSetMap_weight()) {
1238  memset(&m_Map_weight,UnassignedByte(),sizeof(m_Map_weight));
1239  }
1240 #endif
1241  m_set_State[0] |= 0x400;
1242  return m_Map_weight;
1243 }
1244 
1245 inline
1247 {
1248  return ((m_set_State[0] & 0x3000) != 0);
1249 }
1250 
1251 inline
1253 {
1255 }
1256 
1257 inline
1259 {
1261  m_set_State[0] &= ~0x3000;
1262 }
1263 
1264 inline
1266 {
1268  ThrowUnassigned(6);
1269  }
1271 }
1272 
1273 inline
1275 {
1277  m_set_State[0] |= 0x3000;
1278 }
1279 
1280 inline
1282 {
1283 #ifdef _DEBUG
1286  }
1287 #endif
1288  m_set_State[0] |= 0x1000;
1290 }
1291 
1292 inline
1294 {
1295  return ((m_set_State[0] & 0xc000) != 0);
1296 }
1297 
1298 inline
1300 {
1301  return IsSetGenotype();
1302 }
1303 
1304 inline
1306 {
1307  m_Genotype = (EGenotype)(0);
1308  m_set_State[0] &= ~0xc000;
1309 }
1310 
1311 inline
1313 {
1314  if (!CanGetGenotype()) {
1315  ThrowUnassigned(7);
1316  }
1317  return m_Genotype;
1318 }
1319 
1320 inline
1322 {
1323  m_Genotype = value;
1324  m_set_State[0] |= 0xc000;
1325 }
1326 
1327 inline
1329 {
1330 #ifdef _DEBUG
1331  if (!IsSetGenotype()) {
1332  memset(&m_Genotype,UnassignedByte(),sizeof(m_Genotype));
1333  }
1334 #endif
1335  m_set_State[0] |= 0x4000;
1336  return m_Genotype;
1337 }
1338 
1339 inline
1341 {
1342  return ((m_set_State[0] & 0x30000) != 0);
1343 }
1344 
1345 inline
1347 {
1348  return true;
1349 }
1350 
1351 inline
1353 {
1354  return m_Project_data;
1355 }
1356 
1357 inline
1359 {
1360  m_set_State[0] |= 0x10000;
1361  return m_Project_data;
1362 }
1363 
1364 inline
1366 {
1367  return ((m_set_State[0] & 0xc0000) != 0);
1368 }
1369 
1370 inline
1372 {
1373  return IsSetQuality_check();
1374 }
1375 
1376 inline
1378 {
1380  m_set_State[0] &= ~0xc0000;
1381 }
1382 
1383 inline
1385 {
1386  if (!CanGetQuality_check()) {
1387  ThrowUnassigned(9);
1388  }
1389  return m_Quality_check;
1390 }
1391 
1392 inline
1394 {
1396  m_set_State[0] |= 0xc0000;
1397 }
1398 
1399 inline
1401 {
1402 #ifdef _DEBUG
1403  if (!IsSetQuality_check()) {
1404  memset(&m_Quality_check,UnassignedByte(),sizeof(m_Quality_check));
1405  }
1406 #endif
1407  m_set_State[0] |= 0x40000;
1408  return m_Quality_check;
1409 }
1410 
1411 inline
1413 {
1414  return ((m_set_State[0] & 0x300000) != 0);
1415 }
1416 
1417 inline
1419 {
1420  return IsSetConfidence();
1421 }
1422 
1423 inline
1425 {
1426  m_Confidence = (EConfidence)(0);
1427  m_set_State[0] &= ~0x300000;
1428 }
1429 
1430 inline
1432 {
1433  if (!CanGetConfidence()) {
1434  ThrowUnassigned(10);
1435  }
1436  return m_Confidence;
1437 }
1438 
1439 inline
1441 {
1442  m_Confidence = value;
1443  m_set_State[0] |= 0x300000;
1444 }
1445 
1446 inline
1448 {
1449 #ifdef _DEBUG
1450  if (!IsSetConfidence()) {
1451  memset(&m_Confidence,UnassignedByte(),sizeof(m_Confidence));
1452  }
1453 #endif
1454  m_set_State[0] |= 0x100000;
1455  return m_Confidence;
1456 }
1457 
1458 inline
1460 {
1461  return ((m_set_State[0] & 0xc00000) != 0);
1462 }
1463 
1464 inline
1466 {
1467  return IsSetOther_validation();
1468 }
1469 
1470 inline
1472 {
1473  m_Other_validation = 0;
1474  m_set_State[0] &= ~0xc00000;
1475 }
1476 
1477 inline
1479 {
1480  if (!CanGetOther_validation()) {
1481  ThrowUnassigned(11);
1482  }
1483  return m_Other_validation;
1484 }
1485 
1486 inline
1488 {
1490  m_set_State[0] |= 0xc00000;
1491 }
1492 
1493 inline
1495 {
1496 #ifdef _DEBUG
1497  if (!IsSetOther_validation()) {
1499  }
1500 #endif
1501  m_set_State[0] |= 0x400000;
1502  return m_Other_validation;
1503 }
1504 
1505 inline
1507 {
1508  return ((m_set_State[0] & 0x3000000) != 0);
1509 }
1510 
1511 inline
1513 {
1514  return IsSetAllele_origin();
1515 }
1516 
1517 inline
1519 {
1521  m_set_State[0] &= ~0x3000000;
1522 }
1523 
1524 inline
1526 {
1527  if (!CanGetAllele_origin()) {
1528  ThrowUnassigned(12);
1529  }
1530  return m_Allele_origin;
1531 }
1532 
1533 inline
1535 {
1537  m_set_State[0] |= 0x3000000;
1538 }
1539 
1540 inline
1542 {
1543 #ifdef _DEBUG
1544  if (!IsSetAllele_origin()) {
1545  memset(&m_Allele_origin,UnassignedByte(),sizeof(m_Allele_origin));
1546  }
1547 #endif
1548  m_set_State[0] |= 0x1000000;
1549  return m_Allele_origin;
1550 }
1551 
1552 inline
1554 {
1555  return ((m_set_State[0] & 0xc000000) != 0);
1556 }
1557 
1558 inline
1560 {
1561  return IsSetAllele_state();
1562 }
1563 
1564 inline
1566 {
1568  m_set_State[0] &= ~0xc000000;
1569 }
1570 
1571 inline
1573 {
1574  if (!CanGetAllele_state()) {
1575  ThrowUnassigned(13);
1576  }
1577  return m_Allele_state;
1578 }
1579 
1580 inline
1582 {
1584  m_set_State[0] |= 0xc000000;
1585 }
1586 
1587 inline
1589 {
1590 #ifdef _DEBUG
1591  if (!IsSetAllele_state()) {
1592  memset(&m_Allele_state,UnassignedByte(),sizeof(m_Allele_state));
1593  }
1594 #endif
1595  m_set_State[0] |= 0x4000000;
1596  return m_Allele_state;
1597 }
1598 
1599 inline
1601 {
1602  return ((m_set_State[0] & 0x30000000) != 0);
1603 }
1604 
1605 inline
1607 {
1608  return IsSetAllele_frequency();
1609 }
1610 
1611 inline
1613 {
1614  m_Allele_frequency = 0;
1615  m_set_State[0] &= ~0x30000000;
1616 }
1617 
1618 inline
1620 {
1621  if (!CanGetAllele_frequency()) {
1622  ThrowUnassigned(14);
1623  }
1624  return m_Allele_frequency;
1625 }
1626 
1627 inline
1629 {
1631  m_set_State[0] |= 0x30000000;
1632 }
1633 
1634 inline
1636 {
1637 #ifdef _DEBUG
1638  if (!IsSetAllele_frequency()) {
1640  }
1641 #endif
1642  m_set_State[0] |= 0x10000000;
1643  return m_Allele_frequency;
1644 }
1645 
1646 inline
1648 {
1649  return ((m_set_State[0] & 0xc0000000) != 0);
1650 }
1651 
1652 inline
1654 {
1655  return IsSetIs_ancestral_allele();
1656 }
1657 
1658 inline
1660 {
1662  m_set_State[0] &= ~0xc0000000;
1663 }
1664 
1665 inline
1667 {
1668  if (!CanGetIs_ancestral_allele()) {
1669  ThrowUnassigned(15);
1670  }
1671  return m_Is_ancestral_allele;
1672 }
1673 
1674 inline
1676 {
1678  m_set_State[0] |= 0xc0000000;
1679 }
1680 
1681 inline
1683 {
1684 #ifdef _DEBUG
1685  if (!IsSetIs_ancestral_allele()) {
1687  }
1688 #endif
1689  m_set_State[0] |= 0x40000000;
1690  return m_Is_ancestral_allele;
1691 }
1692 
1693 ///////////////////////////////////////////////////////////
1694 ////////////////// end of inline methods //////////////////
1695 ///////////////////////////////////////////////////////////
1696 
1697 
1698 
1699 
1700 
1701 END_objects_SCOPE // namespace ncbi::objects::
1702 
1704 
1705 
1706 #endif // OBJECTS_SEQFEAT_VARIANTPROPERTIES_BASE_HPP
Base class for all serializable objects.
Definition: serialbase.hpp:150
Historically, the dbSNP definitions document data structures used in the processing and annotation of...
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_SEQFEAT_EXPORT
Definition: ncbi_export.h:768
void ResetResource_link(void)
Reset Resource_link data member.
TMapping & SetMapping(void)
Assign a value to Mapping data member.
bool IsSetFrequency_based_validation(void) const
Check if a value has been assigned to Frequency_based_validation data member.
bool IsSetResource_link(void) const
Check if a value has been assigned to Resource_link data member.
TFrequency_based_validation GetFrequency_based_validation(void) const
Get the Frequency_based_validation member data.
bool CanGetIs_ancestral_allele(void) const
Check if it is safe to call GetIs_ancestral_allele method.
void ResetGene_location(void)
Reset Gene_location data member.
TEffect & SetEffect(void)
Assign a value to Effect data member.
TAllele_state & SetAllele_state(void)
Assign a value to Allele_state data member.
void ResetOther_validation(void)
Reset Other_validation data member.
TAllele_state GetAllele_state(void) const
Get the Allele_state member data.
bool IsSetAllele_state(void) const
Check if a value has been assigned to Allele_state data member.
TGenotype GetGenotype(void) const
Get the Genotype member data.
bool IsSetMapping(void) const
Check if a value has been assigned to Mapping data member.
void ResetAllele_state(void)
Reset Allele_state data member.
bool CanGetMap_weight(void) const
Check if it is safe to call GetMap_weight method.
void ResetAllele_frequency(void)
Reset Allele_frequency data member.
void ResetAllele_origin(void)
Reset Allele_origin data member.
bool IsSetAllele_origin(void) const
Check if a value has been assigned to Allele_origin data member.
TIs_ancestral_allele GetIs_ancestral_allele(void) const
Get the Is_ancestral_allele member data.
TEffect GetEffect(void) const
Get the Effect member data.
bool IsSetVersion(void) const
Check if a value has been assigned to Version data member.
bool CanGetGene_location(void) const
Check if it is safe to call GetGene_location method.
TMapping GetMapping(void) const
Get the Mapping member data.
bool IsSetMap_weight(void) const
Check if a value has been assigned to Map_weight data member.
bool CanGetQuality_check(void) const
Check if it is safe to call GetQuality_check method.
void ResetMapping(void)
Reset Mapping data member.
bool CanGetOther_validation(void) const
Check if it is safe to call GetOther_validation method.
bool CanGetFrequency_based_validation(void) const
Check if it is safe to call GetFrequency_based_validation method.
void ResetMap_weight(void)
Reset Map_weight data member.
CVariantProperties_Base & operator=(const CVariantProperties_Base &)
void ResetConfidence(void)
Reset Confidence data member.
bool CanGetAllele_origin(void) const
Check if it is safe to call GetAllele_origin method.
bool CanGetAllele_state(void) const
Check if it is safe to call GetAllele_state method.
EResource_link
NOTE: The format for most of these values is as an integer Unless otherwise noted,...
TResource_link GetResource_link(void) const
Get the Resource_link member data.
TOther_validation GetOther_validation(void) const
Get the Other_validation member data.
void ResetFrequency_based_validation(void)
Reset Frequency_based_validation data member.
bool CanGetAllele_frequency(void) const
Check if it is safe to call GetAllele_frequency method.
TConfidence & SetConfidence(void)
Assign a value to Confidence data member.
bool CanGetProject_data(void) const
Check if it is safe to call GetProject_data method.
TResource_link & SetResource_link(void)
Assign a value to Resource_link data member.
void ResetIs_ancestral_allele(void)
Reset Is_ancestral_allele data member.
void ResetEffect(void)
Reset Effect data member.
void ResetVersion(void)
Reset Version data member.
EAllele_origin
origin of this allele, if known note that these are powers-of-two, and represent bits; thus,...
TOther_validation & SetOther_validation(void)
Assign a value to Other_validation data member.
bool IsSetIs_ancestral_allele(void) const
is this variant the ancestral allele? Check if a value has been assigned to Is_ancestral_allele data ...
bool IsSetOther_validation(void) const
has this variant been validated? While a boolean flag offers no subtle distinctions of validation met...
EMap_weight
map-weight captures specificity of placement NOTE: This is *NOT* a bitfield
TAllele_frequency & SetAllele_frequency(void)
Assign a value to Allele_frequency data member.
const TProject_data & GetProject_data(void) const
Get the Project_data member data.
TIs_ancestral_allele & SetIs_ancestral_allele(void)
Assign a value to Is_ancestral_allele data member.
TGenotype & SetGenotype(void)
Assign a value to Genotype data member.
bool CanGetEffect(void) const
Check if it is safe to call GetEffect method.
TGene_location & SetGene_location(void)
Assign a value to Gene_location data member.
TAllele_frequency GetAllele_frequency(void) const
Get the Allele_frequency member data.
Tparent::CMemberIndex< E_memberIndex, 17 > TmemberIndex
TProject_data & SetProject_data(void)
Assign a value to Project_data data member.
bool IsSetProject_data(void) const
project IDs are IDs from BioProjects in order to report information about project relationships,...
TMap_weight GetMap_weight(void) const
Get the Map_weight member data.
void ResetQuality_check(void)
Reset Quality_check data member.
bool CanGetResource_link(void) const
Check if it is safe to call GetResource_link method.
TVersion GetVersion(void) const
Get the Version member data.
bool CanGetGenotype(void) const
Check if it is safe to call GetGenotype method.
TQuality_check GetQuality_check(void) const
Get the Quality_check member data.
bool IsSetEffect(void) const
Check if a value has been assigned to Effect data member.
bool IsSetGenotype(void) const
Check if a value has been assigned to Genotype data member.
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
TVersion & SetVersion(void)
Assign a value to Version data member.
EAllele_state
observed allele state, if known NOTE: THIS IS NOT A BITFIELD!
bool IsSetQuality_check(void) const
Check if a value has been assigned to Quality_check data member.
void ResetGenotype(void)
Reset Genotype data member.
TConfidence GetConfidence(void) const
Get the Confidence member data.
bool CanGetMapping(void) const
Check if it is safe to call GetMapping method.
TFrequency_based_validation & SetFrequency_based_validation(void)
Assign a value to Frequency_based_validation data member.
bool IsSetAllele_frequency(void) const
NOTE: 'allele-frequency' here refers to the minor allele frequency of the default population Check if...
TGene_location GetGene_location(void) const
Get the Gene_location member data.
bool IsSetGene_location(void) const
Check if a value has been assigned to Gene_location data member.
TAllele_origin GetAllele_origin(void) const
Get the Allele_origin member data.
TAllele_origin & SetAllele_origin(void)
Assign a value to Allele_origin data member.
TMap_weight & SetMap_weight(void)
Assign a value to Map_weight data member.
bool IsSetConfidence(void) const
Check if a value has been assigned to Confidence data member.
CVariantProperties_Base(const CVariantProperties_Base &)
TQuality_check & SetQuality_check(void)
Assign a value to Quality_check data member.
bool CanGetConfidence(void) const
Check if it is safe to call GetConfidence method.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Fri May 24 14:50:31 2024 by modify_doxy.py rev. 669887