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

Go to the SVN repository for this file.

1 /* $Id: Linkage_evidence.hpp 63086 2014-05-28 12:53:09Z bollin $
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 Linkage_evidence.hpp
29 /// User-defined methods of the data storage class.
30 ///
31 /// This file was originally generated by application DATATOOL
32 /// using the following specifications:
33 /// 'seq.asn'.
34 ///
35 /// New methods or data members can be added to it if needed.
36 /// See also: Linkage_evidence_.hpp
37 
38 
39 #ifndef OBJECTS_SEQ_LINKAGE_EVIDENCE_HPP
40 #define OBJECTS_SEQ_LINKAGE_EVIDENCE_HPP
41 
42 
43 // generated includes
45 
46 // generated classes
47 
49 
50 BEGIN_objects_SCOPE // namespace ncbi::objects::
51 
52 /////////////////////////////////////////////////////////////////////////////
54 {
56 public:
57  // constructor
58  CLinkage_evidence(void);
59  // destructor
60  ~CLinkage_evidence(void);
61 
62  typedef list< CRef< CLinkage_evidence > > TLinkage_evidence;
63 
64  // Convert a raw string into a container of linkage-evidence.
65  // The result is appended to output_result.
66  // @param output_result The result is appended to this.
67  // @param linkage_evidence string, semicolon-separated list of
68  // linkage-evidences.
69  // @return true if succeeded. If false, output_result is
70  // guaranteed to be restored to its original state.
71  static bool GetLinkageEvidence (
72  TLinkage_evidence& output_result,
73  const string& linkage_evidence );
74 
75  // Convert a vector of strings into a container of linkage-evidence.
76  // The result is appended to output_result.
77  // @param output_result The result is appended to this.
78  // @param linkage_evidence each string in the vector is one linkage-evidence.
79  // @return true if succeeded. If false, output_result is
80  // guaranteed to be restored to its original state.
81  static bool GetLinkageEvidence(
82  TLinkage_evidence& output_result,
83  const vector<string> &linkage_evidence );
84 
85  // Convert a container of CLinkage_evidence into a
86  // semicolon-delimited string.
87  // @param output_result the result
88  // @return False doesn't exactly imply failure, per se.
89  // True if every linkage_evidence could be converted to a string.
90  // If false, output_result will contain the string "UNKNOWN"
91  // in some places,
92  // representing a linkage_evidence(s) we couldn't convert, but
93  // the rest of the string will be fine.
94  static bool VecToString( string & output_result,
95  const TLinkage_evidence & linkage_evidence );
96 
97 private:
98  // Prohibit copy constructor and assignment operator
101 
102 };
103 
104 /////////////////// CLinkage_evidence inline methods
105 
106 // constructor
107 inline
109 {
110 }
111 
112 
113 /////////////////// end of CLinkage_evidence inline methods
114 
115 
116 END_objects_SCOPE // namespace ncbi::objects::
117 
119 
120 
121 #endif // OBJECTS_SEQ_LINKAGE_EVIDENCE_HPP
122 /* Original file checksum: lines: 86, chars: 2525, CRC32: 5681c8d4 */
Data storage class.
CLinkage_evidence_Base –.
list< CRef< CLinkage_evidence > > TLinkage_evidence
CLinkage_evidence & operator=(const CLinkage_evidence &value)
CLinkage_evidence_Base Tparent
CLinkage_evidence(const CLinkage_evidence &value)
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_SEQ_EXPORT
Definition: ncbi_export.h:825
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed May 22 11:31:30 2024 by modify_doxy.py rev. 669887