NCBI C++ ToolKit
ID2S_Seq_feat_Ids_Info_.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_feat_Ids_Info_.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_FEAT_IDS_INFO_BASE_HPP
42 #define OBJECTS_SEQSPLIT_ID2S_SEQ_FEAT_IDS_INFO_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
63 
64 
65 // generated classes
66 
67 
68 /** @addtogroup dataspec_NCBI_Seq_split
69  *
70  * @{
71  */
72 
73 /////////////////////////////////////////////////////////////////////////////
74 ///
75 /// CID2S_Seq_feat_Ids_Info_Base --
76 ///
77 
79 {
81 public:
82  // constructor
84  // destructor
85  virtual ~CID2S_Seq_feat_Ids_Info_Base(void);
86 
87  // type info
89 
90  // types
91  typedef list< CRef< CID2S_Feat_type_Info > > TFeat_types;
92  typedef list< CRef< CID2S_Feat_type_Info > > TXref_types;
93  typedef vector< int > TLocal_ids;
94  typedef list< string > TLocal_str_ids;
95 
96  // member index
97  enum class E_memberIndex {
98  e__allMandatory = 0,
99  e_feat_types,
100  e_xref_types,
101  e_local_ids,
102  e_local_str_ids
103  };
105 
106  // getters
107  // setters
108 
109  /// Check if a value has been assigned to Feat_types data member.
110  ///
111  /// Data member Feat_types is optional;
112  /// its type is defined as 'typedef list< CRef< CID2S_Feat_type_Info > > TFeat_types'
113  /// @return
114  /// - true, if a value has been assigned.
115  /// - false, otherwise.
116  bool IsSetFeat_types(void) const;
117 
118  /// Check if it is safe to call GetFeat_types method.
119  ///
120  /// @return
121  /// - true, if the data member is getatable.
122  /// - false, otherwise.
123  bool CanGetFeat_types(void) const;
124 
125  /// Reset Feat_types data member.
126  void ResetFeat_types(void);
127 
128  /// Get the Feat_types member data.
129  ///
130  /// @return
131  /// Reference to the member data.
132  const TFeat_types& GetFeat_types(void) const;
133 
134  /// Assign a value to Feat_types data member.
135  ///
136  /// @return
137  /// Reference to the data value.
138  TFeat_types& SetFeat_types(void);
139 
140  /// Check if a value has been assigned to Xref_types data member.
141  ///
142  /// Data member Xref_types is optional;
143  /// its type is defined as 'typedef list< CRef< CID2S_Feat_type_Info > > TXref_types'
144  /// @return
145  /// - true, if a value has been assigned.
146  /// - false, otherwise.
147  bool IsSetXref_types(void) const;
148 
149  /// Check if it is safe to call GetXref_types method.
150  ///
151  /// @return
152  /// - true, if the data member is getatable.
153  /// - false, otherwise.
154  bool CanGetXref_types(void) const;
155 
156  /// Reset Xref_types data member.
157  void ResetXref_types(void);
158 
159  /// Get the Xref_types member data.
160  ///
161  /// @return
162  /// Reference to the member data.
163  const TXref_types& GetXref_types(void) const;
164 
165  /// Assign a value to Xref_types data member.
166  ///
167  /// @return
168  /// Reference to the data value.
169  TXref_types& SetXref_types(void);
170 
171  /// Check if a value has been assigned to Local_ids data member.
172  ///
173  /// Data member Local_ids is optional;
174  /// its type is defined as 'typedef vector< int > TLocal_ids'
175  /// @return
176  /// - true, if a value has been assigned.
177  /// - false, otherwise.
178  bool IsSetLocal_ids(void) const;
179 
180  /// Check if it is safe to call GetLocal_ids method.
181  ///
182  /// @return
183  /// - true, if the data member is getatable.
184  /// - false, otherwise.
185  bool CanGetLocal_ids(void) const;
186 
187  /// Reset Local_ids data member.
188  void ResetLocal_ids(void);
189 
190  /// Get the Local_ids member data.
191  ///
192  /// @return
193  /// Reference to the member data.
194  const TLocal_ids& GetLocal_ids(void) const;
195 
196  /// Assign a value to Local_ids data member.
197  ///
198  /// @return
199  /// Reference to the data value.
200  TLocal_ids& SetLocal_ids(void);
201 
202  /// Check if a value has been assigned to Local_str_ids data member.
203  ///
204  /// Data member Local_str_ids is optional;
205  /// its type is defined as 'typedef list< string > TLocal_str_ids'
206  /// @return
207  /// - true, if a value has been assigned.
208  /// - false, otherwise.
209  bool IsSetLocal_str_ids(void) const;
210 
211  /// Check if it is safe to call GetLocal_str_ids method.
212  ///
213  /// @return
214  /// - true, if the data member is getatable.
215  /// - false, otherwise.
216  bool CanGetLocal_str_ids(void) const;
217 
218  /// Reset Local_str_ids data member.
219  void ResetLocal_str_ids(void);
220 
221  /// Get the Local_str_ids member data.
222  ///
223  /// @return
224  /// Reference to the member data.
225  const TLocal_str_ids& GetLocal_str_ids(void) const;
226 
227  /// Assign a value to Local_str_ids data member.
228  ///
229  /// @return
230  /// Reference to the data value.
231  TLocal_str_ids& SetLocal_str_ids(void);
232 
233  /// Reset the whole object
234  virtual void Reset(void);
235 
236 
237 private:
238  // Prohibit copy constructor and assignment operator
241 
242  // data
243  Uint4 m_set_State[1];
244  list< CRef< CID2S_Feat_type_Info > > m_Feat_types;
245  list< CRef< CID2S_Feat_type_Info > > m_Xref_types;
246  vector< int > m_Local_ids;
247  list< string > m_Local_str_ids;
248 };
249 
250 /* @} */
251 
252 
253 
254 
255 
256 ///////////////////////////////////////////////////////////
257 ///////////////////// inline methods //////////////////////
258 ///////////////////////////////////////////////////////////
259 inline
261 {
262  return ((m_set_State[0] & 0x3) != 0);
263 }
264 
265 inline
267 {
268  return true;
269 }
270 
271 inline
273 {
274  return m_Feat_types;
275 }
276 
277 inline
279 {
280  m_set_State[0] |= 0x1;
281  return m_Feat_types;
282 }
283 
284 inline
286 {
287  return ((m_set_State[0] & 0xc) != 0);
288 }
289 
290 inline
292 {
293  return true;
294 }
295 
296 inline
298 {
299  return m_Xref_types;
300 }
301 
302 inline
304 {
305  m_set_State[0] |= 0x4;
306  return m_Xref_types;
307 }
308 
309 inline
311 {
312  return ((m_set_State[0] & 0x30) != 0);
313 }
314 
315 inline
317 {
318  return true;
319 }
320 
321 inline
323 {
324  return m_Local_ids;
325 }
326 
327 inline
329 {
330  m_set_State[0] |= 0x10;
331  return m_Local_ids;
332 }
333 
334 inline
336 {
337  return ((m_set_State[0] & 0xc0) != 0);
338 }
339 
340 inline
342 {
343  return true;
344 }
345 
346 inline
348 {
349  return m_Local_str_ids;
350 }
351 
352 inline
354 {
355  m_set_State[0] |= 0x40;
356  return m_Local_str_ids;
357 }
358 
359 ///////////////////////////////////////////////////////////
360 ////////////////// end of inline methods //////////////////
361 ///////////////////////////////////////////////////////////
362 
363 
364 
365 
366 
367 END_objects_SCOPE // namespace ncbi::objects::
368 
370 
371 
372 #endif // OBJECTS_SEQSPLIT_ID2S_SEQ_FEAT_IDS_INFO_BASE_HPP
CID2S_Feat_type_Info –.
CID2S_Seq_feat_Ids_Info_Base –.
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
bool CanGetXref_types(void) const
Check if it is safe to call GetXref_types method.
bool CanGetLocal_str_ids(void) const
Check if it is safe to call GetLocal_str_ids method.
TXref_types & SetXref_types(void)
Assign a value to Xref_types data member.
list< CRef< CID2S_Feat_type_Info > > TFeat_types
list< CRef< CID2S_Feat_type_Info > > TXref_types
CID2S_Seq_feat_Ids_Info_Base & operator=(const CID2S_Seq_feat_Ids_Info_Base &)
const TXref_types & GetXref_types(void) const
Get the Xref_types member data.
const TFeat_types & GetFeat_types(void) const
Get the Feat_types member data.
bool CanGetFeat_types(void) const
Check if it is safe to call GetFeat_types method.
TFeat_types & SetFeat_types(void)
Assign a value to Feat_types data member.
TLocal_str_ids & SetLocal_str_ids(void)
Assign a value to Local_str_ids data member.
const TLocal_str_ids & GetLocal_str_ids(void) const
Get the Local_str_ids member data.
TLocal_ids & SetLocal_ids(void)
Assign a value to Local_ids data member.
bool IsSetXref_types(void) const
Check if a value has been assigned to Xref_types data member.
bool IsSetLocal_str_ids(void) const
Check if a value has been assigned to Local_str_ids data member.
bool IsSetFeat_types(void) const
Check if a value has been assigned to Feat_types data member.
bool IsSetLocal_ids(void) const
Check if a value has been assigned to Local_ids data member.
bool CanGetLocal_ids(void) const
Check if it is safe to call GetLocal_ids method.
const TLocal_ids & GetLocal_ids(void) const
Get the Local_ids member data.
Tparent::CMemberIndex< E_memberIndex, 5 > TmemberIndex
list< CRef< CID2S_Feat_type_Info > > m_Feat_types
list< CRef< CID2S_Feat_type_Info > > m_Xref_types
CID2S_Seq_feat_Ids_Info_Base(const CID2S_Seq_feat_Ids_Info_Base &)
Modified on Fri May 24 14:52:57 2024 by modify_doxy.py rev. 669887