NCBI C++ ToolKit
GCClient_GetAssemblyBySequ_.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 GCClient_GetAssemblyBySequ_.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/genomecoll/gencoll_client.asn">gencoll_client.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/genomecoll/gencoll_client.def">gencoll_client.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_GENOMECOLL_GCCLIENT_GETASSEMBLYBYSEQU_BASE_HPP
42 #define OBJECTS_GENOMECOLL_GCCLIENT_GETASSEMBLYBYSEQU_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
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 // generated classes
62 
63 
64 /** @addtogroup dataspec_NCBI_GencollClient
65  *
66  * @{
67  */
68 
69 /////////////////////////////////////////////////////////////////////////////
70 ///
71 /// CGCClient_GetAssemblyBySequenceRequest_Base --
72 ///
73 
75 {
77 public:
78  // constructor
80  // destructor
82 
83  // type info
85 
86  enum ESort {
89  eSort_major = 2
90  };
91 
92  /// Access to ESort's attributes (values, names) as defined in spec
93  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ESort)(void);
94 
95  // types
96  typedef list< string > TSequence_acc;
97  typedef int TFilter;
98  typedef int TSort;
99  typedef int TTop_assembly_only;
100  typedef bool TAdd_sequence_roles;
101 
102  // member index
103  enum class E_memberIndex {
104  e__allMandatory = 0,
106  e_filter,
107  e_sort,
110  };
112 
113  // getters
114  // setters
115 
116  /// Check if a value has been assigned to Sequence_acc data member.
117  ///
118  /// Data member Sequence_acc is mandatory;
119  /// its type is defined as 'typedef list< string > TSequence_acc'
120  /// @return
121  /// - true, if a value has been assigned.
122  /// - false, otherwise.
123  bool IsSetSequence_acc(void) const;
124 
125  /// Check if it is safe to call GetSequence_acc method.
126  ///
127  /// @return
128  /// - true, if the data member is getatable.
129  /// - false, otherwise.
130  bool CanGetSequence_acc(void) const;
131 
132  /// Reset Sequence_acc data member.
133  void ResetSequence_acc(void);
134 
135  /// Get the Sequence_acc member data.
136  ///
137  /// @return
138  /// Reference to the member data.
139  const TSequence_acc& GetSequence_acc(void) const;
140 
141  /// Assign a value to Sequence_acc data member.
142  ///
143  /// @return
144  /// Reference to the data value.
146 
147  /// Check if a value has been assigned to Filter data member.
148  ///
149  /// Data member Filter is optional with default eGCClient_GetAssemblyBySequenceFilter_all;
150  /// its type is defined as 'typedef int TFilter'
151  /// @return
152  /// - true, if a value has been assigned.
153  /// - false, otherwise.
154  bool IsSetFilter(void) const;
155 
156  /// Check if it is safe to call GetFilter method.
157  ///
158  /// @return
159  /// - true, if the data member is getatable.
160  /// - false, otherwise.
161  bool CanGetFilter(void) const;
162 
163  /// Reset Filter data member.
164  void ResetFilter(void);
165 
166  /// Assign default value to Filter data member.
167  void SetDefaultFilter(void);
168 
169  /// Get the Filter member data.
170  ///
171  /// @return
172  /// Copy of the member data.
173  TFilter GetFilter(void) const;
174 
175  /// Assign a value to Filter data member.
176  ///
177  /// @param value
178  /// Value to assign
179  void SetFilter(TFilter value);
180 
181  /// Assign a value to Filter data member.
182  ///
183  /// @return
184  /// Reference to the data value.
185  TFilter& SetFilter(void);
186 
187  /// Check if a value has been assigned to Sort data member.
188  ///
189  /// Data member Sort is optional with default eSort_default;
190  /// its type is defined as 'typedef int TSort'
191  /// @return
192  /// - true, if a value has been assigned.
193  /// - false, otherwise.
194  bool IsSetSort(void) const;
195 
196  /// Check if it is safe to call GetSort method.
197  ///
198  /// @return
199  /// - true, if the data member is getatable.
200  /// - false, otherwise.
201  bool CanGetSort(void) const;
202 
203  /// Reset Sort data member.
204  void ResetSort(void);
205 
206  /// Assign default value to Sort data member.
207  void SetDefaultSort(void);
208 
209  /// Get the Sort member data.
210  ///
211  /// @return
212  /// Copy of the member data.
213  TSort GetSort(void) const;
214 
215  /// Assign a value to Sort data member.
216  ///
217  /// @param value
218  /// Value to assign
219  void SetSort(TSort value);
220 
221  /// Assign a value to Sort data member.
222  ///
223  /// @return
224  /// Reference to the data value.
225  TSort& SetSort(void);
226 
227  /// Check if a value has been assigned to Top_assembly_only data member.
228  ///
229  /// Data member Top_assembly_only is optional with default 0;
230  /// its type is defined as 'typedef int TTop_assembly_only'
231  /// @return
232  /// - true, if a value has been assigned.
233  /// - false, otherwise.
234  bool IsSetTop_assembly_only(void) const;
235 
236  /// Check if it is safe to call GetTop_assembly_only method.
237  ///
238  /// @return
239  /// - true, if the data member is getatable.
240  /// - false, otherwise.
241  bool CanGetTop_assembly_only(void) const;
242 
243  /// Reset Top_assembly_only data member.
244  void ResetTop_assembly_only(void);
245 
246  /// Assign default value to Top_assembly_only data member.
247  void SetDefaultTop_assembly_only(void);
248 
249  /// Get the Top_assembly_only member data.
250  ///
251  /// @return
252  /// Copy of the member data.
254 
255  /// Assign a value to Top_assembly_only data member.
256  ///
257  /// @param value
258  /// Value to assign
260 
261  /// Assign a value to Top_assembly_only data member.
262  ///
263  /// @return
264  /// Reference to the data value.
266 
267  /// Check if a value has been assigned to Add_sequence_roles data member.
268  ///
269  /// Data member Add_sequence_roles is optional;
270  /// its type is defined as 'typedef bool TAdd_sequence_roles'
271  /// @return
272  /// - true, if a value has been assigned.
273  /// - false, otherwise.
274  bool IsSetAdd_sequence_roles(void) const;
275 
276  /// Check if it is safe to call GetAdd_sequence_roles method.
277  ///
278  /// @return
279  /// - true, if the data member is getatable.
280  /// - false, otherwise.
281  bool CanGetAdd_sequence_roles(void) const;
282 
283  /// Reset Add_sequence_roles data member.
284  void ResetAdd_sequence_roles(void);
285 
286  /// Get the Add_sequence_roles member data.
287  ///
288  /// @return
289  /// Copy of the member data.
291 
292  /// Assign a value to Add_sequence_roles data member.
293  ///
294  /// @param value
295  /// Value to assign
297 
298  /// Assign a value to Add_sequence_roles data member.
299  ///
300  /// @return
301  /// Reference to the data value.
303 
304  /// Reset the whole object
305  virtual void Reset(void);
306 
307 
308 private:
309  // Prohibit copy constructor and assignment operator
312 
313  // data
315  list< string > m_Sequence_acc;
316  int m_Filter;
317  int m_Sort;
320 };
321 /// This is a bitfield. All values are powers of two.
328 };
329 
330 /// Access to EGCClient_GetAssemblyBySequenceFilter's attributes (values, names) as defined in spec
331  const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EGCClient_GetAssemblyBySequenceFilter)(void);
332 
333 
334 /* @} */
335 
336 
337 
338 
339 
340 ///////////////////////////////////////////////////////////
341 ///////////////////// inline methods //////////////////////
342 ///////////////////////////////////////////////////////////
343 inline
345 {
346  return ((m_set_State[0] & 0x3) != 0);
347 }
348 
349 inline
351 {
352  return true;
353 }
354 
355 inline
357 {
358  return m_Sequence_acc;
359 }
360 
361 inline
363 {
364  m_set_State[0] |= 0x1;
365  return m_Sequence_acc;
366 }
367 
368 inline
370 {
371  return ((m_set_State[0] & 0xc) != 0);
372 }
373 
374 inline
376 {
377  return true;
378 }
379 
380 inline
382 {
384  m_set_State[0] &= ~0xc;
385 }
386 
387 inline
389 {
390  ResetFilter();
391 }
392 
393 inline
395 {
396  return m_Filter;
397 }
398 
399 inline
401 {
402  m_Filter = value;
403  m_set_State[0] |= 0xc;
404 }
405 
406 inline
408 {
409 #ifdef _DEBUG
410  if (!IsSetFilter()) {
411  memset(&m_Filter,UnassignedByte(),sizeof(m_Filter));
412  }
413 #endif
414  m_set_State[0] |= 0x4;
415  return m_Filter;
416 }
417 
418 inline
420 {
421  return ((m_set_State[0] & 0x30) != 0);
422 }
423 
424 inline
426 {
427  return true;
428 }
429 
430 inline
432 {
434  m_set_State[0] &= ~0x30;
435 }
436 
437 inline
439 {
440  ResetSort();
441 }
442 
443 inline
445 {
446  return m_Sort;
447 }
448 
449 inline
451 {
452  m_Sort = value;
453  m_set_State[0] |= 0x30;
454 }
455 
456 inline
458 {
459 #ifdef _DEBUG
460  if (!IsSetSort()) {
461  memset(&m_Sort,UnassignedByte(),sizeof(m_Sort));
462  }
463 #endif
464  m_set_State[0] |= 0x10;
465  return m_Sort;
466 }
467 
468 inline
470 {
471  return ((m_set_State[0] & 0xc0) != 0);
472 }
473 
474 inline
476 {
477  return true;
478 }
479 
480 inline
482 {
484  m_set_State[0] &= ~0xc0;
485 }
486 
487 inline
489 {
491 }
492 
493 inline
495 {
496  return m_Top_assembly_only;
497 }
498 
499 inline
501 {
503  m_set_State[0] |= 0xc0;
504 }
505 
506 inline
508 {
509 #ifdef _DEBUG
510  if (!IsSetTop_assembly_only()) {
512  }
513 #endif
514  m_set_State[0] |= 0x40;
515  return m_Top_assembly_only;
516 }
517 
518 inline
520 {
521  return ((m_set_State[0] & 0x300) != 0);
522 }
523 
524 inline
526 {
527  return IsSetAdd_sequence_roles();
528 }
529 
530 inline
532 {
534  m_set_State[0] &= ~0x300;
535 }
536 
537 inline
539 {
540  if (!CanGetAdd_sequence_roles()) {
541  ThrowUnassigned(4);
542  }
543  return m_Add_sequence_roles;
544 }
545 
546 inline
548 {
550  m_set_State[0] |= 0x300;
551 }
552 
553 inline
555 {
556 #ifdef _DEBUG
557  if (!IsSetAdd_sequence_roles()) {
559  }
560 #endif
561  m_set_State[0] |= 0x100;
562  return m_Add_sequence_roles;
563 }
564 
565 ///////////////////////////////////////////////////////////
566 ////////////////// end of inline methods //////////////////
567 ///////////////////////////////////////////////////////////
568 
569 
570 
571 
572 
573 END_objects_SCOPE // namespace ncbi::objects::
574 
576 
577 
578 #endif // OBJECTS_GENOMECOLL_GCCLIENT_GETASSEMBLYBYSEQU_BASE_HPP
User-defined methods of the data storage class.
CGCClient_GetAssemblyBySequenceRequest_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
char value[7]
Definition: config.c:431
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
TTop_assembly_only GetTop_assembly_only(void) const
Get the Top_assembly_only member data.
void SetDefaultSort(void)
Assign default value to Sort data member.
bool CanGetAdd_sequence_roles(void) const
Check if it is safe to call GetAdd_sequence_roles method.
bool CanGetSequence_acc(void) const
Check if it is safe to call GetSequence_acc method.
TSequence_acc & SetSequence_acc(void)
Assign a value to Sequence_acc data member.
bool IsSetTop_assembly_only(void) const
Check if a value has been assigned to Top_assembly_only data member.
TAdd_sequence_roles GetAdd_sequence_roles(void) const
Get the Add_sequence_roles member data.
void SetDefaultFilter(void)
Assign default value to Filter data member.
bool IsSetSequence_acc(void) const
Check if a value has been assigned to Sequence_acc data member.
TFilter & SetFilter(void)
Assign a value to Filter data member.
bool IsSetFilter(void) const
Check if a value has been assigned to Filter data member.
CGCClient_GetAssemblyBySequenceRequest_Base & operator=(const CGCClient_GetAssemblyBySequenceRequest_Base &)
bool IsSetAdd_sequence_roles(void) const
Check if a value has been assigned to Add_sequence_roles data member.
bool CanGetSort(void) const
Check if it is safe to call GetSort method.
void SetDefaultTop_assembly_only(void)
Assign default value to Top_assembly_only data member.
void ResetTop_assembly_only(void)
Reset Top_assembly_only data member.
virtual void Reset(void)
Reset the whole object.
TAdd_sequence_roles & SetAdd_sequence_roles(void)
Assign a value to Add_sequence_roles data member.
TFilter GetFilter(void) const
Get the Filter member data.
TSort & SetSort(void)
Assign a value to Sort data member.
bool CanGetFilter(void) const
Check if it is safe to call GetFilter method.
bool IsSetSort(void) const
Check if a value has been assigned to Sort data member.
Tparent::CMemberIndex< E_memberIndex, 6 > TmemberIndex
CGCClient_GetAssemblyBySequenceRequest_Base(const CGCClient_GetAssemblyBySequenceRequest_Base &)
TTop_assembly_only & SetTop_assembly_only(void)
Assign a value to Top_assembly_only data member.
void ResetAdd_sequence_roles(void)
Reset Add_sequence_roles data member.
void ResetSequence_acc(void)
Reset Sequence_acc data member.
TSort GetSort(void) const
Get the Sort member data.
const TSequence_acc & GetSequence_acc(void) const
Get the Sequence_acc member data.
bool CanGetTop_assembly_only(void) const
Check if it is safe to call GetTop_assembly_only method.
EGCClient_GetAssemblyBySequenceFilter
This is a bitfield. All values are powers of two.
@ eGCClient_GetAssemblyBySequenceFilter_all
@ eGCClient_GetAssemblyBySequenceFilter_refseq
@ eGCClient_GetAssemblyBySequenceFilter_latest
@ eGCClient_GetAssemblyBySequenceFilter_major
@ eGCClient_GetAssemblyBySequenceFilter_genbank
Modified on Wed Feb 28 07:15:12 2024 by modify_doxy.py rev. 669887