41 #ifndef OBJECTS_SEQFEAT_VARIANTPROPERTIES_BASE_HPP
42 #define OBJECTS_SEQFEAT_VARIANTPROPERTIES_BASE_HPP
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
133 eResource_link_preserved = 1,
134 eResource_link_provisional = 2,
135 eResource_link_has3D = 4,
136 eResource_link_submitterLinkout = 8,
137 eResource_link_clinical = 16,
138 eResource_link_genotypeKit = 32
145 eGene_location_in_gene = 1,
146 eGene_location_near_gene_5 = 2,
147 eGene_location_near_gene_3 = 4,
148 eGene_location_intron = 8,
149 eGene_location_donor = 16,
150 eGene_location_acceptor = 32,
151 eGene_location_utr_5 = 64,
152 eGene_location_utr_3 = 128,
153 eGene_location_in_start_codon = 256,
154 eGene_location_in_stop_codon = 512,
155 eGene_location_intergenic = 1024,
156 eGene_location_conserved_noncoding = 2048
163 eEffect_no_change = 0,
164 eEffect_synonymous = 1,
165 eEffect_nonsense = 2,
166 eEffect_missense = 4,
167 eEffect_frameshift = 8,
168 eEffect_up_regulator = 16,
169 eEffect_down_regulator = 32,
170 eEffect_methylation = 64,
171 eEffect_stop_gain = 128,
172 eEffect_stop_loss = 256
179 eMapping_has_other_snp = 1,
180 eMapping_has_assembly_conflict = 2,
181 eMapping_is_assembly_specific = 4
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
200 eFrequency_based_validation_is_mutation = 1,
201 eFrequency_based_validation_above_5pct_all = 2,
202 eFrequency_based_validation_above_5pct_1plus = 4,
203 eFrequency_based_validation_validated = 8,
204 eFrequency_based_validation_above_1pct_all = 16,
205 eFrequency_based_validation_above_1pct_1plus = 32
212 eGenotype_in_haplotype_set = 1,
213 eGenotype_has_genotypes = 2
220 eQuality_check_contig_allele_missing = 1,
221 eQuality_check_withdrawn_by_submitter = 2,
222 eQuality_check_non_overlapping_alleles = 4,
223 eQuality_check_strain_specific = 8,
224 eQuality_check_genotype_conflict = 16
231 eConfidence_unknown = 0,
232 eConfidence_likely_artifact = 1,
233 eConfidence_other = 255
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
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
302 e_frequency_based_validation,
311 e_is_ancestral_allele
325 bool IsSetVersion(
void)
const;
332 bool CanGetVersion(
void)
const;
335 void ResetVersion(
void);
362 bool IsSetResource_link(
void)
const;
369 bool CanGetResource_link(
void)
const;
372 void ResetResource_link(
void);
399 bool IsSetGene_location(
void)
const;
406 bool CanGetGene_location(
void)
const;
409 void ResetGene_location(
void);
436 bool IsSetEffect(
void)
const;
443 bool CanGetEffect(
void)
const;
446 void ResetEffect(
void);
473 bool IsSetMapping(
void)
const;
480 bool CanGetMapping(
void)
const;
483 void ResetMapping(
void);
510 bool IsSetMap_weight(
void)
const;
517 bool CanGetMap_weight(
void)
const;
520 void ResetMap_weight(
void);
547 bool IsSetFrequency_based_validation(
void)
const;
554 bool CanGetFrequency_based_validation(
void)
const;
557 void ResetFrequency_based_validation(
void);
584 bool IsSetGenotype(
void)
const;
591 bool CanGetGenotype(
void)
const;
594 void ResetGenotype(
void);
633 bool IsSetProject_data(
void)
const;
640 bool CanGetProject_data(
void)
const;
643 void ResetProject_data(
void);
664 bool IsSetQuality_check(
void)
const;
671 bool CanGetQuality_check(
void)
const;
674 void ResetQuality_check(
void);
701 bool IsSetConfidence(
void)
const;
708 bool CanGetConfidence(
void)
const;
711 void ResetConfidence(
void);
743 bool IsSetOther_validation(
void)
const;
750 bool CanGetOther_validation(
void)
const;
753 void ResetOther_validation(
void);
780 bool IsSetAllele_origin(
void)
const;
787 bool CanGetAllele_origin(
void)
const;
790 void ResetAllele_origin(
void);
817 bool IsSetAllele_state(
void)
const;
824 bool CanGetAllele_state(
void)
const;
827 void ResetAllele_state(
void);
857 bool IsSetAllele_frequency(
void)
const;
864 bool CanGetAllele_frequency(
void)
const;
867 void ResetAllele_frequency(
void);
895 bool IsSetIs_ancestral_allele(
void)
const;
902 bool CanGetIs_ancestral_allele(
void)
const;
905 void ResetIs_ancestral_allele(
void);
926 virtual void Reset(
void);
Base class for all serializable objects.
Historically, the dbSNP definitions document data structures used in the processing and annotation of...
static char UnassignedByte(void)
void ThrowUnassigned(TMemberIndex index) const
#define ENUM_METHOD_NAME(EnumName)
uint32_t Uint4
4-byte (32-bit) unsigned integer
#define END_NCBI_SCOPE
End previously defined NCBI scope.
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
#define NCBI_SEQFEAT_EXPORT
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.
list< int > TProject_data
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.
EFrequency_based_validation
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.
list< int > m_Project_data
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,...
double m_Allele_frequency
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.
int TFrequency_based_validation
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.
DECLARE_INTERNAL_TYPE_INFO()
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.
int m_Frequency_based_validation
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.
bool m_Is_ancestral_allele
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...
bool TIs_ancestral_allele
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