NCBI C++ ToolKit
PC_ResultType_.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id$
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file PC_ResultType_.hpp
29 /// Data storage class.
30 ///
31 /// This file was generated by application DATATOOL
32 /// using the following specifications:
33 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcassay2/pcassay2.asn">pcassay2.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcassay2/pcassay2.def">pcassay2.def</a>
36 ///
37 /// ATTENTION:
38 /// Don't edit or commit this file into CVS as this file will
39 /// be overridden (by DATATOOL) without warning!
40 
41 #ifndef OBJECTS_PCASSAY2_PC_RESULTTYPE_BASE_HPP
42 #define OBJECTS_PCASSAY2_PC_RESULTTYPE_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 #ifndef BEGIN_pcassay2_SCOPE
60 # define BEGIN_pcassay2_SCOPE BEGIN_SCOPE(pcassay2)
61 # define END_pcassay2_SCOPE END_SCOPE(pcassay2)
62 #endif
63 BEGIN_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
64 
65 
66 // forward declarations
68 class CPC_IntegerMinMax;
69 class CPC_RealMinMax;
70 
71 
72 // generated classes
73 
74 
75 /** @addtogroup dataspec_NCBI_PCAssay2
76  *
77  * @{
78  */
79 
80 /////////////////////////////////////////////////////////////////////////////
81 /// Definition of Allowed Result Types for a given Assay
82 ///
83 /// CPC_ResultType_Base --
84 ///
85 
87 {
89 public:
90  // constructor
92  // destructor
93  virtual ~CPC_ResultType_Base(void);
94 
95  // type info
97 
98  /// Result Data Type and Validation Information
99  /// Result Data Type
100  enum EType {
101  eType_float = 1,
102  eType_int = 2,
103  eType_bool = 3,
104  eType_string = 4
105  };
106 
107  /// Access to EType's attributes (values, names) as defined in spec
108  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EType)(void);
109 
110  /////////////////////////////////////////////////////////////////////////////
111  /// Allowed Values, used for validating incoming data
112  /// If type is "float"
113  ///
114  /// C_Constraints --
115  ///
116 
117  class C_Constraints : public CSerialObject
118  {
120  public:
121  // constructor
123  // destructor
125 
126  // type info
128 
129 
130  /// Choice variants.
131  enum E_Choice {
132  e_not_set = 0, ///< No variant selected
133  e_Fset, ///< Allowed values must be equal to one of these
134  e_Fmin, ///< Allowed values (x) must be [ fmin <= x ]
135  e_Fmax, ///< Allowed values (x) must be [ x <= fmax ]
136  e_Frange, ///< Minimum/Maximum Range [ min <= x <= max ]
137  e_Iset, ///< If type is "int" Allowed values must be equal to one of these
138  e_Imin, ///< Allowed values (x) must be [ imin <= x ]
139  e_Imax, ///< Allowed values (x) must be [ x <= imax ]
140  e_Irange, ///< Minimum/Maximum Range [ min <= x <= max ]
141  e_Sset ///< If type is "string" Allowed values must be equal to one of these
142  };
143  /// Maximum+1 value of the choice variant enumerator.
145  e_MaxChoice = 10 ///< == e_Sset+1
146  };
147 
148  /// Reset the whole object
149  void Reset(void);
150 
151  /// Reset the selection (set it to e_not_set).
152  void ResetSelection(void);
153 
154  /// Which variant is currently selected.
155  ///
156  /// @return
157  /// Choice state enumerator.
158  E_Choice Which(void) const;
159 
160  /// Verify selection, throw exception if it differs from the expected.
161  ///
162  /// @param index
163  /// Expected selection.
164  void CheckSelected(E_Choice index) const;
165 
166  /// Throw 'InvalidSelection' exception.
167  ///
168  /// @param index
169  /// Expected selection.
170  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
171 
172  /// Retrieve selection name (for diagnostic purposes).
173  ///
174  /// @param index
175  /// One of possible selection states.
176  /// @return
177  /// Name string.
178  static string SelectionName(E_Choice index);
179 
180  /// Select the requested variant if needed.
181  ///
182  /// @param index
183  /// New selection state.
184  /// @param reset
185  /// Flag that defines the resetting of the variant data. The data will
186  /// be reset if either the current selection differs from the new one,
187  /// or the flag is set to eDoResetVariant.
189  /// Select the requested variant if needed,
190  /// allocating CObject variants from memory pool.
191  void Select(E_Choice index,
192  EResetVariant reset,
193  CObjectMemoryPool* pool);
194 
195  // types
196  typedef list< double > TFset;
197  typedef double TFmin;
198  typedef double TFmax;
200  typedef list< int > TIset;
201  typedef int TImin;
202  typedef int TImax;
204  typedef list< string > TSset;
205 
206  // getters
207  // setters
208 
209 
210  /// Check if variant Fset is selected.
211  ///
212  /// Fset type is defined as 'typedef list< double > TFset'.
213  /// @return
214  /// - true, if the variant is selected.
215  /// - false, otherwise.
216  bool IsFset(void) const;
217 
218  /// Get the variant data.
219  ///
220  /// @return
221  /// Reference to the data.
222  const TFset& GetFset(void) const;
223 
224  /// Select the variant.
225  ///
226  /// @return
227  /// Reference to the variant data.
228  TFset& SetFset(void);
229 
230 
231  /// Check if variant Fmin is selected.
232  ///
233  /// Fmin type is defined as 'typedef double TFmin'.
234  /// @return
235  /// - true, if the variant is selected.
236  /// - false, otherwise.
237  bool IsFmin(void) const;
238 
239  /// Get the variant data.
240  ///
241  /// @return
242  /// Copy of the variant data.
243  TFmin GetFmin(void) const;
244 
245  /// Select the variant.
246  ///
247  /// @return
248  /// Reference to the variant data.
249  TFmin& SetFmin(void);
250 
251  /// Select the variant and set its data.
252  ///
253  /// @param value
254  /// Variant data.
256 
257 
258  /// Check if variant Fmax is selected.
259  ///
260  /// Fmax type is defined as 'typedef double TFmax'.
261  /// @return
262  /// - true, if the variant is selected.
263  /// - false, otherwise.
264  bool IsFmax(void) const;
265 
266  /// Get the variant data.
267  ///
268  /// @return
269  /// Copy of the variant data.
270  TFmax GetFmax(void) const;
271 
272  /// Select the variant.
273  ///
274  /// @return
275  /// Reference to the variant data.
276  TFmax& SetFmax(void);
277 
278  /// Select the variant and set its data.
279  ///
280  /// @param value
281  /// Variant data.
283 
284 
285  /// Check if variant Frange is selected.
286  ///
287  /// Frange type is defined as 'typedef CPC_RealMinMax TFrange'.
288  /// @return
289  /// - true, if the variant is selected.
290  /// - false, otherwise.
291  bool IsFrange(void) const;
292 
293  /// Get the variant data.
294  ///
295  /// @return
296  /// Reference to the data.
297  const TFrange& GetFrange(void) const;
298 
299  /// Select the variant.
300  ///
301  /// @return
302  /// Reference to the variant data.
304  /// Select the variant and set its data.
305  ///
306  /// @param value
307  /// Reference to the data.
309 
310 
311  /// Check if variant Iset is selected.
312  ///
313  /// Iset type is defined as 'typedef list< int > TIset'.
314  /// @return
315  /// - true, if the variant is selected.
316  /// - false, otherwise.
317  bool IsIset(void) const;
318 
319  /// Get the variant data.
320  ///
321  /// @return
322  /// Reference to the data.
323  const TIset& GetIset(void) const;
324 
325  /// Select the variant.
326  ///
327  /// @return
328  /// Reference to the variant data.
329  TIset& SetIset(void);
330 
331 
332  /// Check if variant Imin is selected.
333  ///
334  /// Imin type is defined as 'typedef int TImin'.
335  /// @return
336  /// - true, if the variant is selected.
337  /// - false, otherwise.
338  bool IsImin(void) const;
339 
340  /// Get the variant data.
341  ///
342  /// @return
343  /// Copy of the variant data.
344  TImin GetImin(void) const;
345 
346  /// Select the variant.
347  ///
348  /// @return
349  /// Reference to the variant data.
350  TImin& SetImin(void);
351 
352  /// Select the variant and set its data.
353  ///
354  /// @param value
355  /// Variant data.
357 
358 
359  /// Check if variant Imax is selected.
360  ///
361  /// Imax type is defined as 'typedef int TImax'.
362  /// @return
363  /// - true, if the variant is selected.
364  /// - false, otherwise.
365  bool IsImax(void) const;
366 
367  /// Get the variant data.
368  ///
369  /// @return
370  /// Copy of the variant data.
371  TImax GetImax(void) const;
372 
373  /// Select the variant.
374  ///
375  /// @return
376  /// Reference to the variant data.
377  TImax& SetImax(void);
378 
379  /// Select the variant and set its data.
380  ///
381  /// @param value
382  /// Variant data.
384 
385 
386  /// Check if variant Irange is selected.
387  ///
388  /// Irange type is defined as 'typedef CPC_IntegerMinMax TIrange'.
389  /// @return
390  /// - true, if the variant is selected.
391  /// - false, otherwise.
392  bool IsIrange(void) const;
393 
394  /// Get the variant data.
395  ///
396  /// @return
397  /// Reference to the data.
398  const TIrange& GetIrange(void) const;
399 
400  /// Select the variant.
401  ///
402  /// @return
403  /// Reference to the variant data.
405  /// Select the variant and set its data.
406  ///
407  /// @param value
408  /// Reference to the data.
410 
411 
412  /// Check if variant Sset is selected.
413  ///
414  /// Sset type is defined as 'typedef list< string > TSset'.
415  /// @return
416  /// - true, if the variant is selected.
417  /// - false, otherwise.
418  bool IsSset(void) const;
419 
420  /// Get the variant data.
421  ///
422  /// @return
423  /// Reference to the data.
424  const TSset& GetSset(void) const;
425 
426  /// Select the variant.
427  ///
428  /// @return
429  /// Reference to the variant data.
430  TSset& SetSset(void);
431 
432 
433  private:
434  // copy constructor and assignment operator
437  // choice state
439  // helper methods
440  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
441 
442  static const char* const sm_SelectionNames[];
443  // data
444  union {
445  NCBI_NS_NCBI::CUnionBuffer<TFset> m_Fset;
448  NCBI_NS_NCBI::CUnionBuffer<TIset> m_Iset;
451  NCBI_NS_NCBI::CUnionBuffer<TSset> m_Sset;
452  NCBI_NS_NCBI::CSerialObject *m_object;
453  };
454  };
455  /// Unit information provides the units for the values reported for this TID. For example, if the values
456  /// reported for this TID are a concentration, e.g., micro-molar, setting the unit "um" allows PubChem to
457  /// know that the value, e.g., "1.3", is actually "1.3 uM". This also allows PubChem to properly report the
458  /// units when displaying the reported values for this TID. If the enumerated units provided below are
459  /// insufficient, you may represent the units as a string in the optional "sunit" field (see below).
460  /// Units for Value
461  enum EUnit {
462  eUnit_ppt = 1, ///< Parts per Thousand
463  eUnit_ppm = 2, ///< Parts per Million
464  eUnit_ppb = 3, ///< Parts per Billion
465  eUnit_mm = 4, ///< milliM
466  eUnit_um = 5, ///< microM
467  eUnit_nm = 6, ///< nanoM
468  eUnit_pm = 7, ///< picoM
469  eUnit_fm = 8, ///< femtoM
470  eUnit_mgml = 9, ///< milligrams per mL
471  eUnit_ugml = 10, ///< micrograms per mL
472  eUnit_ngml = 11, ///< nanograms per mL
473  eUnit_pgml = 12, ///< picograms per mL
474  eUnit_fgml = 13, ///< femtograms per mL
475  eUnit_m = 14, ///< Molar
476  eUnit_percent = 15, ///< Percent
477  eUnit_ratio = 16, ///< Ratio
478  eUnit_sec = 17, ///< Seconds
479  eUnit_rsec = 18, ///< Reciprocal Seconds
480  eUnit_min = 19, ///< Minutes
481  eUnit_rmin = 20, ///< Reciprocal Minutes
482  eUnit_day = 21, ///< Days
483  eUnit_rday = 22, ///< Reciprocal Days
484  eUnit_ml_min_kg = 23, ///< milliliter / minute / kilogram
485  eUnit_l_kg = 24, ///< liter / kilogram
486  eUnit_hr_ng_ml = 25, ///< hour * nanogram / milliliter
487  eUnit_cm_sec = 26, ///< centimeter / second
488  eUnit_mg_kg = 27, ///< milligram / kilogram
489  eUnit_none = 254,
490  eUnit_unspecified = 255
491  };
492 
493  /// Access to EUnit's attributes (values, names) as defined in spec
494  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EUnit)(void);
495 
496  /// Value Transform information qualifies the values reported for this TID. For example, if the values
497  /// reported for this TID are "-Log10 GI50", you may want to consider setting
498  /// the "nlog" value below. In doing so, PubChem would know that the value, e.g., "5.0"
499  /// is actually "1.0e-5". If the transformation applied is not listed, you may represent
500  /// this transformation as a string in the "stransform" (see below) for eventual inclusion
501  /// in the enumerated transform list below.
502  ///
503  ///
504  /// ATTENTION: transform field is DEPRECATED. It is no longer
505  /// supported and remains for legacy data only.
506  /// Value Type Details
507  enum ETransform {
508  eTransform_linear = 1, ///< Linear Scale (x)
509  eTransform_ln = 2, ///< Natural Log Scale (ln x)
510  eTransform_log = 3, ///< Log Base 10 Scale (log10 x)
511  eTransform_reciprocal = 4, ///< Reciprocal Scale (1/x)
512  eTransform_negative = 5, ///< Negative Linear Scale (-x)
513  eTransform_nlog = 6, ///< Negative Log Base 10 Scale (-log10 x)
514  eTransform_nln = 7 ///< Negative Natural Log Scane (-ln x)
515  };
516 
517  /// Access to ETransform's attributes (values, names) as defined in spec
518  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ETransform)(void);
519 
520  enum EAnnot {
521  eAnnot_pmid = 1, ///< PubMed ID
522  eAnnot_mmdb = 2, ///< MMDB ID
523  eAnnot_url = 3, ///< indicate TID data is a url that provides supplementary information protein-gi (4), GenBank General ID (GI) for a Protein nucleotide-gi (5), GenBank General ID (GI) for a Nucleotide
524  eAnnot_taxonomy = 6, ///< Taxonomy ID for an Organism
525  eAnnot_mim = 7, ///< MIM, Mendelian Inheritance in Man, ID
526  eAnnot_gene = 8, ///< Entrez Gene ID
527  eAnnot_probe = 9, ///< Entrez Probe ID
528  eAnnot_aid = 10, ///< PubChem BioAssay ID, may be used in 'Summary' assay
529  eAnnot_sid = 11, ///< PubChem Substance ID, may be used in 'Summary' assay
530  eAnnot_cid = 12, ///< PubChem Compound ID protein-target-gi (13), GenBank General ID (GI) for a Protein target biosystems-target-id (14), NCBI BioSystems ID
531  eAnnot_target_name = 15, ///< target name
532  eAnnot_target_descr = 16, ///< brief target description
533  eAnnot_target_tax_id = 17, ///< NCBI Taxonomy ID for target molecule
534  eAnnot_gene_target_id = 18, ///< NCBI Gene ID for a gene target dna-nucleotide-target-gi (19), GenBank General ID (GI) for a DNA Nucleotide target rna-nucleotide-target-gi (20), GenBank General ID (GI) for a RNA Nucleotide target
535  eAnnot_protein_target_accession = 21, ///< GenBank Accession for a Protein target
536  eAnnot_nucleotide_target_accession = 22, ///< GenBank Accession for a DNA/RNA Nucleotide target
537  eAnnot_other = 255 ///< for identifier types not currently support
538  };
539 
540  /// Access to EAnnot's attributes (values, names) as defined in spec
541  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAnnot)(void);
542 
543  // types
544  typedef int TTid;
546  typedef list< CStringUTF8 > TDescription;
547  typedef int TType;
549  typedef int TUnit;
550  typedef string TSunit;
551  typedef int TTransform;
553  typedef bool TAc;
554  typedef bool TAc_qualifier;
555  typedef int TAnnot;
556 
557  // member index
558  enum class E_memberIndex {
559  e__allMandatory = 0,
560  e_tid,
561  e_name,
563  e_type,
565  e_unit,
566  e_sunit,
567  e_transform,
568  e_tc,
569  e_ac,
571  e_annot
572  };
574 
575  // getters
576  // setters
577 
578  /// Tracking or Description Information
579  /// Assay Result Field Type ID (TID)
580  /// Check if a value has been assigned to Tid data member.
581  ///
582  /// Data member Tid is mandatory;
583  /// its type is defined as 'typedef int TTid'
584  /// @return
585  /// - true, if a value has been assigned.
586  /// - false, otherwise.
587  bool IsSetTid(void) const;
588 
589  /// Check if it is safe to call GetTid method.
590  ///
591  /// @return
592  /// - true, if the data member is getatable.
593  /// - false, otherwise.
594  bool CanGetTid(void) const;
595 
596  /// Reset Tid data member.
597  void ResetTid(void);
598 
599  /// Get the Tid member data.
600  ///
601  /// @return
602  /// Copy of the member data.
603  TTid GetTid(void) const;
604 
605  /// Assign a value to Tid data member.
606  ///
607  /// @param value
608  /// Value to assign
610 
611  /// Assign a value to Tid data member.
612  ///
613  /// @return
614  /// Reference to the data value.
615  TTid& SetTid(void);
616 
617  /// Result Field Name (short name for display)
618  /// Check if a value has been assigned to Name data member.
619  ///
620  /// Data member Name is mandatory;
621  /// its type is defined as 'typedef CStringUTF8 TName'
622  /// @return
623  /// - true, if a value has been assigned.
624  /// - false, otherwise.
625  bool IsSetName(void) const;
626 
627  /// Check if it is safe to call GetName method.
628  ///
629  /// @return
630  /// - true, if the data member is getatable.
631  /// - false, otherwise.
632  bool CanGetName(void) const;
633 
634  /// Reset Name data member.
635  void ResetName(void);
636 
637  /// Get the Name member data.
638  ///
639  /// @return
640  /// Reference to the member data.
641  const TName& GetName(void) const;
642 
643  /// Assign a value to Name data member.
644  ///
645  /// @param value
646  /// Value to assign
647  void SetName(const TName& value);
648  void SetName(TName&& value);
649 
650  /// Assign a value to Name data member.
651  ///
652  /// @return
653  /// Reference to the data value.
654  TName& SetName(void);
655 
656  /// Result Field Description
657  /// Check if a value has been assigned to Description data member.
658  ///
659  /// Data member Description is optional;
660  /// its type is defined as 'typedef list< CStringUTF8 > TDescription'
661  /// @return
662  /// - true, if a value has been assigned.
663  /// - false, otherwise.
664  bool IsSetDescription(void) const;
665 
666  /// Check if it is safe to call GetDescription method.
667  ///
668  /// @return
669  /// - true, if the data member is getatable.
670  /// - false, otherwise.
671  bool CanGetDescription(void) const;
672 
673  /// Reset Description data member.
674  void ResetDescription(void);
675 
676  /// Get the Description member data.
677  ///
678  /// @return
679  /// Reference to the member data.
680  const TDescription& GetDescription(void) const;
681 
682  /// Assign a value to Description data member.
683  ///
684  /// @return
685  /// Reference to the data value.
687 
688  /// Check if a value has been assigned to Type data member.
689  ///
690  /// Data member Type is mandatory;
691  /// its type is defined as 'typedef int TType'
692  /// @return
693  /// - true, if a value has been assigned.
694  /// - false, otherwise.
695  bool IsSetType(void) const;
696 
697  /// Check if it is safe to call GetType method.
698  ///
699  /// @return
700  /// - true, if the data member is getatable.
701  /// - false, otherwise.
702  bool CanGetType(void) const;
703 
704  /// Reset Type data member.
705  void ResetType(void);
706 
707  /// Get the Type member data.
708  ///
709  /// @return
710  /// Copy of the member data.
711  TType GetType(void) const;
712 
713  /// Assign a value to Type data member.
714  ///
715  /// @param value
716  /// Value to assign
718 
719  /// Assign a value to Type data member.
720  ///
721  /// @return
722  /// Reference to the data value.
723  TType& SetType(void);
724 
725  /// Check if a value has been assigned to Constraints data member.
726  ///
727  /// Data member Constraints is optional;
728  /// its type is defined as 'typedef C_Constraints TConstraints'
729  /// @return
730  /// - true, if a value has been assigned.
731  /// - false, otherwise.
732  bool IsSetConstraints(void) const;
733 
734  /// Check if it is safe to call GetConstraints method.
735  ///
736  /// @return
737  /// - true, if the data member is getatable.
738  /// - false, otherwise.
739  bool CanGetConstraints(void) const;
740 
741  /// Reset Constraints data member.
742  void ResetConstraints(void);
743 
744  /// Get the Constraints member data.
745  ///
746  /// @return
747  /// Reference to the member data.
748  const TConstraints& GetConstraints(void) const;
749 
750  /// Assign a value to Constraints data member.
751  ///
752  /// @param value
753  /// Reference to value.
755 
756  /// Assign a value to Constraints data member.
757  ///
758  /// @return
759  /// Reference to the data value.
761 
762  /// Check if a value has been assigned to Unit data member.
763  ///
764  /// Data member Unit is optional;
765  /// its type is defined as 'typedef int TUnit'
766  /// @return
767  /// - true, if a value has been assigned.
768  /// - false, otherwise.
769  bool IsSetUnit(void) const;
770 
771  /// Check if it is safe to call GetUnit method.
772  ///
773  /// @return
774  /// - true, if the data member is getatable.
775  /// - false, otherwise.
776  bool CanGetUnit(void) const;
777 
778  /// Reset Unit data member.
779  void ResetUnit(void);
780 
781  /// Get the Unit member data.
782  ///
783  /// @return
784  /// Copy of the member data.
785  TUnit GetUnit(void) const;
786 
787  /// Assign a value to Unit data member.
788  ///
789  /// @param value
790  /// Value to assign
792 
793  /// Assign a value to Unit data member.
794  ///
795  /// @return
796  /// Reference to the data value.
797  TUnit& SetUnit(void);
798 
799  /// ATTENTION: sunit field is DEPRECATED. It is no longer
800  /// supported and remains for legacy data only.
801  /// Unit Type (as a String)
802  /// Check if a value has been assigned to Sunit data member.
803  ///
804  /// Data member Sunit is optional;
805  /// its type is defined as 'typedef string TSunit'
806  /// @return
807  /// - true, if a value has been assigned.
808  /// - false, otherwise.
809  bool IsSetSunit(void) const;
810 
811  /// Check if it is safe to call GetSunit method.
812  ///
813  /// @return
814  /// - true, if the data member is getatable.
815  /// - false, otherwise.
816  bool CanGetSunit(void) const;
817 
818  /// Reset Sunit data member.
819  void ResetSunit(void);
820 
821  /// Get the Sunit member data.
822  ///
823  /// @return
824  /// Reference to the member data.
825  const TSunit& GetSunit(void) const;
826 
827  /// Assign a value to Sunit data member.
828  ///
829  /// @param value
830  /// Value to assign
831  void SetSunit(const TSunit& value);
833 
834  /// Assign a value to Sunit data member.
835  ///
836  /// @return
837  /// Reference to the data value.
838  TSunit& SetSunit(void);
839 
840  /// Check if a value has been assigned to Transform data member.
841  ///
842  /// Data member Transform is optional;
843  /// its type is defined as 'typedef int TTransform'
844  /// @return
845  /// - true, if a value has been assigned.
846  /// - false, otherwise.
847  bool IsSetTransform(void) const;
848 
849  /// Check if it is safe to call GetTransform method.
850  ///
851  /// @return
852  /// - true, if the data member is getatable.
853  /// - false, otherwise.
854  bool CanGetTransform(void) const;
855 
856  /// Reset Transform data member.
857  void ResetTransform(void);
858 
859  /// Get the Transform member data.
860  ///
861  /// @return
862  /// Copy of the member data.
864 
865  /// Assign a value to Transform data member.
866  ///
867  /// @param value
868  /// Value to assign
870 
871  /// Assign a value to Transform data member.
872  ///
873  /// @return
874  /// Reference to the data value.
876 
877  /// ATTENTION: stransform field is DEPRECATED. It is no longer
878  /// supported and remains for legacy data only.
879  /// stransform VisibleString OPTIONAL, Value Transform Type as a string (never used)
880  /// Tested concentration attribute
881  /// Check if a value has been assigned to Tc data member.
882  ///
883  /// Data member Tc is optional;
884  /// its type is defined as 'typedef CPC_ConcentrationAttr TTc'
885  /// @return
886  /// - true, if a value has been assigned.
887  /// - false, otherwise.
888  bool IsSetTc(void) const;
889 
890  /// Check if it is safe to call GetTc method.
891  ///
892  /// @return
893  /// - true, if the data member is getatable.
894  /// - false, otherwise.
895  bool CanGetTc(void) const;
896 
897  /// Reset Tc data member.
898  void ResetTc(void);
899 
900  /// Get the Tc member data.
901  ///
902  /// @return
903  /// Reference to the member data.
904  const TTc& GetTc(void) const;
905 
906  /// Assign a value to Tc data member.
907  ///
908  /// @param value
909  /// Reference to value.
910  void SetTc(TTc& value);
911 
912  /// Assign a value to Tc data member.
913  ///
914  /// @return
915  /// Reference to the data value.
916  TTc& SetTc(void);
917 
918  /// if true, indicates that this TID field
919  /// provides active concentration summary by
920  /// reporting the concentration which produces
921  /// 50% of the maximum possible biological response
922  /// such as IC50, EC50, AC50, GI50 etc.
923  /// or by reporting constant parameters such as Ki,
924  /// that based on which the activity outcome in this assay is called
925  /// Check if a value has been assigned to Ac data member.
926  ///
927  /// Data member Ac is optional;
928  /// its type is defined as 'typedef bool TAc'
929  /// @return
930  /// - true, if a value has been assigned.
931  /// - false, otherwise.
932  bool IsSetAc(void) const;
933 
934  /// Check if it is safe to call GetAc method.
935  ///
936  /// @return
937  /// - true, if the data member is getatable.
938  /// - false, otherwise.
939  bool CanGetAc(void) const;
940 
941  /// Reset Ac data member.
942  void ResetAc(void);
943 
944  /// Get the Ac member data.
945  ///
946  /// @return
947  /// Copy of the member data.
948  TAc GetAc(void) const;
949 
950  /// Assign a value to Ac data member.
951  ///
952  /// @param value
953  /// Value to assign
954  void SetAc(TAc value);
955 
956  /// Assign a value to Ac data member.
957  ///
958  /// @return
959  /// Reference to the data value.
960  TAc& SetAc(void);
961 
962  /// endpoint qualifier (e.g. <, <=, =, >, >=) associated with the ac field above
963  /// Check if a value has been assigned to Ac_qualifier data member.
964  ///
965  /// Data member Ac_qualifier is optional;
966  /// its type is defined as 'typedef bool TAc_qualifier'
967  /// @return
968  /// - true, if a value has been assigned.
969  /// - false, otherwise.
970  bool IsSetAc_qualifier(void) const;
971 
972  /// Check if it is safe to call GetAc_qualifier method.
973  ///
974  /// @return
975  /// - true, if the data member is getatable.
976  /// - false, otherwise.
977  bool CanGetAc_qualifier(void) const;
978 
979  /// Reset Ac_qualifier data member.
980  void ResetAc_qualifier(void);
981 
982  /// Get the Ac_qualifier member data.
983  ///
984  /// @return
985  /// Copy of the member data.
986  TAc_qualifier GetAc_qualifier(void) const;
987 
988  /// Assign a value to Ac_qualifier data member.
989  ///
990  /// @param value
991  /// Value to assign
993 
994  /// Assign a value to Ac_qualifier data member.
995  ///
996  /// @return
997  /// Reference to the data value.
999 
1000  /// treat substance associated cross-reference as regular TID
1001  /// web servers would make a link
1002  /// to the corresponding record in Entrez databases
1003  /// treat substance associated target information as regular TID
1004  /// for example, for RNAi screening data, each 'substance' may
1005  /// correspond to a specific gene target
1006  /// Check if a value has been assigned to Annot data member.
1007  ///
1008  /// Data member Annot is optional;
1009  /// its type is defined as 'typedef int TAnnot'
1010  /// @return
1011  /// - true, if a value has been assigned.
1012  /// - false, otherwise.
1013  bool IsSetAnnot(void) const;
1014 
1015  /// Check if it is safe to call GetAnnot method.
1016  ///
1017  /// @return
1018  /// - true, if the data member is getatable.
1019  /// - false, otherwise.
1020  bool CanGetAnnot(void) const;
1021 
1022  /// Reset Annot data member.
1023  void ResetAnnot(void);
1024 
1025  /// Get the Annot member data.
1026  ///
1027  /// @return
1028  /// Copy of the member data.
1029  TAnnot GetAnnot(void) const;
1030 
1031  /// Assign a value to Annot data member.
1032  ///
1033  /// @param value
1034  /// Value to assign
1036 
1037  /// Assign a value to Annot data member.
1038  ///
1039  /// @return
1040  /// Reference to the data value.
1042 
1043  /// Reset the whole object
1044  virtual void Reset(void);
1045 
1046 
1047 private:
1048  // Prohibit copy constructor and assignment operator
1051 
1052  // data
1053  Uint4 m_set_State[1];
1054  int m_Tid;
1056  list< CStringUTF8 > m_Description;
1057  int m_Type;
1059  int m_Unit;
1060  string m_Sunit;
1061  int m_Transform;
1062  CRef< TTc > m_Tc;
1063  bool m_Ac;
1065  int m_Annot;
1066 };
1067 
1068 /* @} */
1069 
1070 
1071 
1072 
1073 
1074 ///////////////////////////////////////////////////////////
1075 ///////////////////// inline methods //////////////////////
1076 ///////////////////////////////////////////////////////////
1077 inline
1079 {
1080  return m_choice;
1081 }
1082 
1083 inline
1084 void CPC_ResultType_Base::C_Constraints::CheckSelected(E_Choice index) const
1085 {
1086  if ( m_choice != index )
1087  ThrowInvalidSelection(index);
1088 }
1089 
1090 inline
1091 void CPC_ResultType_Base::C_Constraints::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
1092 {
1093  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
1094  if ( m_choice != e_not_set )
1095  ResetSelection();
1096  DoSelect(index, pool);
1097  }
1098 }
1099 
1100 inline
1102 {
1103  Select(index, reset, 0);
1104 }
1105 
1106 inline
1108 {
1109  return m_choice == e_Fset;
1110 }
1111 
1112 inline
1114 {
1115  CheckSelected(e_Fset);
1116  return *m_Fset;
1117 }
1118 
1119 inline
1121 {
1122  Select(e_Fset, NCBI_NS_NCBI::eDoNotResetVariant);
1123  return *m_Fset;
1124 }
1125 
1126 inline
1128 {
1129  return m_choice == e_Fmin;
1130 }
1131 
1132 inline
1134 {
1135  CheckSelected(e_Fmin);
1136  return m_Fmin;
1137 }
1138 
1139 inline
1141 {
1142  Select(e_Fmin, NCBI_NS_NCBI::eDoNotResetVariant);
1143  return m_Fmin;
1144 }
1145 
1146 inline
1148 {
1149  Select(e_Fmin, NCBI_NS_NCBI::eDoNotResetVariant);
1150  m_Fmin = value;
1151 }
1152 
1153 inline
1155 {
1156  return m_choice == e_Fmax;
1157 }
1158 
1159 inline
1161 {
1162  CheckSelected(e_Fmax);
1163  return m_Fmax;
1164 }
1165 
1166 inline
1168 {
1169  Select(e_Fmax, NCBI_NS_NCBI::eDoNotResetVariant);
1170  return m_Fmax;
1171 }
1172 
1173 inline
1175 {
1176  Select(e_Fmax, NCBI_NS_NCBI::eDoNotResetVariant);
1177  m_Fmax = value;
1178 }
1179 
1180 inline
1182 {
1183  return m_choice == e_Frange;
1184 }
1185 
1186 inline
1188 {
1189  return m_choice == e_Iset;
1190 }
1191 
1192 inline
1194 {
1195  CheckSelected(e_Iset);
1196  return *m_Iset;
1197 }
1198 
1199 inline
1201 {
1202  Select(e_Iset, NCBI_NS_NCBI::eDoNotResetVariant);
1203  return *m_Iset;
1204 }
1205 
1206 inline
1208 {
1209  return m_choice == e_Imin;
1210 }
1211 
1212 inline
1214 {
1215  CheckSelected(e_Imin);
1216  return m_Imin;
1217 }
1218 
1219 inline
1221 {
1222  Select(e_Imin, NCBI_NS_NCBI::eDoNotResetVariant);
1223  return m_Imin;
1224 }
1225 
1226 inline
1228 {
1229  Select(e_Imin, NCBI_NS_NCBI::eDoNotResetVariant);
1230  m_Imin = value;
1231 }
1232 
1233 inline
1235 {
1236  return m_choice == e_Imax;
1237 }
1238 
1239 inline
1241 {
1242  CheckSelected(e_Imax);
1243  return m_Imax;
1244 }
1245 
1246 inline
1248 {
1249  Select(e_Imax, NCBI_NS_NCBI::eDoNotResetVariant);
1250  return m_Imax;
1251 }
1252 
1253 inline
1255 {
1256  Select(e_Imax, NCBI_NS_NCBI::eDoNotResetVariant);
1257  m_Imax = value;
1258 }
1259 
1260 inline
1262 {
1263  return m_choice == e_Irange;
1264 }
1265 
1266 inline
1268 {
1269  return m_choice == e_Sset;
1270 }
1271 
1272 inline
1274 {
1275  CheckSelected(e_Sset);
1276  return *m_Sset;
1277 }
1278 
1279 inline
1281 {
1282  Select(e_Sset, NCBI_NS_NCBI::eDoNotResetVariant);
1283  return *m_Sset;
1284 }
1285 
1286 inline
1287 bool CPC_ResultType_Base::IsSetTid(void) const
1288 {
1289  return ((m_set_State[0] & 0x3) != 0);
1290 }
1291 
1292 inline
1293 bool CPC_ResultType_Base::CanGetTid(void) const
1294 {
1295  return IsSetTid();
1296 }
1297 
1298 inline
1300 {
1301  m_Tid = 0;
1302  m_set_State[0] &= ~0x3;
1303 }
1304 
1305 inline
1307 {
1308  if (!CanGetTid()) {
1309  ThrowUnassigned(0);
1310  }
1311  return m_Tid;
1312 }
1313 
1314 inline
1316 {
1317  m_Tid = value;
1318  m_set_State[0] |= 0x3;
1319 }
1320 
1321 inline
1323 {
1324 #ifdef _DEBUG
1325  if (!IsSetTid()) {
1326  memset(&m_Tid,UnassignedByte(),sizeof(m_Tid));
1327  }
1328 #endif
1329  m_set_State[0] |= 0x1;
1330  return m_Tid;
1331 }
1332 
1333 inline
1334 bool CPC_ResultType_Base::IsSetName(void) const
1335 {
1336  return ((m_set_State[0] & 0xc) != 0);
1337 }
1338 
1339 inline
1340 bool CPC_ResultType_Base::CanGetName(void) const
1341 {
1342  return IsSetName();
1343 }
1344 
1345 inline
1347 {
1348  if (!CanGetName()) {
1349  ThrowUnassigned(1);
1350  }
1351  return m_Name;
1352 }
1353 
1354 inline
1356 {
1357  m_Name = value;
1358  m_set_State[0] |= 0xc;
1359 }
1360 
1361 inline
1363 {
1364  m_Name = std::forward<CPC_ResultType_Base::TName>(value);
1365  m_set_State[0] |= 0xc;
1366 }
1367 
1368 inline
1370 {
1371 #ifdef _DEBUG
1372  if (!IsSetName()) {
1374  }
1375 #endif
1376  m_set_State[0] |= 0x4;
1377  return m_Name;
1378 }
1379 
1380 inline
1382 {
1383  return ((m_set_State[0] & 0x30) != 0);
1384 }
1385 
1386 inline
1388 {
1389  return true;
1390 }
1391 
1392 inline
1394 {
1395  return m_Description;
1396 }
1397 
1398 inline
1400 {
1401  m_set_State[0] |= 0x10;
1402  return m_Description;
1403 }
1404 
1405 inline
1406 bool CPC_ResultType_Base::IsSetType(void) const
1407 {
1408  return ((m_set_State[0] & 0xc0) != 0);
1409 }
1410 
1411 inline
1412 bool CPC_ResultType_Base::CanGetType(void) const
1413 {
1414  return IsSetType();
1415 }
1416 
1417 inline
1419 {
1420  m_Type = (EType)(0);
1421  m_set_State[0] &= ~0xc0;
1422 }
1423 
1424 inline
1426 {
1427  if (!CanGetType()) {
1428  ThrowUnassigned(3);
1429  }
1430  return m_Type;
1431 }
1432 
1433 inline
1435 {
1436  m_Type = value;
1437  m_set_State[0] |= 0xc0;
1438 }
1439 
1440 inline
1442 {
1443 #ifdef _DEBUG
1444  if (!IsSetType()) {
1445  memset(&m_Type,UnassignedByte(),sizeof(m_Type));
1446  }
1447 #endif
1448  m_set_State[0] |= 0x40;
1449  return m_Type;
1450 }
1451 
1452 inline
1454 {
1455  return m_Constraints.NotEmpty();
1456 }
1457 
1458 inline
1460 {
1461  return IsSetConstraints();
1462 }
1463 
1464 inline
1466 {
1467  if (!CanGetConstraints()) {
1468  ThrowUnassigned(4);
1469  }
1470  return (*m_Constraints);
1471 }
1472 
1473 inline
1474 bool CPC_ResultType_Base::IsSetUnit(void) const
1475 {
1476  return ((m_set_State[0] & 0xc00) != 0);
1477 }
1478 
1479 inline
1480 bool CPC_ResultType_Base::CanGetUnit(void) const
1481 {
1482  return IsSetUnit();
1483 }
1484 
1485 inline
1487 {
1488  m_Unit = (EUnit)(0);
1489  m_set_State[0] &= ~0xc00;
1490 }
1491 
1492 inline
1494 {
1495  if (!CanGetUnit()) {
1496  ThrowUnassigned(5);
1497  }
1498  return m_Unit;
1499 }
1500 
1501 inline
1503 {
1504  m_Unit = value;
1505  m_set_State[0] |= 0xc00;
1506 }
1507 
1508 inline
1510 {
1511 #ifdef _DEBUG
1512  if (!IsSetUnit()) {
1513  memset(&m_Unit,UnassignedByte(),sizeof(m_Unit));
1514  }
1515 #endif
1516  m_set_State[0] |= 0x400;
1517  return m_Unit;
1518 }
1519 
1520 inline
1521 bool CPC_ResultType_Base::IsSetSunit(void) const
1522 {
1523  return ((m_set_State[0] & 0x3000) != 0);
1524 }
1525 
1526 inline
1527 bool CPC_ResultType_Base::CanGetSunit(void) const
1528 {
1529  return IsSetSunit();
1530 }
1531 
1532 inline
1534 {
1535  if (!CanGetSunit()) {
1536  ThrowUnassigned(6);
1537  }
1538  return m_Sunit;
1539 }
1540 
1541 inline
1543 {
1544  m_Sunit = value;
1545  m_set_State[0] |= 0x3000;
1546 }
1547 
1548 inline
1550 {
1551  m_Sunit = std::forward<CPC_ResultType_Base::TSunit>(value);
1552  m_set_State[0] |= 0x3000;
1553 }
1554 
1555 inline
1557 {
1558 #ifdef _DEBUG
1559  if (!IsSetSunit()) {
1561  }
1562 #endif
1563  m_set_State[0] |= 0x1000;
1564  return m_Sunit;
1565 }
1566 
1567 inline
1568 bool CPC_ResultType_Base::IsSetTransform(void) const
1569 {
1570  return ((m_set_State[0] & 0xc000) != 0);
1571 }
1572 
1573 inline
1574 bool CPC_ResultType_Base::CanGetTransform(void) const
1575 {
1576  return IsSetTransform();
1577 }
1578 
1579 inline
1581 {
1582  m_Transform = (ETransform)(0);
1583  m_set_State[0] &= ~0xc000;
1584 }
1585 
1586 inline
1588 {
1589  if (!CanGetTransform()) {
1590  ThrowUnassigned(7);
1591  }
1592  return m_Transform;
1593 }
1594 
1595 inline
1597 {
1598  m_Transform = value;
1599  m_set_State[0] |= 0xc000;
1600 }
1601 
1602 inline
1604 {
1605 #ifdef _DEBUG
1606  if (!IsSetTransform()) {
1607  memset(&m_Transform,UnassignedByte(),sizeof(m_Transform));
1608  }
1609 #endif
1610  m_set_State[0] |= 0x4000;
1611  return m_Transform;
1612 }
1613 
1614 inline
1615 bool CPC_ResultType_Base::IsSetTc(void) const
1616 {
1617  return m_Tc.NotEmpty();
1618 }
1619 
1620 inline
1621 bool CPC_ResultType_Base::CanGetTc(void) const
1622 {
1623  return IsSetTc();
1624 }
1625 
1626 inline
1628 {
1629  if (!CanGetTc()) {
1630  ThrowUnassigned(8);
1631  }
1632  return (*m_Tc);
1633 }
1634 
1635 inline
1636 bool CPC_ResultType_Base::IsSetAc(void) const
1637 {
1638  return ((m_set_State[0] & 0xc0000) != 0);
1639 }
1640 
1641 inline
1642 bool CPC_ResultType_Base::CanGetAc(void) const
1643 {
1644  return IsSetAc();
1645 }
1646 
1647 inline
1649 {
1650  m_Ac = 0;
1651  m_set_State[0] &= ~0xc0000;
1652 }
1653 
1654 inline
1656 {
1657  if (!CanGetAc()) {
1658  ThrowUnassigned(9);
1659  }
1660  return m_Ac;
1661 }
1662 
1663 inline
1665 {
1666  m_Ac = value;
1667  m_set_State[0] |= 0xc0000;
1668 }
1669 
1670 inline
1672 {
1673 #ifdef _DEBUG
1674  if (!IsSetAc()) {
1675  memset(&m_Ac,UnassignedByte(),sizeof(m_Ac));
1676  }
1677 #endif
1678  m_set_State[0] |= 0x40000;
1679  return m_Ac;
1680 }
1681 
1682 inline
1684 {
1685  return ((m_set_State[0] & 0x300000) != 0);
1686 }
1687 
1688 inline
1690 {
1691  return IsSetAc_qualifier();
1692 }
1693 
1694 inline
1696 {
1697  m_Ac_qualifier = 0;
1698  m_set_State[0] &= ~0x300000;
1699 }
1700 
1701 inline
1703 {
1704  if (!CanGetAc_qualifier()) {
1705  ThrowUnassigned(10);
1706  }
1707  return m_Ac_qualifier;
1708 }
1709 
1710 inline
1712 {
1714  m_set_State[0] |= 0x300000;
1715 }
1716 
1717 inline
1719 {
1720 #ifdef _DEBUG
1721  if (!IsSetAc_qualifier()) {
1722  memset(&m_Ac_qualifier,UnassignedByte(),sizeof(m_Ac_qualifier));
1723  }
1724 #endif
1725  m_set_State[0] |= 0x100000;
1726  return m_Ac_qualifier;
1727 }
1728 
1729 inline
1730 bool CPC_ResultType_Base::IsSetAnnot(void) const
1731 {
1732  return ((m_set_State[0] & 0xc00000) != 0);
1733 }
1734 
1735 inline
1736 bool CPC_ResultType_Base::CanGetAnnot(void) const
1737 {
1738  return IsSetAnnot();
1739 }
1740 
1741 inline
1743 {
1744  m_Annot = (EAnnot)(0);
1745  m_set_State[0] &= ~0xc00000;
1746 }
1747 
1748 inline
1750 {
1751  if (!CanGetAnnot()) {
1752  ThrowUnassigned(11);
1753  }
1754  return m_Annot;
1755 }
1756 
1757 inline
1759 {
1760  m_Annot = value;
1761  m_set_State[0] |= 0xc00000;
1762 }
1763 
1764 inline
1766 {
1767 #ifdef _DEBUG
1768  if (!IsSetAnnot()) {
1769  memset(&m_Annot,UnassignedByte(),sizeof(m_Annot));
1770  }
1771 #endif
1772  m_set_State[0] |= 0x400000;
1773  return m_Annot;
1774 }
1775 
1776 ///////////////////////////////////////////////////////////
1777 ////////////////// end of inline methods //////////////////
1778 ///////////////////////////////////////////////////////////
1779 
1780 
1781 
1782 
1783 
1784 END_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
1785 
1786 END_objects_SCOPE // namespace ncbi::objects::
1787 
1789 
1790 
1791 #endif // OBJECTS_PCASSAY2_PC_RESULTTYPE_BASE_HPP
CPC_ConcentrationAttr –.
CPC_IntegerMinMax –.
CPC_RealMinMax –.
Allowed Values, used for validating incoming data If type is "float".
Definition of Allowed Result Types for a given Assay.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
static CStringUTF8 UnassignedStringUTF8(void)
Definition: serialbase.hpp:178
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
EResetVariant
Definition: serialbase.hpp:76
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
static string UnassignedString(void)
Definition: serialbase.hpp:175
@ eDoResetVariant
Definition: serialbase.hpp:77
@ eDoNotResetVariant
Definition: serialbase.hpp:78
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
std::string CStringUTF8
Definition: ncbistl.hpp:254
void SetConstraints(TConstraints &value)
Assign a value to Constraints data member.
TTransform & SetTransform(void)
Assign a value to Transform data member.
TUnit GetUnit(void) const
Get the Unit member data.
bool IsSetDescription(void) const
Result Field Description Check if a value has been assigned to Description data member.
void DoSelect(E_Choice index, CObjectMemoryPool *pool=0)
const TIset & GetIset(void) const
Get the variant data.
TAnnot GetAnnot(void) const
Get the Annot member data.
CSerialObject Tparent
bool IsIset(void) const
Check if variant Iset is selected.
bool IsSetSunit(void) const
ATTENTION: sunit field is DEPRECATED.
void SetAnnot(TAnnot value)
Assign a value to Annot data member.
void SetFmin(TFmin value)
Select the variant and set its data.
TType & SetType(void)
Assign a value to Type data member.
TConstraints & SetConstraints(void)
Assign a value to Constraints data member.
void SetFmax(TFmax value)
Select the variant and set its data.
TTid & SetTid(void)
Assign a value to Tid data member.
void ResetAc_qualifier(void)
Reset Ac_qualifier data member.
bool CanGetTc(void) const
Check if it is safe to call GetTc method.
TUnit & SetUnit(void)
Assign a value to Unit data member.
const TFset & GetFset(void) const
Get the variant data.
list< CStringUTF8 > TDescription
TImin GetImin(void) const
Get the variant data.
bool IsSetTc(void) const
ATTENTION: stransform field is DEPRECATED.
void ResetConstraints(void)
Reset Constraints data member.
void SetSunit(TSunit &&value)
void SetAc(TAc value)
Assign a value to Ac data member.
TIset & SetIset(void)
Select the variant.
const TName & GetName(void) const
Get the Name member data.
void SetType(TType value)
Assign a value to Type data member.
bool CanGetTid(void) const
Check if it is safe to call GetTid method.
bool IsSetTid(void) const
Tracking or Description Information Assay Result Field Type ID (TID) Check if a value has been assign...
Tparent::CMemberIndex< E_memberIndex, 13 > TmemberIndex
const TDescription & GetDescription(void) const
Get the Description member data.
TTc & SetTc(void)
Assign a value to Tc data member.
void SetFrange(TFrange &value)
Select the variant and set its data.
TSunit & SetSunit(void)
Assign a value to Sunit data member.
void ThrowInvalidSelection(E_Choice index) const
Throw 'InvalidSelection' exception.
CPC_ConcentrationAttr TTc
bool CanGetAc_qualifier(void) const
Check if it is safe to call GetAc_qualifier method.
C_Constraints & operator=(const C_Constraints &)
bool IsImax(void) const
Check if variant Imax is selected.
void SetSunit(const TSunit &value)
Assign a value to Sunit data member.
TTransform GetTransform(void) const
Get the Transform member data.
bool CanGetTransform(void) const
Check if it is safe to call GetTransform method.
void SetTid(TTid value)
Assign a value to Tid data member.
bool CanGetSunit(void) const
Check if it is safe to call GetSunit method.
bool IsImin(void) const
Check if variant Imin is selected.
const TSunit & GetSunit(void) const
Get the Sunit member data.
bool IsSetType(void) const
Check if a value has been assigned to Type data member.
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
bool IsSetName(void) const
Result Field Name (short name for display) Check if a value has been assigned to Name data member.
void ResetSunit(void)
Reset Sunit data member.
bool CanGetUnit(void) const
Check if it is safe to call GetUnit method.
static string SelectionName(E_Choice index)
Retrieve selection name (for diagnostic purposes).
void ResetTid(void)
Reset Tid data member.
bool IsIrange(void) const
Check if variant Irange is selected.
TAc & SetAc(void)
Assign a value to Ac data member.
bool IsSetAc(void) const
if true, indicates that this TID field provides active concentration summary by reporting the concent...
bool IsFmin(void) const
Check if variant Fmin is selected.
TType GetType(void) const
Get the Type member data.
C_Constraints TConstraints
NCBI_NS_NCBI::CUnionBuffer< TFset > m_Fset
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
TTid GetTid(void) const
Get the Tid member data.
void ResetAnnot(void)
Reset Annot data member.
void ResetTc(void)
Reset Tc data member.
bool IsSetUnit(void) const
Check if a value has been assigned to Unit data member.
void ResetTransform(void)
Reset Transform data member.
bool CanGetAnnot(void) const
Check if it is safe to call GetAnnot method.
bool IsFset(void) const
Check if variant Fset is selected.
bool IsSetAc_qualifier(void) const
endpoint qualifier (e.g.
void ResetDescription(void)
Reset Description data member.
TSset & SetSset(void)
Select the variant.
TName & SetName(void)
Assign a value to Name data member.
bool IsSetAnnot(void) const
treat substance associated cross-reference as regular TID web servers would make a link to the corres...
void SetName(const TName &value)
Assign a value to Name data member.
bool IsFmax(void) const
Check if variant Fmax is selected.
void SetIrange(TIrange &value)
Select the variant and set its data.
TAc GetAc(void) const
Get the Ac member data.
TAc_qualifier GetAc_qualifier(void) const
Get the Ac_qualifier member data.
TImin & SetImin(void)
Select the variant.
bool CanGetName(void) const
Check if it is safe to call GetName method.
C_Constraints(const C_Constraints &)
void SetTc(TTc &value)
Assign a value to Tc data member.
void ResetSelection(void)
Reset the selection (set it to e_not_set).
bool IsFrange(void) const
Check if variant Frange is selected.
E_Choice Which(void) const
Which variant is currently selected.
void Reset(void)
Reset the whole object.
void ResetAc(void)
Reset Ac data member.
NCBI_NS_NCBI::CUnionBuffer< TSset > m_Sset
NCBI_NS_NCBI::CUnionBuffer< TIset > m_Iset
TDescription & SetDescription(void)
Assign a value to Description data member.
TFset & SetFset(void)
Select the variant.
const TIrange & GetIrange(void) const
Get the variant data.
void ResetType(void)
Reset Type data member.
const TSset & GetSset(void) const
Get the variant data.
const TTc & GetTc(void) const
Get the Tc member data.
CPC_ResultType_Base & operator=(const CPC_ResultType_Base &)
TImax & SetImax(void)
Select the variant.
void SetImax(TImax value)
Select the variant and set its data.
bool CanGetAc(void) const
Check if it is safe to call GetAc method.
bool CanGetConstraints(void) const
Check if it is safe to call GetConstraints method.
TImax GetImax(void) const
Get the variant data.
CPC_ResultType_Base(const CPC_ResultType_Base &)
list< CStringUTF8 > m_Description
TFmin & SetFmin(void)
Select the variant.
TFrange & SetFrange(void)
Select the variant.
NCBI_NS_NCBI::CSerialObject * m_object
void SetImin(TImin value)
Select the variant and set its data.
const TConstraints & GetConstraints(void) const
Get the Constraints member data.
bool IsSset(void) const
Check if variant Sset is selected.
TFmax & SetFmax(void)
Select the variant.
bool CanGetDescription(void) const
Check if it is safe to call GetDescription method.
void SetName(TName &&value)
TFmin GetFmin(void) const
Get the variant data.
TFmax GetFmax(void) const
Get the variant data.
bool CanGetType(void) const
Check if it is safe to call GetType method.
TAc_qualifier & SetAc_qualifier(void)
Assign a value to Ac_qualifier data member.
void ResetUnit(void)
Reset Unit data member.
virtual ~CPC_ResultType_Base(void)
bool IsSetConstraints(void) const
Check if a value has been assigned to Constraints data member.
TIrange & SetIrange(void)
Select the variant.
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
void ResetName(void)
Reset Name data member.
void SetTransform(TTransform value)
Assign a value to Transform data member.
virtual void Reset(void)
Reset the whole object.
const TFrange & GetFrange(void) const
Get the variant data.
bool IsSetTransform(void) const
Check if a value has been assigned to Transform data member.
void SetUnit(TUnit value)
Assign a value to Unit data member.
TAnnot & SetAnnot(void)
Assign a value to Annot data member.
@ eUnit_fgml
femtograms per mL
@ eUnit_cm_sec
centimeter / second
@ eUnit_ppb
Parts per Billion.
@ eUnit_ngml
nanograms per mL
@ eUnit_hr_ng_ml
hour * nanogram / milliliter
@ eUnit_pgml
picograms per mL
@ eUnit_ugml
micrograms per mL
@ eUnit_rmin
Reciprocal Minutes.
@ eUnit_mgml
milligrams per mL
@ eUnit_ppm
Parts per Million.
@ eUnit_rday
Reciprocal Days.
@ eUnit_l_kg
liter / kilogram
@ eUnit_rsec
Reciprocal Seconds.
@ eUnit_ppt
Parts per Thousand.
@ eUnit_ml_min_kg
milliliter / minute / kilogram
@ eUnit_mg_kg
milligram / kilogram
@ e_Iset
If type is "int" Allowed values must be equal to one of these.
@ e_Frange
Minimum/Maximum Range [ min <= x <= max ].
@ e_Fset
Allowed values must be equal to one of these.
@ e_Fmax
Allowed values (x) must be [ x <= fmax ].
@ e_Sset
If type is "string" Allowed values must be equal to one of these.
@ e_Fmin
Allowed values (x) must be [ fmin <= x ].
@ e_Irange
Minimum/Maximum Range [ min <= x <= max ].
@ e_Imin
Allowed values (x) must be [ imin <= x ].
@ e_Imax
Allowed values (x) must be [ x <= imax ].
@ eAnnot_protein_target_accession
GenBank Accession for a Protein target.
@ eAnnot_aid
PubChem BioAssay ID, may be used in 'Summary' assay.
@ eAnnot_cid
PubChem Compound ID.
@ eAnnot_gene_target_id
NCBI Gene ID for a gene target.
@ eAnnot_probe
Entrez Probe ID.
@ eAnnot_other
for identifier types not currently support
@ eAnnot_mim
MIM, Mendelian Inheritance in Man, ID.
@ eAnnot_sid
PubChem Substance ID, may be used in 'Summary' assay.
@ eAnnot_nucleotide_target_accession
GenBank Accession for a DNA/RNA Nucleotide target.
@ eAnnot_taxonomy
Taxonomy ID for an Organism.
@ eAnnot_gene
Entrez Gene ID.
@ eAnnot_url
indicate TID data is a url that provides supplementary information
@ eAnnot_target_tax_id
NCBI Taxonomy ID for target molecule.
@ eAnnot_target_name
target name
@ eAnnot_target_descr
brief target description
@ eTransform_negative
Negative Linear Scale (-x)
@ eTransform_nln
Negative Natural Log Scane (-ln x)
@ eTransform_linear
Linear Scale (x)
@ eTransform_log
Log Base 10 Scale (log10 x)
@ eTransform_reciprocal
Reciprocal Scale (1/x)
@ eTransform_nlog
Negative Log Base 10 Scale (-log10 x)
@ eTransform_ln
Natural Log Scale (ln x)
bool IsSetDescription(void) const
Result Field Description Check if a value has been assigned to Description data member.
bool IsIset(void) const
Check if variant Iset is selected.
bool IsSetSunit(void) const
ATTENTION: sunit field is DEPRECATED.
EType
Result Data Type and Validation Information Result Data Type.
TTransform GetTransform(void) const
Get the Transform member data.
const TConstraints & GetConstraints(void) const
Get the Constraints member data.
TAnnot GetAnnot(void) const
Get the Annot member data.
TDescription & SetDescription(void)
Assign a value to Description data member.
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
bool CanGetTc(void) const
Check if it is safe to call GetTc method.
TTid & SetTid(void)
Assign a value to Tid data member.
EUnit
Unit information provides the units for the values reported for this TID.
bool IsSetTc(void) const
Tested concentration attribute Check if a value has been assigned to Tc data member.
TType & SetType(void)
Assign a value to Type data member.
TName & SetName(void)
Assign a value to Name data member.
TUnit & SetUnit(void)
Assign a value to Unit data member.
const TName & GetName(void) const
Get the Name member data.
bool CanGetTid(void) const
Check if it is safe to call GetTid method.
bool IsSetTid(void) const
Tracking or Description Information Assay Result Field Type ID (TID) Check if a value has been assign...
TFset & SetFset(void)
Select the variant.
TTid GetTid(void) const
Get the Tid member data.
const TDescription & GetDescription(void) const
Get the Description member data.
list< string > m_Description
list< string > TDescription
bool IsImax(void) const
Check if variant Imax is selected.
const TSunit & GetSunit(void) const
Get the Sunit member data.
bool CanGetTransform(void) const
Check if it is safe to call GetTransform method.
ETransform
Value Transform information qualifies the values reported for this TID.
bool CanGetSunit(void) const
Check if it is safe to call GetSunit method.
bool IsImin(void) const
Check if variant Imin is selected.
bool IsSetType(void) const
Check if a value has been assigned to Type data member.
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
bool IsSetName(void) const
Result Field Name (short name for display) Check if a value has been assigned to Name data member.
static const char *const sm_SelectionNames[]
bool CanGetUnit(void) const
Check if it is safe to call GetUnit method.
const TIset & GetIset(void) const
Get the variant data.
TImin GetImin(void) const
Get the variant data.
const TSset & GetSset(void) const
Get the variant data.
void ResetTid(void)
Reset Tid data member.
bool IsIrange(void) const
Check if variant Irange is selected.
TIset & SetIset(void)
Select the variant.
TUnit GetUnit(void) const
Get the Unit member data.
bool IsSetAc(void) const
if true, indicates that this TID field provides active concentration summary by reporting the concent...
bool IsFmin(void) const
Check if variant Fmin is selected.
void ResetAnnot(void)
Reset Annot data member.
bool IsSetUnit(void) const
Check if a value has been assigned to Unit data member.
void ResetTransform(void)
Reset Transform data member.
bool CanGetAnnot(void) const
Check if it is safe to call GetAnnot method.
bool IsFset(void) const
Check if variant Fset is selected.
bool IsSetAnnot(void) const
treat substance associated cross-reference as regular TID web servers would make a link to the corres...
bool IsFmax(void) const
Check if variant Fmax is selected.
CRef< TConstraints > m_Constraints
const TFset & GetFset(void) const
Get the variant data.
TAnnot & SetAnnot(void)
Assign a value to Annot data member.
bool CanGetName(void) const
Check if it is safe to call GetName method.
TAc GetAc(void) const
Get the Ac member data.
TType GetType(void) const
Get the Type member data.
bool IsFrange(void) const
Check if variant Frange is selected.
TFmin GetFmin(void) const
Get the variant data.
const TTc & GetTc(void) const
Get the Tc member data.
void ResetAc(void)
Reset Ac data member.
TImax GetImax(void) const
Get the variant data.
TSset & SetSset(void)
Select the variant.
TAc & SetAc(void)
Assign a value to Ac data member.
TImin & SetImin(void)
Select the variant.
TImax & SetImax(void)
Select the variant.
void ResetType(void)
Reset Type data member.
E_Choice Which(void) const
Which variant is currently selected.
bool CanGetAc(void) const
Check if it is safe to call GetAc method.
bool CanGetConstraints(void) const
Check if it is safe to call GetConstraints method.
TFmax & SetFmax(void)
Select the variant.
TTransform & SetTransform(void)
Assign a value to Transform data member.
TFmin & SetFmin(void)
Select the variant.
bool IsSset(void) const
Check if variant Sset is selected.
bool CanGetDescription(void) const
Check if it is safe to call GetDescription method.
bool CanGetType(void) const
Check if it is safe to call GetType method.
void ResetUnit(void)
Reset Unit data member.
bool IsSetConstraints(void) const
Check if a value has been assigned to Constraints data member.
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
TFmax GetFmax(void) const
Get the variant data.
bool IsSetTransform(void) const
Check if a value has been assigned to Transform data member.
TSunit & SetSunit(void)
Assign a value to Sunit data member.
@ e_not_set
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
#define END_pcassay2_SCOPE
#define BEGIN_pcassay2_SCOPE
Modified on Sun May 05 05:15:40 2024 by modify_doxy.py rev. 669887