1 /* $Id: Seq_gap.hpp 494120 2016-03-03 18:29:40Z gotvyans $
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 Seq_gap.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: Seq_gap_.hpp
37
38
39 #ifndef OBJECTS_SEQ_SEQ_GAP_HPP
40 #define OBJECTS_SEQ_SEQ_GAP_HPP
41
42
43 // generated includes
44 #include <objects/seq/Seq_gap_.hpp>
45
46 #include <objects/seq/Linkage_evidence.hpp>
47
48 // generated classes
49
50
51 BEGIN_NCBI_SCOPE
52
53 template <class KeyType, class ValueType, class KeyCompare >
54 class CStaticArrayMap;
55
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57
58 /////////////////////////////////////////////////////////////////////////////
59 class NCBI_SEQ_EXPORT CSeq_gap : public CSeq_gap_Base
60 {
61 typedef CSeq_gap_Base Tparent;
62 public:
63 // constructor
64 CSeq_gap(void);
65 // destructor
66 ~CSeq_gap(void);
67
68 void ChangeType(TType linkage_type);
69 void SetLinkageTypeScaffold(CLinkage_evidence::TType evidence_type);
70 void SetLinkageTypeLinkedRepeat(CLinkage_evidence::TType evidence_type);
71 bool AddLinkageEvidence(CLinkage_evidence::TType evidence_type);
72
73 /// indicates which linkage-evidences a given gap-type
74 /// can accept, if any
75 enum ELinkEvid {
76 /// only the "unspecified" linkage-evidence is allowed
77 eLinkEvid_UnspecifiedOnly,
78 /// no linkage-evidence is allowed
79 eLinkEvid_Forbidden,
80 /// any linkage-evidence is allowed, and at least one is required
81 eLinkEvid_Required,
82 };
83 /// Holds information about a given gap-type string
84 struct SGapTypeInfo {
85 /// The underlying type that the string corresponds to
86 CSeq_gap::EType m_eType;
87 /// Indicates what linkage-evidences are compatible with this
88 ELinkEvid m_eLinkEvid;
89 };
90 /// Map a gap-type string to its information
91 /// Note that PCase_CStr, which means direct lookup is
92 /// NOT insensitive to case, etc.
93 typedef CStaticArrayMap<const char *, SGapTypeInfo, PCase_CStr> TGapTypeMap;
94
95 /// From a gap-type string, get the SGapTypeInfo,
96 /// insensitive to case, etc. This is NOT quite the same as calling
97 /// find on the TGapTypeMap.
98 ///
99 /// @returns NULL if not found
100 static const SGapTypeInfo * NameToGapTypeInfo(const CTempString & sName);
101 /// This is for if the user needs to get the gap-type string
102 /// to SGapTypeInfo info directly (For example, to iterate through
103 /// all possible types).
104 static const TGapTypeMap & GetNameToGapTypeInfoMap(void);
105
106
107 private:
108 // Prohibit copy constructor and assignment operator
109 CSeq_gap(const CSeq_gap& value);
110 CSeq_gap& operator=(const CSeq_gap& value);
111
112 };
113
114 /////////////////// CSeq_gap inline methods
115
116 // constructor
117 inline
CSeq_gap(void)118 CSeq_gap::CSeq_gap(void)
119 {
120 }
121
122
123 /////////////////// end of CSeq_gap inline methods
124
125
126 END_objects_SCOPE // namespace ncbi::objects::
127
128 END_NCBI_SCOPE
129
130
131 #endif // OBJECTS_SEQ_SEQ_GAP_HPP
132 /* Original file checksum: lines: 86, chars: 2354, CRC32: 25e00c0f */
133