NCBI C++ ToolKit
T3RefreshFlags_.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 T3RefreshFlags_.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/taxon3/taxon3.asn">taxon3.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/taxon3/taxon3.def">taxon3.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_TAXON3_T3REFRESHFLAGS_BASE_HPP
42 #define OBJECTS_TAXON3_T3REFRESHFLAGS_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
47 
48 #ifndef BEGIN_objects_SCOPE
49 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
50 # define END_objects_SCOPE END_SCOPE(objects)
51 #endif
52 BEGIN_objects_SCOPE // namespace ncbi::objects::
53 
54 
55 // generated classes
56 
57 
58 /** @addtogroup dataspec_NCBI_Taxon3
59  *
60  * @{
61  */
62 
63 /////////////////////////////////////////////////////////////////////////////
64 ///
65 /// CT3RefreshFlags_Base --
66 ///
67 
69 {
71 public:
72  // constructor
74  // destructor
75  virtual ~CT3RefreshFlags_Base(void);
76 
77  // type info
79 
80  // types
81  typedef bool TTaxid_changed;
82  typedef bool TTaxname_changed;
83  typedef bool TDivision_changed;
84  typedef bool TLineage_changed;
85  typedef bool TGc_changed;
86  typedef bool TMgc_changed;
87  typedef bool TOrgmod_changed;
88  typedef bool TPgc_changed;
89 
90  // member index
91  enum class E_memberIndex {
92  e__allMandatory = 0,
93  e_taxid_changed,
94  e_taxname_changed,
95  e_division_changed,
96  e_lineage_changed,
97  e_gc_changed,
98  e_mgc_changed,
99  e_orgmod_changed,
100  e_pgc_changed
101  };
103 
104  // getters
105  // setters
106 
107  /// Check if a value has been assigned to Taxid_changed data member.
108  ///
109  /// Data member Taxid_changed is mandatory;
110  /// its type is defined as 'typedef bool TTaxid_changed'
111  /// @return
112  /// - true, if a value has been assigned.
113  /// - false, otherwise.
114  bool IsSetTaxid_changed(void) const;
115 
116  /// Check if it is safe to call GetTaxid_changed method.
117  ///
118  /// @return
119  /// - true, if the data member is getatable.
120  /// - false, otherwise.
121  bool CanGetTaxid_changed(void) const;
122 
123  /// Reset Taxid_changed data member.
124  void ResetTaxid_changed(void);
125 
126  /// Get the Taxid_changed member data.
127  ///
128  /// @return
129  /// Copy of the member data.
130  TTaxid_changed GetTaxid_changed(void) const;
131 
132  /// Assign a value to Taxid_changed data member.
133  ///
134  /// @param value
135  /// Value to assign
136  void SetTaxid_changed(TTaxid_changed value);
137 
138  /// Assign a value to Taxid_changed data member.
139  ///
140  /// @return
141  /// Reference to the data value.
142  TTaxid_changed& SetTaxid_changed(void);
143 
144  /// Check if a value has been assigned to Taxname_changed data member.
145  ///
146  /// Data member Taxname_changed is mandatory;
147  /// its type is defined as 'typedef bool TTaxname_changed'
148  /// @return
149  /// - true, if a value has been assigned.
150  /// - false, otherwise.
151  bool IsSetTaxname_changed(void) const;
152 
153  /// Check if it is safe to call GetTaxname_changed method.
154  ///
155  /// @return
156  /// - true, if the data member is getatable.
157  /// - false, otherwise.
158  bool CanGetTaxname_changed(void) const;
159 
160  /// Reset Taxname_changed data member.
161  void ResetTaxname_changed(void);
162 
163  /// Get the Taxname_changed member data.
164  ///
165  /// @return
166  /// Copy of the member data.
167  TTaxname_changed GetTaxname_changed(void) const;
168 
169  /// Assign a value to Taxname_changed data member.
170  ///
171  /// @param value
172  /// Value to assign
173  void SetTaxname_changed(TTaxname_changed value);
174 
175  /// Assign a value to Taxname_changed data member.
176  ///
177  /// @return
178  /// Reference to the data value.
179  TTaxname_changed& SetTaxname_changed(void);
180 
181  /// Check if a value has been assigned to Division_changed data member.
182  ///
183  /// Data member Division_changed is mandatory;
184  /// its type is defined as 'typedef bool TDivision_changed'
185  /// @return
186  /// - true, if a value has been assigned.
187  /// - false, otherwise.
188  bool IsSetDivision_changed(void) const;
189 
190  /// Check if it is safe to call GetDivision_changed method.
191  ///
192  /// @return
193  /// - true, if the data member is getatable.
194  /// - false, otherwise.
195  bool CanGetDivision_changed(void) const;
196 
197  /// Reset Division_changed data member.
198  void ResetDivision_changed(void);
199 
200  /// Get the Division_changed member data.
201  ///
202  /// @return
203  /// Copy of the member data.
204  TDivision_changed GetDivision_changed(void) const;
205 
206  /// Assign a value to Division_changed data member.
207  ///
208  /// @param value
209  /// Value to assign
210  void SetDivision_changed(TDivision_changed value);
211 
212  /// Assign a value to Division_changed data member.
213  ///
214  /// @return
215  /// Reference to the data value.
216  TDivision_changed& SetDivision_changed(void);
217 
218  /// Check if a value has been assigned to Lineage_changed data member.
219  ///
220  /// Data member Lineage_changed is mandatory;
221  /// its type is defined as 'typedef bool TLineage_changed'
222  /// @return
223  /// - true, if a value has been assigned.
224  /// - false, otherwise.
225  bool IsSetLineage_changed(void) const;
226 
227  /// Check if it is safe to call GetLineage_changed method.
228  ///
229  /// @return
230  /// - true, if the data member is getatable.
231  /// - false, otherwise.
232  bool CanGetLineage_changed(void) const;
233 
234  /// Reset Lineage_changed data member.
235  void ResetLineage_changed(void);
236 
237  /// Get the Lineage_changed member data.
238  ///
239  /// @return
240  /// Copy of the member data.
241  TLineage_changed GetLineage_changed(void) const;
242 
243  /// Assign a value to Lineage_changed data member.
244  ///
245  /// @param value
246  /// Value to assign
247  void SetLineage_changed(TLineage_changed value);
248 
249  /// Assign a value to Lineage_changed data member.
250  ///
251  /// @return
252  /// Reference to the data value.
253  TLineage_changed& SetLineage_changed(void);
254 
255  /// Check if a value has been assigned to Gc_changed data member.
256  ///
257  /// Data member Gc_changed is mandatory;
258  /// its type is defined as 'typedef bool TGc_changed'
259  /// @return
260  /// - true, if a value has been assigned.
261  /// - false, otherwise.
262  bool IsSetGc_changed(void) const;
263 
264  /// Check if it is safe to call GetGc_changed method.
265  ///
266  /// @return
267  /// - true, if the data member is getatable.
268  /// - false, otherwise.
269  bool CanGetGc_changed(void) const;
270 
271  /// Reset Gc_changed data member.
272  void ResetGc_changed(void);
273 
274  /// Get the Gc_changed member data.
275  ///
276  /// @return
277  /// Copy of the member data.
278  TGc_changed GetGc_changed(void) const;
279 
280  /// Assign a value to Gc_changed data member.
281  ///
282  /// @param value
283  /// Value to assign
284  void SetGc_changed(TGc_changed value);
285 
286  /// Assign a value to Gc_changed data member.
287  ///
288  /// @return
289  /// Reference to the data value.
290  TGc_changed& SetGc_changed(void);
291 
292  /// Check if a value has been assigned to Mgc_changed data member.
293  ///
294  /// Data member Mgc_changed is mandatory;
295  /// its type is defined as 'typedef bool TMgc_changed'
296  /// @return
297  /// - true, if a value has been assigned.
298  /// - false, otherwise.
299  bool IsSetMgc_changed(void) const;
300 
301  /// Check if it is safe to call GetMgc_changed method.
302  ///
303  /// @return
304  /// - true, if the data member is getatable.
305  /// - false, otherwise.
306  bool CanGetMgc_changed(void) const;
307 
308  /// Reset Mgc_changed data member.
309  void ResetMgc_changed(void);
310 
311  /// Get the Mgc_changed member data.
312  ///
313  /// @return
314  /// Copy of the member data.
315  TMgc_changed GetMgc_changed(void) const;
316 
317  /// Assign a value to Mgc_changed data member.
318  ///
319  /// @param value
320  /// Value to assign
321  void SetMgc_changed(TMgc_changed value);
322 
323  /// Assign a value to Mgc_changed data member.
324  ///
325  /// @return
326  /// Reference to the data value.
327  TMgc_changed& SetMgc_changed(void);
328 
329  /// Check if a value has been assigned to Orgmod_changed data member.
330  ///
331  /// Data member Orgmod_changed is mandatory;
332  /// its type is defined as 'typedef bool TOrgmod_changed'
333  /// @return
334  /// - true, if a value has been assigned.
335  /// - false, otherwise.
336  bool IsSetOrgmod_changed(void) const;
337 
338  /// Check if it is safe to call GetOrgmod_changed method.
339  ///
340  /// @return
341  /// - true, if the data member is getatable.
342  /// - false, otherwise.
343  bool CanGetOrgmod_changed(void) const;
344 
345  /// Reset Orgmod_changed data member.
346  void ResetOrgmod_changed(void);
347 
348  /// Get the Orgmod_changed member data.
349  ///
350  /// @return
351  /// Copy of the member data.
352  TOrgmod_changed GetOrgmod_changed(void) const;
353 
354  /// Assign a value to Orgmod_changed data member.
355  ///
356  /// @param value
357  /// Value to assign
358  void SetOrgmod_changed(TOrgmod_changed value);
359 
360  /// Assign a value to Orgmod_changed data member.
361  ///
362  /// @return
363  /// Reference to the data value.
364  TOrgmod_changed& SetOrgmod_changed(void);
365 
366  /// Check if a value has been assigned to Pgc_changed data member.
367  ///
368  /// Data member Pgc_changed is optional;
369  /// its type is defined as 'typedef bool TPgc_changed'
370  /// @return
371  /// - true, if a value has been assigned.
372  /// - false, otherwise.
373  bool IsSetPgc_changed(void) const;
374 
375  /// Check if it is safe to call GetPgc_changed method.
376  ///
377  /// @return
378  /// - true, if the data member is getatable.
379  /// - false, otherwise.
380  bool CanGetPgc_changed(void) const;
381 
382  /// Reset Pgc_changed data member.
383  void ResetPgc_changed(void);
384 
385  /// Get the Pgc_changed member data.
386  ///
387  /// @return
388  /// Copy of the member data.
389  TPgc_changed GetPgc_changed(void) const;
390 
391  /// Assign a value to Pgc_changed data member.
392  ///
393  /// @param value
394  /// Value to assign
395  void SetPgc_changed(TPgc_changed value);
396 
397  /// Assign a value to Pgc_changed data member.
398  ///
399  /// @return
400  /// Reference to the data value.
401  TPgc_changed& SetPgc_changed(void);
402 
403  /// Reset the whole object
404  virtual void Reset(void);
405 
406 
407 private:
408  // Prohibit copy constructor and assignment operator
411 
412  // data
413  Uint4 m_set_State[1];
422 };
423 
424 /* @} */
425 
426 
427 
428 
429 
430 ///////////////////////////////////////////////////////////
431 ///////////////////// inline methods //////////////////////
432 ///////////////////////////////////////////////////////////
433 inline
435 {
436  return ((m_set_State[0] & 0x3) != 0);
437 }
438 
439 inline
441 {
442  return IsSetTaxid_changed();
443 }
444 
445 inline
447 {
448  m_Taxid_changed = 0;
449  m_set_State[0] &= ~0x3;
450 }
451 
452 inline
454 {
455  if (!CanGetTaxid_changed()) {
456  ThrowUnassigned(0);
457  }
458  return m_Taxid_changed;
459 }
460 
461 inline
463 {
465  m_set_State[0] |= 0x3;
466 }
467 
468 inline
470 {
471 #ifdef _DEBUG
472  if (!IsSetTaxid_changed()) {
474  }
475 #endif
476  m_set_State[0] |= 0x1;
477  return m_Taxid_changed;
478 }
479 
480 inline
482 {
483  return ((m_set_State[0] & 0xc) != 0);
484 }
485 
486 inline
488 {
489  return IsSetTaxname_changed();
490 }
491 
492 inline
494 {
495  m_Taxname_changed = 0;
496  m_set_State[0] &= ~0xc;
497 }
498 
499 inline
501 {
502  if (!CanGetTaxname_changed()) {
503  ThrowUnassigned(1);
504  }
505  return m_Taxname_changed;
506 }
507 
508 inline
510 {
512  m_set_State[0] |= 0xc;
513 }
514 
515 inline
517 {
518 #ifdef _DEBUG
519  if (!IsSetTaxname_changed()) {
521  }
522 #endif
523  m_set_State[0] |= 0x4;
524  return m_Taxname_changed;
525 }
526 
527 inline
529 {
530  return ((m_set_State[0] & 0x30) != 0);
531 }
532 
533 inline
535 {
536  return IsSetDivision_changed();
537 }
538 
539 inline
541 {
542  m_Division_changed = 0;
543  m_set_State[0] &= ~0x30;
544 }
545 
546 inline
548 {
549  if (!CanGetDivision_changed()) {
550  ThrowUnassigned(2);
551  }
552  return m_Division_changed;
553 }
554 
555 inline
557 {
559  m_set_State[0] |= 0x30;
560 }
561 
562 inline
564 {
565 #ifdef _DEBUG
566  if (!IsSetDivision_changed()) {
568  }
569 #endif
570  m_set_State[0] |= 0x10;
571  return m_Division_changed;
572 }
573 
574 inline
576 {
577  return ((m_set_State[0] & 0xc0) != 0);
578 }
579 
580 inline
582 {
583  return IsSetLineage_changed();
584 }
585 
586 inline
588 {
589  m_Lineage_changed = 0;
590  m_set_State[0] &= ~0xc0;
591 }
592 
593 inline
595 {
596  if (!CanGetLineage_changed()) {
597  ThrowUnassigned(3);
598  }
599  return m_Lineage_changed;
600 }
601 
602 inline
604 {
606  m_set_State[0] |= 0xc0;
607 }
608 
609 inline
611 {
612 #ifdef _DEBUG
613  if (!IsSetLineage_changed()) {
615  }
616 #endif
617  m_set_State[0] |= 0x40;
618  return m_Lineage_changed;
619 }
620 
621 inline
623 {
624  return ((m_set_State[0] & 0x300) != 0);
625 }
626 
627 inline
629 {
630  return IsSetGc_changed();
631 }
632 
633 inline
635 {
636  m_Gc_changed = 0;
637  m_set_State[0] &= ~0x300;
638 }
639 
640 inline
642 {
643  if (!CanGetGc_changed()) {
644  ThrowUnassigned(4);
645  }
646  return m_Gc_changed;
647 }
648 
649 inline
651 {
653  m_set_State[0] |= 0x300;
654 }
655 
656 inline
658 {
659 #ifdef _DEBUG
660  if (!IsSetGc_changed()) {
661  memset(&m_Gc_changed,UnassignedByte(),sizeof(m_Gc_changed));
662  }
663 #endif
664  m_set_State[0] |= 0x100;
665  return m_Gc_changed;
666 }
667 
668 inline
670 {
671  return ((m_set_State[0] & 0xc00) != 0);
672 }
673 
674 inline
676 {
677  return IsSetMgc_changed();
678 }
679 
680 inline
682 {
683  m_Mgc_changed = 0;
684  m_set_State[0] &= ~0xc00;
685 }
686 
687 inline
689 {
690  if (!CanGetMgc_changed()) {
691  ThrowUnassigned(5);
692  }
693  return m_Mgc_changed;
694 }
695 
696 inline
698 {
700  m_set_State[0] |= 0xc00;
701 }
702 
703 inline
705 {
706 #ifdef _DEBUG
707  if (!IsSetMgc_changed()) {
708  memset(&m_Mgc_changed,UnassignedByte(),sizeof(m_Mgc_changed));
709  }
710 #endif
711  m_set_State[0] |= 0x400;
712  return m_Mgc_changed;
713 }
714 
715 inline
717 {
718  return ((m_set_State[0] & 0x3000) != 0);
719 }
720 
721 inline
723 {
724  return IsSetOrgmod_changed();
725 }
726 
727 inline
729 {
730  m_Orgmod_changed = 0;
731  m_set_State[0] &= ~0x3000;
732 }
733 
734 inline
736 {
737  if (!CanGetOrgmod_changed()) {
738  ThrowUnassigned(6);
739  }
740  return m_Orgmod_changed;
741 }
742 
743 inline
745 {
747  m_set_State[0] |= 0x3000;
748 }
749 
750 inline
752 {
753 #ifdef _DEBUG
754  if (!IsSetOrgmod_changed()) {
756  }
757 #endif
758  m_set_State[0] |= 0x1000;
759  return m_Orgmod_changed;
760 }
761 
762 inline
764 {
765  return ((m_set_State[0] & 0xc000) != 0);
766 }
767 
768 inline
770 {
771  return IsSetPgc_changed();
772 }
773 
774 inline
776 {
777  m_Pgc_changed = 0;
778  m_set_State[0] &= ~0xc000;
779 }
780 
781 inline
783 {
784  if (!CanGetPgc_changed()) {
785  ThrowUnassigned(7);
786  }
787  return m_Pgc_changed;
788 }
789 
790 inline
792 {
794  m_set_State[0] |= 0xc000;
795 }
796 
797 inline
799 {
800 #ifdef _DEBUG
801  if (!IsSetPgc_changed()) {
802  memset(&m_Pgc_changed,UnassignedByte(),sizeof(m_Pgc_changed));
803  }
804 #endif
805  m_set_State[0] |= 0x4000;
806  return m_Pgc_changed;
807 }
808 
809 ///////////////////////////////////////////////////////////
810 ////////////////// end of inline methods //////////////////
811 ///////////////////////////////////////////////////////////
812 
813 
814 
815 
816 
817 END_objects_SCOPE // namespace ncbi::objects::
818 
820 
821 
822 #endif // OBJECTS_TAXON3_T3REFRESHFLAGS_BASE_HPP
Base class for all serializable objects.
Definition: serialbase.hpp:150
CT3RefreshFlags_Base –.
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
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_TAXON3_EXPORT
Definition: ncbi_export.h:865
bool IsSetOrgmod_changed(void) const
Check if a value has been assigned to Orgmod_changed data member.
Tparent::CMemberIndex< E_memberIndex, 9 > TmemberIndex
CT3RefreshFlags_Base(const CT3RefreshFlags_Base &)
void ResetLineage_changed(void)
Reset Lineage_changed data member.
TGc_changed & SetGc_changed(void)
Assign a value to Gc_changed data member.
TLineage_changed & SetLineage_changed(void)
Assign a value to Lineage_changed data member.
bool CanGetGc_changed(void) const
Check if it is safe to call GetGc_changed method.
TGc_changed GetGc_changed(void) const
Get the Gc_changed member data.
TTaxid_changed & SetTaxid_changed(void)
Assign a value to Taxid_changed data member.
void ResetPgc_changed(void)
Reset Pgc_changed data member.
bool IsSetTaxid_changed(void) const
Check if a value has been assigned to Taxid_changed data member.
TOrgmod_changed GetOrgmod_changed(void) const
Get the Orgmod_changed member data.
TLineage_changed GetLineage_changed(void) const
Get the Lineage_changed member data.
bool CanGetTaxid_changed(void) const
Check if it is safe to call GetTaxid_changed method.
bool CanGetTaxname_changed(void) const
Check if it is safe to call GetTaxname_changed method.
bool CanGetPgc_changed(void) const
Check if it is safe to call GetPgc_changed method.
bool IsSetPgc_changed(void) const
Check if a value has been assigned to Pgc_changed data member.
TOrgmod_changed & SetOrgmod_changed(void)
Assign a value to Orgmod_changed data member.
void ResetDivision_changed(void)
Reset Division_changed data member.
bool CanGetDivision_changed(void) const
Check if it is safe to call GetDivision_changed method.
void ResetTaxname_changed(void)
Reset Taxname_changed data member.
bool CanGetLineage_changed(void) const
Check if it is safe to call GetLineage_changed method.
TTaxname_changed GetTaxname_changed(void) const
Get the Taxname_changed member data.
TTaxid_changed GetTaxid_changed(void) const
Get the Taxid_changed member data.
bool CanGetOrgmod_changed(void) const
Check if it is safe to call GetOrgmod_changed method.
CT3RefreshFlags_Base & operator=(const CT3RefreshFlags_Base &)
bool IsSetDivision_changed(void) const
Check if a value has been assigned to Division_changed data member.
TTaxname_changed & SetTaxname_changed(void)
Assign a value to Taxname_changed data member.
bool IsSetTaxname_changed(void) const
Check if a value has been assigned to Taxname_changed data member.
void ResetTaxid_changed(void)
Reset Taxid_changed data member.
void ResetMgc_changed(void)
Reset Mgc_changed data member.
TPgc_changed GetPgc_changed(void) const
Get the Pgc_changed member data.
TDivision_changed GetDivision_changed(void) const
Get the Division_changed member data.
bool IsSetGc_changed(void) const
Check if a value has been assigned to Gc_changed data member.
void ResetOrgmod_changed(void)
Reset Orgmod_changed data member.
void ResetGc_changed(void)
Reset Gc_changed data member.
bool IsSetLineage_changed(void) const
Check if a value has been assigned to Lineage_changed data member.
bool IsSetMgc_changed(void) const
Check if a value has been assigned to Mgc_changed data member.
TDivision_changed & SetDivision_changed(void)
Assign a value to Division_changed data member.
TPgc_changed & SetPgc_changed(void)
Assign a value to Pgc_changed data member.
TMgc_changed & SetMgc_changed(void)
Assign a value to Mgc_changed data member.
TMgc_changed GetMgc_changed(void) const
Get the Mgc_changed member data.
bool CanGetMgc_changed(void) const
Check if it is safe to call GetMgc_changed method.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Apr 17 13:08:49 2024 by modify_doxy.py rev. 669887