NCBI C++ ToolKit
ID2S_Seq_id_Ints_.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 ID2S_Seq_id_Ints_.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/seqsplit/seqsplit.asn">seqsplit.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqsplit/seqsplit.def">seqsplit.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_SEQSPLIT_ID2S_SEQ_ID_INTS_BASE_HPP
42 #define OBJECTS_SEQSPLIT_ID2S_SEQ_ID_INTS_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 
51 
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
55 #endif
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57 
58 
59 // forward declarations
60 class CID2S_Interval;
61 class CSeq_id;
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_Seq_split
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 ///
74 /// CID2S_Seq_id_Ints_Base --
75 ///
76 
78 {
80 public:
81  // constructor
83  // destructor
84  virtual ~CID2S_Seq_id_Ints_Base(void);
85 
86  // type info
88 
89  // types
90  typedef CSeq_id TSeq_id;
91  typedef list< CRef< CID2S_Interval > > TInts;
92 
93  // member index
94  enum class E_memberIndex {
95  e__allMandatory = 0,
96  e_seq_id,
97  e_ints
98  };
100 
101  // getters
102  // setters
103 
104  /// Check if a value has been assigned to Seq_id data member.
105  ///
106  /// Data member Seq_id is mandatory;
107  /// its type is defined as 'typedef CSeq_id TSeq_id'
108  /// @return
109  /// - true, if a value has been assigned.
110  /// - false, otherwise.
111  bool IsSetSeq_id(void) const;
112 
113  /// Check if it is safe to call GetSeq_id method.
114  ///
115  /// @return
116  /// - true, if the data member is getatable.
117  /// - false, otherwise.
118  bool CanGetSeq_id(void) const;
119 
120  /// Reset Seq_id data member.
121  void ResetSeq_id(void);
122 
123  /// Get the Seq_id member data.
124  ///
125  /// @return
126  /// Reference to the member data.
127  const TSeq_id& GetSeq_id(void) const;
128 
129  /// Assign a value to Seq_id data member.
130  ///
131  /// @param value
132  /// Reference to value.
133  void SetSeq_id(TSeq_id& value);
134 
135  /// Assign a value to Seq_id data member.
136  ///
137  /// @return
138  /// Reference to the data value.
139  TSeq_id& SetSeq_id(void);
140 
141  /// Check if a value has been assigned to Ints data member.
142  ///
143  /// Data member Ints is mandatory;
144  /// its type is defined as 'typedef list< CRef< CID2S_Interval > > TInts'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetInts(void) const;
149 
150  /// Check if it is safe to call GetInts method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetInts(void) const;
156 
157  /// Reset Ints data member.
158  void ResetInts(void);
159 
160  /// Get the Ints member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TInts& GetInts(void) const;
165 
166  /// Assign a value to Ints data member.
167  ///
168  /// @return
169  /// Reference to the data value.
170  TInts& SetInts(void);
171 
172  /// Reset the whole object
173  virtual void Reset(void);
174 
175 
176 private:
177  // Prohibit copy constructor and assignment operator
180 
181  // data
182  Uint4 m_set_State[1];
184  list< CRef< CID2S_Interval > > m_Ints;
185 };
186 
187 /* @} */
188 
189 
190 
191 
192 
193 ///////////////////////////////////////////////////////////
194 ///////////////////// inline methods //////////////////////
195 ///////////////////////////////////////////////////////////
196 inline
198 {
199  return m_Seq_id.NotEmpty();
200 }
201 
202 inline
204 {
205  return true;
206 }
207 
208 inline
210 {
211  if ( !m_Seq_id ) {
212  const_cast<CID2S_Seq_id_Ints_Base*>(this)->ResetSeq_id();
213  }
214  return (*m_Seq_id);
215 }
216 
217 inline
219 {
220  if ( !m_Seq_id ) {
221  ResetSeq_id();
222  }
223  return (*m_Seq_id);
224 }
225 
226 inline
228 {
229  return ((m_set_State[0] & 0xc) != 0);
230 }
231 
232 inline
234 {
235  return true;
236 }
237 
238 inline
240 {
241  return m_Ints;
242 }
243 
244 inline
246 {
247  m_set_State[0] |= 0x4;
248  return m_Ints;
249 }
250 
251 ///////////////////////////////////////////////////////////
252 ////////////////// end of inline methods //////////////////
253 ///////////////////////////////////////////////////////////
254 
255 
256 
257 
258 
259 END_objects_SCOPE // namespace ncbi::objects::
260 
262 
263 
264 #endif // OBJECTS_SEQSPLIT_ID2S_SEQ_ID_INTS_BASE_HPP
CID2S_Interval –.
CID2S_Seq_id_Ints_Base –.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
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
#define NCBI_ID2_EXPORT
Definition: ncbi_export.h:552
TSeq_id & SetSeq_id(void)
Assign a value to Seq_id data member.
const TSeq_id & GetSeq_id(void) const
Get the Seq_id member data.
bool IsSetInts(void) const
Check if a value has been assigned to Ints data member.
void ResetSeq_id(void)
Reset Seq_id data member.
const TInts & GetInts(void) const
Get the Ints member data.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
list< CRef< CID2S_Interval > > TInts
bool CanGetInts(void) const
Check if it is safe to call GetInts method.
bool IsSetSeq_id(void) const
Check if a value has been assigned to Seq_id data member.
bool CanGetSeq_id(void) const
Check if it is safe to call GetSeq_id method.
CID2S_Seq_id_Ints_Base & operator=(const CID2S_Seq_id_Ints_Base &)
CID2S_Seq_id_Ints_Base(const CID2S_Seq_id_Ints_Base &)
TInts & SetInts(void)
Assign a value to Ints data member.
list< CRef< CID2S_Interval > > m_Ints
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sat Jul 20 11:09:29 2024 by modify_doxy.py rev. 669887