NCBI C++ ToolKit
PC_AssayResults_.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_AssayResults_.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_ASSAYRESULTS_BASE_HPP
42 #define OBJECTS_PCASSAY2_PC_ASSAYRESULTS_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
50 #include <vector>
51 
53 
54 #ifndef BEGIN_objects_SCOPE
55 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
56 # define END_objects_SCOPE END_SCOPE(objects)
57 #endif
58 BEGIN_objects_SCOPE // namespace ncbi::objects::
59 
60 
61 // forward declarations
62 class CDate;
63 class CPC_Source;
64 #ifndef BEGIN_pcassay2_SCOPE
65 # define BEGIN_pcassay2_SCOPE BEGIN_SCOPE(pcassay2)
66 # define END_pcassay2_SCOPE END_SCOPE(pcassay2)
67 #endif
68 BEGIN_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
69 
70 class CPC_AnnotatedXRef;
71 class CPC_AssayData;
72 
73 
74 // generated classes
75 
76 
77 /** @addtogroup dataspec_NCBI_PCAssay2
78  *
79  * @{
80  */
81 
82 /////////////////////////////////////////////////////////////////////////////
83 /// Container for multiple Assay Result Sets
84 /// PC-AssayResultsSet ::= SEQUENCE OF PC-AssayResults
85 /// Assay Results provided for a given Substance tested, with respect to the results types defined in the
86 /// referenced Assay Description
87 ///
88 /// CPC_AssayResults_Base --
89 ///
90 
92 {
94 public:
95  // constructor
97  // destructor
98  virtual ~CPC_AssayResults_Base(void);
99 
100  // type info
102 
103  /// Assay Result Data for this Sample
104  /// Note: Users need populate only those "tid"s, for which there is data, in any order.
105  /// Assay Outcome
106  enum EOutcome {
107  eOutcome_inactive = 1, ///< Substance is considered Inactive
108  eOutcome_active = 2, ///< Substance is considered Active
109  eOutcome_inconclusive = 3, ///< Substance is Inconclusive
110  eOutcome_unspecified = 4, ///< Substance Outcome is Unspecified
111  eOutcome_probe = 5 ///< Substance Outcome is Unspecified
112  };
113 
114  /// Access to EOutcome's attributes (values, names) as defined in spec
115  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EOutcome)(void);
116 
117  // types
118  typedef int TSid;
119  typedef objects::CPC_Source TSid_source;
120  typedef int TVersion;
122  typedef int TOutcome;
123  typedef int TRank;
124  typedef vector< CRef< CPC_AssayData > > TData;
125  typedef CStringUTF8 TUrl;
126  typedef list< CRef< CPC_AnnotatedXRef > > TXref;
127  typedef objects::CDate TDate;
128 
129  // member index
130  enum class E_memberIndex {
131  e__allMandatory = 0,
132  e_sid,
133  e_sid_source,
134  e_version,
135  e_comment,
136  e_outcome,
137  e_rank,
138  e_data,
139  e_url,
140  e_xref,
141  e_date
142  };
144 
145  // getters
146  // setters
147 
148  /// Internal/External Tracking Information
149  /// Tested Substance ID/Version [Either valid ID or,
150  /// if "sid-source" is used, this is a "0" value]
151  /// Note: A valid ID is greater than "0"
152  /// Check if a value has been assigned to Sid data member.
153  ///
154  /// Data member Sid is mandatory;
155  /// its type is defined as 'typedef int TSid'
156  /// @return
157  /// - true, if a value has been assigned.
158  /// - false, otherwise.
159  bool IsSetSid(void) const;
160 
161  /// Check if it is safe to call GetSid method.
162  ///
163  /// @return
164  /// - true, if the data member is getatable.
165  /// - false, otherwise.
166  bool CanGetSid(void) const;
167 
168  /// Reset Sid data member.
169  void ResetSid(void);
170 
171  /// Get the Sid member data.
172  ///
173  /// @return
174  /// Copy of the member data.
175  TSid GetSid(void) const;
176 
177  /// Assign a value to Sid data member.
178  ///
179  /// @param value
180  /// Value to assign
182 
183  /// Assign a value to Sid data member.
184  ///
185  /// @return
186  /// Reference to the data value.
187  TSid& SetSid(void);
188 
189  /// External Identifier for this Substance
190  /// Note: May be used in-lieu of "sid"
191  /// Note: This is non-optional if "sid" is "0"
192  /// Check if a value has been assigned to Sid_source data member.
193  ///
194  /// Data member Sid_source is optional;
195  /// its type is defined as 'typedef objects::CPC_Source TSid_source'
196  /// @return
197  /// - true, if a value has been assigned.
198  /// - false, otherwise.
199  bool IsSetSid_source(void) const;
200 
201  /// Check if it is safe to call GetSid_source method.
202  ///
203  /// @return
204  /// - true, if the data member is getatable.
205  /// - false, otherwise.
206  bool CanGetSid_source(void) const;
207 
208  /// Reset Sid_source data member.
209  void ResetSid_source(void);
210 
211  /// Get the Sid_source member data.
212  ///
213  /// @return
214  /// Reference to the member data.
215  const TSid_source& GetSid_source(void) const;
216 
217  /// Assign a value to Sid_source data member.
218  ///
219  /// @param value
220  /// Reference to value.
222 
223  /// Assign a value to Sid_source data member.
224  ///
225  /// @return
226  /// Reference to the data value.
228 
229  /// Version identifier for this AID-SID Result
230  /// Note: Incoming data should set this to be "0"
231  /// Check if a value has been assigned to Version data member.
232  ///
233  /// Data member Version is optional;
234  /// its type is defined as 'typedef int TVersion'
235  /// @return
236  /// - true, if a value has been assigned.
237  /// - false, otherwise.
238  bool IsSetVersion(void) const;
239 
240  /// Check if it is safe to call GetVersion method.
241  ///
242  /// @return
243  /// - true, if the data member is getatable.
244  /// - false, otherwise.
245  bool CanGetVersion(void) const;
246 
247  /// Reset Version data member.
248  void ResetVersion(void);
249 
250  /// Get the Version member data.
251  ///
252  /// @return
253  /// Copy of the member data.
254  TVersion GetVersion(void) const;
255 
256  /// Assign a value to Version data member.
257  ///
258  /// @param value
259  /// Value to assign
261 
262  /// Assign a value to Version data member.
263  ///
264  /// @return
265  /// Reference to the data value.
267 
268  /// Data Annotation/Qualifier and URL to further Depositor Information
269  /// Annotation or qualifier for this Result
270  /// Check if a value has been assigned to Comment data member.
271  ///
272  /// Data member Comment is optional;
273  /// its type is defined as 'typedef CStringUTF8 TComment'
274  /// @return
275  /// - true, if a value has been assigned.
276  /// - false, otherwise.
277  bool IsSetComment(void) const;
278 
279  /// Check if it is safe to call GetComment method.
280  ///
281  /// @return
282  /// - true, if the data member is getatable.
283  /// - false, otherwise.
284  bool CanGetComment(void) const;
285 
286  /// Reset Comment data member.
287  void ResetComment(void);
288 
289  /// Get the Comment member data.
290  ///
291  /// @return
292  /// Reference to the member data.
293  const TComment& GetComment(void) const;
294 
295  /// Assign a value to Comment data member.
296  ///
297  /// @param value
298  /// Value to assign
299  void SetComment(const TComment& value);
301 
302  /// Assign a value to Comment data member.
303  ///
304  /// @return
305  /// Reference to the data value.
307 
308  /// Check if a value has been assigned to Outcome data member.
309  ///
310  /// Data member Outcome is optional with default eOutcome_unspecified;
311  /// its type is defined as 'typedef int TOutcome'
312  /// @return
313  /// - true, if a value has been assigned.
314  /// - false, otherwise.
315  bool IsSetOutcome(void) const;
316 
317  /// Check if it is safe to call GetOutcome method.
318  ///
319  /// @return
320  /// - true, if the data member is getatable.
321  /// - false, otherwise.
322  bool CanGetOutcome(void) const;
323 
324  /// Reset Outcome data member.
325  void ResetOutcome(void);
326 
327  /// Assign default value to Outcome data member.
328  void SetDefaultOutcome(void);
329 
330  /// Get the Outcome member data.
331  ///
332  /// @return
333  /// Copy of the member data.
334  TOutcome GetOutcome(void) const;
335 
336  /// Assign a value to Outcome data member.
337  ///
338  /// @param value
339  /// Value to assign
341 
342  /// Assign a value to Outcome data member.
343  ///
344  /// @return
345  /// Reference to the data value.
347 
348  /// Rank of Assay Outcome (for result ordering)
349  /// Note: Larger numbers are more active
350  /// Check if a value has been assigned to Rank data member.
351  ///
352  /// Data member Rank is optional;
353  /// its type is defined as 'typedef int TRank'
354  /// @return
355  /// - true, if a value has been assigned.
356  /// - false, otherwise.
357  bool IsSetRank(void) const;
358 
359  /// Check if it is safe to call GetRank method.
360  ///
361  /// @return
362  /// - true, if the data member is getatable.
363  /// - false, otherwise.
364  bool CanGetRank(void) const;
365 
366  /// Reset Rank data member.
367  void ResetRank(void);
368 
369  /// Get the Rank member data.
370  ///
371  /// @return
372  /// Copy of the member data.
373  TRank GetRank(void) const;
374 
375  /// Assign a value to Rank data member.
376  ///
377  /// @param value
378  /// Value to assign
380 
381  /// Assign a value to Rank data member.
382  ///
383  /// @return
384  /// Reference to the data value.
385  TRank& SetRank(void);
386 
387  /// Assay Data Reported for this SID (vector)
388  /// Check if a value has been assigned to Data data member.
389  ///
390  /// Data member Data is optional;
391  /// its type is defined as 'typedef vector< CRef< CPC_AssayData > > TData'
392  /// @return
393  /// - true, if a value has been assigned.
394  /// - false, otherwise.
395  bool IsSetData(void) const;
396 
397  /// Check if it is safe to call GetData method.
398  ///
399  /// @return
400  /// - true, if the data member is getatable.
401  /// - false, otherwise.
402  bool CanGetData(void) const;
403 
404  /// Reset Data data member.
405  void ResetData(void);
406 
407  /// Get the Data member data.
408  ///
409  /// @return
410  /// Reference to the member data.
411  const TData& GetData(void) const;
412 
413  /// Assign a value to Data data member.
414  ///
415  /// @return
416  /// Reference to the data value.
417  TData& SetData(void);
418 
419  /// Depositor provided URL for this Result
420  /// Check if a value has been assigned to Url data member.
421  ///
422  /// Data member Url is optional;
423  /// its type is defined as 'typedef CStringUTF8 TUrl'
424  /// @return
425  /// - true, if a value has been assigned.
426  /// - false, otherwise.
427  bool IsSetUrl(void) const;
428 
429  /// Check if it is safe to call GetUrl method.
430  ///
431  /// @return
432  /// - true, if the data member is getatable.
433  /// - false, otherwise.
434  bool CanGetUrl(void) const;
435 
436  /// Reset Url data member.
437  void ResetUrl(void);
438 
439  /// Get the Url member data.
440  ///
441  /// @return
442  /// Reference to the member data.
443  const TUrl& GetUrl(void) const;
444 
445  /// Assign a value to Url data member.
446  ///
447  /// @param value
448  /// Value to assign
449  void SetUrl(const TUrl& value);
450  void SetUrl(TUrl&& value);
451 
452  /// Assign a value to Url data member.
453  ///
454  /// @return
455  /// Reference to the data value.
456  TUrl& SetUrl(void);
457 
458  /// annotated Cross-Reference Information
459  /// to be removed,
460  /// instead regulard TID will be generated
461  /// which are then annotated by xref type
462  /// Check if a value has been assigned to Xref data member.
463  ///
464  /// Data member Xref is optional;
465  /// its type is defined as 'typedef list< CRef< CPC_AnnotatedXRef > > TXref'
466  /// @return
467  /// - true, if a value has been assigned.
468  /// - false, otherwise.
469  bool IsSetXref(void) const;
470 
471  /// Check if it is safe to call GetXref method.
472  ///
473  /// @return
474  /// - true, if the data member is getatable.
475  /// - false, otherwise.
476  bool CanGetXref(void) const;
477 
478  /// Reset Xref data member.
479  void ResetXref(void);
480 
481  /// Get the Xref member data.
482  ///
483  /// @return
484  /// Reference to the member data.
485  const TXref& GetXref(void) const;
486 
487  /// Assign a value to Xref data member.
488  ///
489  /// @return
490  /// Reference to the data value.
491  TXref& SetXref(void);
492 
493  /// Pubchem Release Date
494  /// Check if a value has been assigned to Date data member.
495  ///
496  /// Data member Date is optional;
497  /// its type is defined as 'typedef objects::CDate TDate'
498  /// @return
499  /// - true, if a value has been assigned.
500  /// - false, otherwise.
501  bool IsSetDate(void) const;
502 
503  /// Check if it is safe to call GetDate method.
504  ///
505  /// @return
506  /// - true, if the data member is getatable.
507  /// - false, otherwise.
508  bool CanGetDate(void) const;
509 
510  /// Reset Date data member.
511  void ResetDate(void);
512 
513  /// Get the Date member data.
514  ///
515  /// @return
516  /// Reference to the member data.
517  const TDate& GetDate(void) const;
518 
519  /// Assign a value to Date data member.
520  ///
521  /// @param value
522  /// Reference to value.
524 
525  /// Assign a value to Date data member.
526  ///
527  /// @return
528  /// Reference to the data value.
529  TDate& SetDate(void);
530 
531  /// Reset the whole object
532  virtual void Reset(void);
533 
534 
535 private:
536  // Prohibit copy constructor and assignment operator
539 
540  // data
541  Uint4 m_set_State[1];
542  int m_Sid;
544  int m_Version;
546  int m_Outcome;
547  int m_Rank;
548  vector< CRef< CPC_AssayData > > m_Data;
550  list< CRef< CPC_AnnotatedXRef > > m_Xref;
552 };
553 
554 /* @} */
555 
556 
557 
558 
559 
560 ///////////////////////////////////////////////////////////
561 ///////////////////// inline methods //////////////////////
562 ///////////////////////////////////////////////////////////
563 inline
564 bool CPC_AssayResults_Base::IsSetSid(void) const
565 {
566  return ((m_set_State[0] & 0x3) != 0);
567 }
568 
569 inline
570 bool CPC_AssayResults_Base::CanGetSid(void) const
571 {
572  return IsSetSid();
573 }
574 
575 inline
577 {
578  m_Sid = 0;
579  m_set_State[0] &= ~0x3;
580 }
581 
582 inline
584 {
585  if (!CanGetSid()) {
586  ThrowUnassigned(0);
587  }
588  return m_Sid;
589 }
590 
591 inline
593 {
594  m_Sid = value;
595  m_set_State[0] |= 0x3;
596 }
597 
598 inline
600 {
601 #ifdef _DEBUG
602  if (!IsSetSid()) {
603  memset(&m_Sid,UnassignedByte(),sizeof(m_Sid));
604  }
605 #endif
606  m_set_State[0] |= 0x1;
607  return m_Sid;
608 }
609 
610 inline
612 {
613  return m_Sid_source.NotEmpty();
614 }
615 
616 inline
618 {
619  return IsSetSid_source();
620 }
621 
622 inline
624 {
625  if (!CanGetSid_source()) {
626  ThrowUnassigned(1);
627  }
628  return (*m_Sid_source);
629 }
630 
631 inline
633 {
634  return ((m_set_State[0] & 0x30) != 0);
635 }
636 
637 inline
639 {
640  return IsSetVersion();
641 }
642 
643 inline
645 {
646  m_Version = 0;
647  m_set_State[0] &= ~0x30;
648 }
649 
650 inline
652 {
653  if (!CanGetVersion()) {
654  ThrowUnassigned(2);
655  }
656  return m_Version;
657 }
658 
659 inline
661 {
662  m_Version = value;
663  m_set_State[0] |= 0x30;
664 }
665 
666 inline
668 {
669 #ifdef _DEBUG
670  if (!IsSetVersion()) {
671  memset(&m_Version,UnassignedByte(),sizeof(m_Version));
672  }
673 #endif
674  m_set_State[0] |= 0x10;
675  return m_Version;
676 }
677 
678 inline
680 {
681  return ((m_set_State[0] & 0xc0) != 0);
682 }
683 
684 inline
686 {
687  return IsSetComment();
688 }
689 
690 inline
692 {
693  if (!CanGetComment()) {
694  ThrowUnassigned(3);
695  }
696  return m_Comment;
697 }
698 
699 inline
701 {
702  m_Comment = value;
703  m_set_State[0] |= 0xc0;
704 }
705 
706 inline
708 {
709  m_Comment = std::forward<CPC_AssayResults_Base::TComment>(value);
710  m_set_State[0] |= 0xc0;
711 }
712 
713 inline
715 {
716 #ifdef _DEBUG
717  if (!IsSetComment()) {
719  }
720 #endif
721  m_set_State[0] |= 0x40;
722  return m_Comment;
723 }
724 
725 inline
727 {
728  return ((m_set_State[0] & 0x300) != 0);
729 }
730 
731 inline
733 {
734  return true;
735 }
736 
737 inline
739 {
741  m_set_State[0] &= ~0x300;
742 }
743 
744 inline
746 {
747  ResetOutcome();
748 }
749 
750 inline
752 {
753  return m_Outcome;
754 }
755 
756 inline
758 {
759  m_Outcome = value;
760  m_set_State[0] |= 0x300;
761 }
762 
763 inline
765 {
766 #ifdef _DEBUG
767  if (!IsSetOutcome()) {
768  memset(&m_Outcome,UnassignedByte(),sizeof(m_Outcome));
769  }
770 #endif
771  m_set_State[0] |= 0x100;
772  return m_Outcome;
773 }
774 
775 inline
776 bool CPC_AssayResults_Base::IsSetRank(void) const
777 {
778  return ((m_set_State[0] & 0xc00) != 0);
779 }
780 
781 inline
782 bool CPC_AssayResults_Base::CanGetRank(void) const
783 {
784  return IsSetRank();
785 }
786 
787 inline
789 {
790  m_Rank = 0;
791  m_set_State[0] &= ~0xc00;
792 }
793 
794 inline
796 {
797  if (!CanGetRank()) {
798  ThrowUnassigned(5);
799  }
800  return m_Rank;
801 }
802 
803 inline
805 {
806  m_Rank = value;
807  m_set_State[0] |= 0xc00;
808 }
809 
810 inline
812 {
813 #ifdef _DEBUG
814  if (!IsSetRank()) {
815  memset(&m_Rank,UnassignedByte(),sizeof(m_Rank));
816  }
817 #endif
818  m_set_State[0] |= 0x400;
819  return m_Rank;
820 }
821 
822 inline
823 bool CPC_AssayResults_Base::IsSetData(void) const
824 {
825  return ((m_set_State[0] & 0x3000) != 0);
826 }
827 
828 inline
829 bool CPC_AssayResults_Base::CanGetData(void) const
830 {
831  return true;
832 }
833 
834 inline
836 {
837  return m_Data;
838 }
839 
840 inline
842 {
843  m_set_State[0] |= 0x1000;
844  return m_Data;
845 }
846 
847 inline
848 bool CPC_AssayResults_Base::IsSetUrl(void) const
849 {
850  return ((m_set_State[0] & 0xc000) != 0);
851 }
852 
853 inline
854 bool CPC_AssayResults_Base::CanGetUrl(void) const
855 {
856  return IsSetUrl();
857 }
858 
859 inline
861 {
862  if (!CanGetUrl()) {
863  ThrowUnassigned(7);
864  }
865  return m_Url;
866 }
867 
868 inline
870 {
871  m_Url = value;
872  m_set_State[0] |= 0xc000;
873 }
874 
875 inline
877 {
878  m_Url = std::forward<CPC_AssayResults_Base::TUrl>(value);
879  m_set_State[0] |= 0xc000;
880 }
881 
882 inline
884 {
885 #ifdef _DEBUG
886  if (!IsSetUrl()) {
888  }
889 #endif
890  m_set_State[0] |= 0x4000;
891  return m_Url;
892 }
893 
894 inline
895 bool CPC_AssayResults_Base::IsSetXref(void) const
896 {
897  return ((m_set_State[0] & 0x30000) != 0);
898 }
899 
900 inline
901 bool CPC_AssayResults_Base::CanGetXref(void) const
902 {
903  return true;
904 }
905 
906 inline
908 {
909  return m_Xref;
910 }
911 
912 inline
914 {
915  m_set_State[0] |= 0x10000;
916  return m_Xref;
917 }
918 
919 inline
920 bool CPC_AssayResults_Base::IsSetDate(void) const
921 {
922  return m_Date.NotEmpty();
923 }
924 
925 inline
926 bool CPC_AssayResults_Base::CanGetDate(void) const
927 {
928  return IsSetDate();
929 }
930 
931 inline
933 {
934  if (!CanGetDate()) {
935  ThrowUnassigned(9);
936  }
937  return (*m_Date);
938 }
939 
940 ///////////////////////////////////////////////////////////
941 ////////////////// end of inline methods //////////////////
942 ///////////////////////////////////////////////////////////
943 
944 
945 
946 
947 
948 END_pcassay2_SCOPE // namespace ncbi::objects::pcassay2::
949 
950 END_objects_SCOPE // namespace ncbi::objects::
951 
953 
954 
955 #endif // OBJECTS_PCASSAY2_PC_ASSAYRESULTS_BASE_HPP
Definition: Date.hpp:53
CPC_AnnotatedXRef –.
CPC_AssayData –.
Container for multiple Assay Result Sets PC-AssayResultsSet ::= SEQUENCE OF PC-AssayResults Assay Res...
CPC_Source –.
Definition: PC_Source.hpp:66
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
#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
std::string CStringUTF8
Definition: ncbistl.hpp:254
TVersion GetVersion(void) const
Get the Version member data.
bool CanGetComment(void) const
Check if it is safe to call GetComment method.
TSid_source & SetSid_source(void)
Assign a value to Sid_source data member.
const TDate & GetDate(void) const
Get the Date member data.
bool IsSetComment(void) const
Data Annotation/Qualifier and URL to further Depositor Information Annotation or qualifier for this R...
bool IsSetDate(void) const
Pubchem Release Date Check if a value has been assigned to Date data member.
void SetComment(TComment &&value)
bool IsSetData(void) const
Assay Data Reported for this SID (vector) Check if a value has been assigned to Data data member.
void SetSid_source(TSid_source &value)
Assign a value to Sid_source data member.
TRank GetRank(void) const
Get the Rank member data.
void ResetSid_source(void)
Reset Sid_source data member.
bool IsSetOutcome(void) const
Check if a value has been assigned to Outcome data member.
bool IsSetSid(void) const
Internal/External Tracking Information Tested Substance ID/Version [Either valid ID or,...
TComment & SetComment(void)
Assign a value to Comment data member.
void SetDefaultOutcome(void)
Assign default value to Outcome data member.
bool CanGetUrl(void) const
Check if it is safe to call GetUrl method.
void SetSid(TSid value)
Assign a value to Sid data member.
bool CanGetData(void) const
Check if it is safe to call GetData method.
bool CanGetXref(void) const
Check if it is safe to call GetXref method.
bool CanGetSid(void) const
Check if it is safe to call GetSid method.
objects::CPC_Source TSid_source
void ResetDate(void)
Reset Date data member.
const TXref & GetXref(void) const
Get the Xref member data.
void SetRank(TRank value)
Assign a value to Rank data member.
bool CanGetOutcome(void) const
Check if it is safe to call GetOutcome method.
list< CRef< CPC_AnnotatedXRef > > TXref
void ResetData(void)
Reset Data data member.
bool CanGetSid_source(void) const
Check if it is safe to call GetSid_source method.
void SetOutcome(TOutcome value)
Assign a value to Outcome data member.
virtual ~CPC_AssayResults_Base(void)
void ResetUrl(void)
Reset Url data member.
void ResetVersion(void)
Reset Version data member.
TSid GetSid(void) const
Get the Sid member data.
bool IsSetUrl(void) const
Depositor provided URL for this Result Check if a value has been assigned to Url data member.
bool IsSetVersion(void) const
Version identifier for this AID-SID Result Note: Incoming data should set this to be "0" Check if a v...
const TData & GetData(void) const
Get the Data member data.
void ResetOutcome(void)
Reset Outcome data member.
TOutcome & SetOutcome(void)
Assign a value to Outcome data member.
const TSid_source & GetSid_source(void) const
Get the Sid_source member data.
void SetDate(TDate &value)
Assign a value to Date data member.
void ResetComment(void)
Reset Comment data member.
bool IsSetRank(void) const
Rank of Assay Outcome (for result ordering) Note: Larger numbers are more active Check if a value has...
TData & SetData(void)
Assign a value to Data data member.
void ResetSid(void)
Reset Sid data member.
TXref & SetXref(void)
Assign a value to Xref data member.
void ResetRank(void)
Reset Rank data member.
TOutcome GetOutcome(void) const
Get the Outcome member data.
CPC_AssayResults_Base & operator=(const CPC_AssayResults_Base &)
TSid & SetSid(void)
Assign a value to Sid data member.
TRank & SetRank(void)
Assign a value to Rank data member.
TUrl & SetUrl(void)
Assign a value to Url data member.
vector< CRef< CPC_AssayData > > TData
void SetUrl(const TUrl &value)
Assign a value to Url data member.
bool CanGetDate(void) const
Check if it is safe to call GetDate method.
virtual void Reset(void)
Reset the whole object.
const TUrl & GetUrl(void) const
Get the Url member data.
bool IsSetSid_source(void) const
External Identifier for this Substance Note: May be used in-lieu of "sid" Note: This is non-optional ...
bool CanGetRank(void) const
Check if it is safe to call GetRank method.
CPC_AssayResults_Base(const CPC_AssayResults_Base &)
TVersion & SetVersion(void)
Assign a value to Version data member.
bool IsSetXref(void) const
annotated Cross-Reference Information to be removed, instead regulard TID will be generated which are...
void ResetXref(void)
Reset Xref data member.
void SetUrl(TUrl &&value)
TDate & SetDate(void)
Assign a value to Date data member.
const TComment & GetComment(void) const
Get the Comment member data.
Tparent::CMemberIndex< E_memberIndex, 11 > TmemberIndex
void SetVersion(TVersion value)
Assign a value to Version data member.
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
void SetComment(const TComment &value)
Assign a value to Comment data member.
@ eOutcome_probe
Substance Outcome is Unspecified.
@ eOutcome_inconclusive
Substance is Inconclusive.
@ eOutcome_unspecified
Substance Outcome is Unspecified.
@ eOutcome_inactive
Substance is considered Inactive.
@ eOutcome_active
Substance is considered Active.
const TSid_source & GetSid_source(void) const
Get the Sid_source member data.
bool CanGetComment(void) const
Check if it is safe to call GetComment method.
TXref & SetXref(void)
Assign a value to Xref data member.
TVersion GetVersion(void) const
Get the Version member data.
TOutcome & SetOutcome(void)
Assign a value to Outcome data member.
bool IsSetComment(void) const
Data Annotation/Qualifier and URL to further Depositor Information Annotation or qualifier for this R...
bool IsSetDate(void) const
Pubchem Release Date Check if a value has been assigned to Date data member.
bool IsSetData(void) const
Assay Data Reported for this SID (vector) Check if a value has been assigned to Data data member.
bool IsSetOutcome(void) const
Check if a value has been assigned to Outcome data member.
bool IsSetSid(void) const
Internal/External Tracking Information Tested Substance ID/Version [Either valid ID or,...
void SetDefaultOutcome(void)
Assign default value to Outcome data member.
bool CanGetUrl(void) const
Check if it is safe to call GetUrl method.
TRank GetRank(void) const
Get the Rank member data.
bool CanGetData(void) const
Check if it is safe to call GetData method.
const TXref & GetXref(void) const
Get the Xref member data.
bool CanGetXref(void) const
Check if it is safe to call GetXref method.
bool CanGetSid(void) const
Check if it is safe to call GetSid method.
CRef< TSid_source > m_Sid_source
TVersion & SetVersion(void)
Assign a value to Version data member.
const TUrl & GetUrl(void) const
Get the Url member data.
bool CanGetOutcome(void) const
Check if it is safe to call GetOutcome method.
list< CRef< CPC_AnnotatedXRef > > TXref
bool CanGetSid_source(void) const
Check if it is safe to call GetSid_source method.
vector< CRef< CPC_AssayData > > m_Data
void ResetVersion(void)
Reset Version data member.
const TComment & GetComment(void) const
Get the Comment member data.
TOutcome GetOutcome(void) const
Get the Outcome member data.
bool IsSetUrl(void) const
Depositor provided URL for this Result Check if a value has been assigned to Url data member.
bool IsSetVersion(void) const
Version identifier for this AID-SID Result Note: Incoming data should set this to be "0" Check if a v...
void ResetOutcome(void)
Reset Outcome data member.
const TData & GetData(void) const
Get the Data member data.
bool IsSetRank(void) const
Rank of Assay Outcome (for result ordering) Note: Larger numbers are more active Check if a value has...
void ResetSid(void)
Reset Sid data member.
void ResetRank(void)
Reset Rank data member.
TSid GetSid(void) const
Get the Sid member data.
list< CRef< CPC_AnnotatedXRef > > m_Xref
vector< CRef< CPC_AssayData > > TData
TUrl & SetUrl(void)
Assign a value to Url data member.
bool CanGetDate(void) const
Check if it is safe to call GetDate method.
EOutcome
Assay Result Data for this Sample Note: Users need populate only those "tid"s, for which there is dat...
TComment & SetComment(void)
Assign a value to Comment data member.
TData & SetData(void)
Assign a value to Data data member.
TSid & SetSid(void)
Assign a value to Sid data member.
bool IsSetSid_source(void) const
External Identifier for this Substance Note: May be used in-lieu of "sid" Note: This is non-optional ...
bool CanGetRank(void) const
Check if it is safe to call GetRank method.
bool IsSetXref(void) const
annotated Cross-Reference Information to be removed, instead regulard TID will be generated which are...
const TDate & GetDate(void) const
Get the Date member data.
TRank & SetRank(void)
Assign a value to Rank data member.
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
#define END_pcassay2_SCOPE
#define BEGIN_pcassay2_SCOPE
Modified on Sun Jun 16 04:35:21 2024 by modify_doxy.py rev. 669887