NCBI C++ ToolKit
Book_.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 Book_.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/objtools/eutils/efetch/efetch.xsd">efetch.xsd</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/efetch.def">efetch.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 eutils__OBJTOOLS_EUTILS_EFETCH_BOOK_BASE_HPP
42 #define eutils__OBJTOOLS_EUTILS_EFETCH_BOOK_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 
50 #ifndef BEGIN_eutils_SCOPE
51 # define BEGIN_eutils_SCOPE BEGIN_SCOPE(eutils)
52 # define END_eutils_SCOPE END_SCOPE(eutils)
53 #endif
54 BEGIN_eutils_SCOPE // namespace eutils::
55 
56 
57 // forward declarations
58 class CAuthorList;
59 class CBeginningDate;
60 class CBookTitle;
61 class CCollectionTitle;
62 class CELocationID;
63 class CEdition;
64 class CEndingDate;
65 class CInvestigatorList;
66 class CIsbn;
67 class CMedium;
68 class CPubDate;
69 class CPublisher;
70 class CReportNumber;
71 class CVolume;
72 class CVolumeTitle;
73 
74 
75 // generated classes
76 
77 
78 /** @addtogroup dataspec_efetch
79  *
80  * @{
81  */
82 
83 /////////////////////////////////////////////////////////////////////////////
84 ///
85 /// CBook_Base --
86 ///
87 
88 class CBook_Base : public NCBI_NS_NCBI::CSerialObject
89 {
90  typedef NCBI_NS_NCBI::CSerialObject Tparent;
91 public:
92  // constructor
93  CBook_Base(void);
94  // destructor
95  virtual ~CBook_Base(void);
96 
97  // type info
99 
100  // types
106  typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAuthorList > > TAuthorList;
108  typedef CVolume TVolume;
112  typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIsbn > > TIsbn;
113  typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CELocationID > > TELocationID;
114  typedef CMedium TMedium;
116 
117  // member index
118  enum class E_memberIndex {
119  e__allMandatory = 0,
120  e_Publisher,
121  e_BookTitle,
122  e_PubDate,
124  e_EndingDate,
125  e_AuthorList,
127  e_Volume,
129  e_Edition,
131  e_Isbn,
133  e_Medium,
135  };
136  typedef Tparent::CMemberIndex<E_memberIndex, 16> TmemberIndex;
137 
138  // getters
139  // setters
140 
141  /// Check if a value has been assigned to Publisher data member.
142  ///
143  /// Data member Publisher is mandatory;
144  /// its type is defined as 'typedef CPublisher TPublisher'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetPublisher(void) const;
149 
150  /// Check if it is safe to call GetPublisher method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetPublisher(void) const;
156 
157  /// Reset Publisher data member.
158  void ResetPublisher(void);
159 
160  /// Get the Publisher member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TPublisher& GetPublisher(void) const;
165 
166  /// Assign a value to Publisher data member.
167  ///
168  /// @param value
169  /// Reference to value.
171 
172  /// Assign a value to Publisher data member.
173  ///
174  /// @return
175  /// Reference to the data value.
176  TPublisher& SetPublisher(void);
177 
178  /// Check if a value has been assigned to BookTitle data member.
179  ///
180  /// Data member BookTitle is mandatory;
181  /// its type is defined as 'typedef CBookTitle TBookTitle'
182  /// @return
183  /// - true, if a value has been assigned.
184  /// - false, otherwise.
185  bool IsSetBookTitle(void) const;
186 
187  /// Check if it is safe to call GetBookTitle method.
188  ///
189  /// @return
190  /// - true, if the data member is getatable.
191  /// - false, otherwise.
192  bool CanGetBookTitle(void) const;
193 
194  /// Reset BookTitle data member.
195  void ResetBookTitle(void);
196 
197  /// Get the BookTitle member data.
198  ///
199  /// @return
200  /// Reference to the member data.
201  const TBookTitle& GetBookTitle(void) const;
202 
203  /// Assign a value to BookTitle data member.
204  ///
205  /// @param value
206  /// Reference to value.
208 
209  /// Assign a value to BookTitle data member.
210  ///
211  /// @return
212  /// Reference to the data value.
213  TBookTitle& SetBookTitle(void);
214 
215  /// Check if a value has been assigned to PubDate data member.
216  ///
217  /// Data member PubDate is mandatory;
218  /// its type is defined as 'typedef CPubDate TPubDate'
219  /// @return
220  /// - true, if a value has been assigned.
221  /// - false, otherwise.
222  bool IsSetPubDate(void) const;
223 
224  /// Check if it is safe to call GetPubDate method.
225  ///
226  /// @return
227  /// - true, if the data member is getatable.
228  /// - false, otherwise.
229  bool CanGetPubDate(void) const;
230 
231  /// Reset PubDate data member.
232  void ResetPubDate(void);
233 
234  /// Get the PubDate member data.
235  ///
236  /// @return
237  /// Reference to the member data.
238  const TPubDate& GetPubDate(void) const;
239 
240  /// Assign a value to PubDate data member.
241  ///
242  /// @param value
243  /// Reference to value.
244  void SetPubDate(TPubDate& value);
245 
246  /// Assign a value to PubDate data member.
247  ///
248  /// @return
249  /// Reference to the data value.
250  TPubDate& SetPubDate(void);
251 
252  /// Check if a value has been assigned to BeginningDate data member.
253  ///
254  /// Data member BeginningDate is optional;
255  /// its type is defined as 'typedef CBeginningDate TBeginningDate'
256  /// @return
257  /// - true, if a value has been assigned.
258  /// - false, otherwise.
259  bool IsSetBeginningDate(void) const;
260 
261  /// Check if it is safe to call GetBeginningDate method.
262  ///
263  /// @return
264  /// - true, if the data member is getatable.
265  /// - false, otherwise.
266  bool CanGetBeginningDate(void) const;
267 
268  /// Reset BeginningDate data member.
269  void ResetBeginningDate(void);
270 
271  /// Get the BeginningDate member data.
272  ///
273  /// @return
274  /// Reference to the member data.
275  const TBeginningDate& GetBeginningDate(void) const;
276 
277  /// Assign a value to BeginningDate data member.
278  ///
279  /// @param value
280  /// Reference to value.
282 
283  /// Assign a value to BeginningDate data member.
284  ///
285  /// @return
286  /// Reference to the data value.
288 
289  /// Check if a value has been assigned to EndingDate data member.
290  ///
291  /// Data member EndingDate is optional;
292  /// its type is defined as 'typedef CEndingDate TEndingDate'
293  /// @return
294  /// - true, if a value has been assigned.
295  /// - false, otherwise.
296  bool IsSetEndingDate(void) const;
297 
298  /// Check if it is safe to call GetEndingDate method.
299  ///
300  /// @return
301  /// - true, if the data member is getatable.
302  /// - false, otherwise.
303  bool CanGetEndingDate(void) const;
304 
305  /// Reset EndingDate data member.
306  void ResetEndingDate(void);
307 
308  /// Get the EndingDate member data.
309  ///
310  /// @return
311  /// Reference to the member data.
312  const TEndingDate& GetEndingDate(void) const;
313 
314  /// Assign a value to EndingDate data member.
315  ///
316  /// @param value
317  /// Reference to value.
319 
320  /// Assign a value to EndingDate data member.
321  ///
322  /// @return
323  /// Reference to the data value.
324  TEndingDate& SetEndingDate(void);
325 
326  /// Check if a value has been assigned to AuthorList data member.
327  ///
328  /// Data member AuthorList is optional;
329  /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAuthorList > > TAuthorList'
330  /// @return
331  /// - true, if a value has been assigned.
332  /// - false, otherwise.
333  bool IsSetAuthorList(void) const;
334 
335  /// Check if it is safe to call GetAuthorList method.
336  ///
337  /// @return
338  /// - true, if the data member is getatable.
339  /// - false, otherwise.
340  bool CanGetAuthorList(void) const;
341 
342  /// Reset AuthorList data member.
343  void ResetAuthorList(void);
344 
345  /// Get the AuthorList member data.
346  ///
347  /// @return
348  /// Reference to the member data.
349  const TAuthorList& GetAuthorList(void) const;
350 
351  /// Assign a value to AuthorList data member.
352  ///
353  /// @return
354  /// Reference to the data value.
355  TAuthorList& SetAuthorList(void);
356 
357  /// Check if a value has been assigned to InvestigatorList data member.
358  ///
359  /// Data member InvestigatorList is optional;
360  /// its type is defined as 'typedef CInvestigatorList TInvestigatorList'
361  /// @return
362  /// - true, if a value has been assigned.
363  /// - false, otherwise.
364  bool IsSetInvestigatorList(void) const;
365 
366  /// Check if it is safe to call GetInvestigatorList method.
367  ///
368  /// @return
369  /// - true, if the data member is getatable.
370  /// - false, otherwise.
371  bool CanGetInvestigatorList(void) const;
372 
373  /// Reset InvestigatorList data member.
374  void ResetInvestigatorList(void);
375 
376  /// Get the InvestigatorList member data.
377  ///
378  /// @return
379  /// Reference to the member data.
380  const TInvestigatorList& GetInvestigatorList(void) const;
381 
382  /// Assign a value to InvestigatorList data member.
383  ///
384  /// @param value
385  /// Reference to value.
387 
388  /// Assign a value to InvestigatorList data member.
389  ///
390  /// @return
391  /// Reference to the data value.
393 
394  /// Check if a value has been assigned to Volume data member.
395  ///
396  /// Data member Volume is optional;
397  /// its type is defined as 'typedef CVolume TVolume'
398  /// @return
399  /// - true, if a value has been assigned.
400  /// - false, otherwise.
401  bool IsSetVolume(void) const;
402 
403  /// Check if it is safe to call GetVolume method.
404  ///
405  /// @return
406  /// - true, if the data member is getatable.
407  /// - false, otherwise.
408  bool CanGetVolume(void) const;
409 
410  /// Reset Volume data member.
411  void ResetVolume(void);
412 
413  /// Get the Volume member data.
414  ///
415  /// @return
416  /// Reference to the member data.
417  const TVolume& GetVolume(void) const;
418 
419  /// Assign a value to Volume data member.
420  ///
421  /// @param value
422  /// Reference to value.
423  void SetVolume(TVolume& value);
424 
425  /// Assign a value to Volume data member.
426  ///
427  /// @return
428  /// Reference to the data value.
429  TVolume& SetVolume(void);
430 
431  /// Check if a value has been assigned to VolumeTitle data member.
432  ///
433  /// Data member VolumeTitle is optional;
434  /// its type is defined as 'typedef CVolumeTitle TVolumeTitle'
435  /// @return
436  /// - true, if a value has been assigned.
437  /// - false, otherwise.
438  bool IsSetVolumeTitle(void) const;
439 
440  /// Check if it is safe to call GetVolumeTitle method.
441  ///
442  /// @return
443  /// - true, if the data member is getatable.
444  /// - false, otherwise.
445  bool CanGetVolumeTitle(void) const;
446 
447  /// Reset VolumeTitle data member.
448  void ResetVolumeTitle(void);
449 
450  /// Get the VolumeTitle member data.
451  ///
452  /// @return
453  /// Reference to the member data.
454  const TVolumeTitle& GetVolumeTitle(void) const;
455 
456  /// Assign a value to VolumeTitle data member.
457  ///
458  /// @param value
459  /// Reference to value.
461 
462  /// Assign a value to VolumeTitle data member.
463  ///
464  /// @return
465  /// Reference to the data value.
467 
468  /// Check if a value has been assigned to Edition data member.
469  ///
470  /// Data member Edition is optional;
471  /// its type is defined as 'typedef CEdition TEdition'
472  /// @return
473  /// - true, if a value has been assigned.
474  /// - false, otherwise.
475  bool IsSetEdition(void) const;
476 
477  /// Check if it is safe to call GetEdition method.
478  ///
479  /// @return
480  /// - true, if the data member is getatable.
481  /// - false, otherwise.
482  bool CanGetEdition(void) const;
483 
484  /// Reset Edition data member.
485  void ResetEdition(void);
486 
487  /// Get the Edition member data.
488  ///
489  /// @return
490  /// Reference to the member data.
491  const TEdition& GetEdition(void) const;
492 
493  /// Assign a value to Edition data member.
494  ///
495  /// @param value
496  /// Reference to value.
497  void SetEdition(TEdition& value);
498 
499  /// Assign a value to Edition data member.
500  ///
501  /// @return
502  /// Reference to the data value.
503  TEdition& SetEdition(void);
504 
505  /// Check if a value has been assigned to CollectionTitle data member.
506  ///
507  /// Data member CollectionTitle is optional;
508  /// its type is defined as 'typedef CCollectionTitle TCollectionTitle'
509  /// @return
510  /// - true, if a value has been assigned.
511  /// - false, otherwise.
512  bool IsSetCollectionTitle(void) const;
513 
514  /// Check if it is safe to call GetCollectionTitle method.
515  ///
516  /// @return
517  /// - true, if the data member is getatable.
518  /// - false, otherwise.
519  bool CanGetCollectionTitle(void) const;
520 
521  /// Reset CollectionTitle data member.
522  void ResetCollectionTitle(void);
523 
524  /// Get the CollectionTitle member data.
525  ///
526  /// @return
527  /// Reference to the member data.
528  const TCollectionTitle& GetCollectionTitle(void) const;
529 
530  /// Assign a value to CollectionTitle data member.
531  ///
532  /// @param value
533  /// Reference to value.
535 
536  /// Assign a value to CollectionTitle data member.
537  ///
538  /// @return
539  /// Reference to the data value.
541 
542  /// Check if a value has been assigned to Isbn data member.
543  ///
544  /// Data member Isbn is optional;
545  /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIsbn > > TIsbn'
546  /// @return
547  /// - true, if a value has been assigned.
548  /// - false, otherwise.
549  bool IsSetIsbn(void) const;
550 
551  /// Check if it is safe to call GetIsbn method.
552  ///
553  /// @return
554  /// - true, if the data member is getatable.
555  /// - false, otherwise.
556  bool CanGetIsbn(void) const;
557 
558  /// Reset Isbn data member.
559  void ResetIsbn(void);
560 
561  /// Get the Isbn member data.
562  ///
563  /// @return
564  /// Reference to the member data.
565  const TIsbn& GetIsbn(void) const;
566 
567  /// Assign a value to Isbn data member.
568  ///
569  /// @return
570  /// Reference to the data value.
571  TIsbn& SetIsbn(void);
572 
573  /// Check if a value has been assigned to ELocationID data member.
574  ///
575  /// Data member ELocationID is optional;
576  /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CELocationID > > TELocationID'
577  /// @return
578  /// - true, if a value has been assigned.
579  /// - false, otherwise.
580  bool IsSetELocationID(void) const;
581 
582  /// Check if it is safe to call GetELocationID method.
583  ///
584  /// @return
585  /// - true, if the data member is getatable.
586  /// - false, otherwise.
587  bool CanGetELocationID(void) const;
588 
589  /// Reset ELocationID data member.
590  void ResetELocationID(void);
591 
592  /// Get the ELocationID member data.
593  ///
594  /// @return
595  /// Reference to the member data.
596  const TELocationID& GetELocationID(void) const;
597 
598  /// Assign a value to ELocationID data member.
599  ///
600  /// @return
601  /// Reference to the data value.
603 
604  /// Check if a value has been assigned to Medium data member.
605  ///
606  /// Data member Medium is optional;
607  /// its type is defined as 'typedef CMedium TMedium'
608  /// @return
609  /// - true, if a value has been assigned.
610  /// - false, otherwise.
611  bool IsSetMedium(void) const;
612 
613  /// Check if it is safe to call GetMedium method.
614  ///
615  /// @return
616  /// - true, if the data member is getatable.
617  /// - false, otherwise.
618  bool CanGetMedium(void) const;
619 
620  /// Reset Medium data member.
621  void ResetMedium(void);
622 
623  /// Get the Medium member data.
624  ///
625  /// @return
626  /// Reference to the member data.
627  const TMedium& GetMedium(void) const;
628 
629  /// Assign a value to Medium data member.
630  ///
631  /// @param value
632  /// Reference to value.
633  void SetMedium(TMedium& value);
634 
635  /// Assign a value to Medium data member.
636  ///
637  /// @return
638  /// Reference to the data value.
639  TMedium& SetMedium(void);
640 
641  /// Check if a value has been assigned to ReportNumber data member.
642  ///
643  /// Data member ReportNumber is optional;
644  /// its type is defined as 'typedef CReportNumber TReportNumber'
645  /// @return
646  /// - true, if a value has been assigned.
647  /// - false, otherwise.
648  bool IsSetReportNumber(void) const;
649 
650  /// Check if it is safe to call GetReportNumber method.
651  ///
652  /// @return
653  /// - true, if the data member is getatable.
654  /// - false, otherwise.
655  bool CanGetReportNumber(void) const;
656 
657  /// Reset ReportNumber data member.
658  void ResetReportNumber(void);
659 
660  /// Get the ReportNumber member data.
661  ///
662  /// @return
663  /// Reference to the member data.
664  const TReportNumber& GetReportNumber(void) const;
665 
666  /// Assign a value to ReportNumber data member.
667  ///
668  /// @param value
669  /// Reference to value.
671 
672  /// Assign a value to ReportNumber data member.
673  ///
674  /// @return
675  /// Reference to the data value.
677 
678  /// Reset the whole object
679  virtual void Reset(void);
680 
681 
682 private:
683  // Prohibit copy constructor and assignment operator
686 
687  // data
689  NCBI_NS_NCBI::CRef< TPublisher > m_Publisher;
690  NCBI_NS_NCBI::CRef< TBookTitle > m_BookTitle;
691  NCBI_NS_NCBI::CRef< TPubDate > m_PubDate;
692  NCBI_NS_NCBI::CRef< TBeginningDate > m_BeginningDate;
693  NCBI_NS_NCBI::CRef< TEndingDate > m_EndingDate;
694  NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAuthorList > > m_AuthorList;
695  NCBI_NS_NCBI::CRef< TInvestigatorList > m_InvestigatorList;
696  NCBI_NS_NCBI::CRef< TVolume > m_Volume;
697  NCBI_NS_NCBI::CRef< TVolumeTitle > m_VolumeTitle;
698  NCBI_NS_NCBI::CRef< TEdition > m_Edition;
699  NCBI_NS_NCBI::CRef< TCollectionTitle > m_CollectionTitle;
700  NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIsbn > > m_Isbn;
701  NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CELocationID > > m_ELocationID;
702  NCBI_NS_NCBI::CRef< TMedium > m_Medium;
703  NCBI_NS_NCBI::CRef< TReportNumber > m_ReportNumber;
704 };
705 
706 /* @} */
707 
708 
709 
710 
711 
712 ///////////////////////////////////////////////////////////
713 ///////////////////// inline methods //////////////////////
714 ///////////////////////////////////////////////////////////
715 inline
717 {
718  return m_Publisher.NotEmpty();
719 }
720 
721 inline
723 {
724  return true;
725 }
726 
727 inline
729 {
730  if ( !m_Publisher ) {
731  const_cast<CBook_Base*>(this)->ResetPublisher();
732  }
733  return (*m_Publisher);
734 }
735 
736 inline
738 {
739  if ( !m_Publisher ) {
740  ResetPublisher();
741  }
742  return (*m_Publisher);
743 }
744 
745 inline
747 {
748  return m_BookTitle.NotEmpty();
749 }
750 
751 inline
753 {
754  return true;
755 }
756 
757 inline
759 {
760  if ( !m_BookTitle ) {
761  const_cast<CBook_Base*>(this)->ResetBookTitle();
762  }
763  return (*m_BookTitle);
764 }
765 
766 inline
768 {
769  if ( !m_BookTitle ) {
770  ResetBookTitle();
771  }
772  return (*m_BookTitle);
773 }
774 
775 inline
776 bool CBook_Base::IsSetPubDate(void) const
777 {
778  return m_PubDate.NotEmpty();
779 }
780 
781 inline
783 {
784  return true;
785 }
786 
787 inline
789 {
790  if ( !m_PubDate ) {
791  const_cast<CBook_Base*>(this)->ResetPubDate();
792  }
793  return (*m_PubDate);
794 }
795 
796 inline
798 {
799  if ( !m_PubDate ) {
800  ResetPubDate();
801  }
802  return (*m_PubDate);
803 }
804 
805 inline
807 {
808  return m_BeginningDate.NotEmpty();
809 }
810 
811 inline
813 {
814  return IsSetBeginningDate();
815 }
816 
817 inline
819 {
820  if (!CanGetBeginningDate()) {
821  ThrowUnassigned(3);
822  }
823  return (*m_BeginningDate);
824 }
825 
826 inline
828 {
829  return m_EndingDate.NotEmpty();
830 }
831 
832 inline
834 {
835  return IsSetEndingDate();
836 }
837 
838 inline
840 {
841  if (!CanGetEndingDate()) {
842  ThrowUnassigned(4);
843  }
844  return (*m_EndingDate);
845 }
846 
847 inline
849 {
850  return ((m_set_State[0] & 0xc00) != 0);
851 }
852 
853 inline
855 {
856  return true;
857 }
858 
859 inline
861 {
862  return m_AuthorList;
863 }
864 
865 inline
867 {
868  m_set_State[0] |= 0x400;
869  return m_AuthorList;
870 }
871 
872 inline
874 {
875  return m_InvestigatorList.NotEmpty();
876 }
877 
878 inline
880 {
881  return IsSetInvestigatorList();
882 }
883 
884 inline
886 {
887  if (!CanGetInvestigatorList()) {
888  ThrowUnassigned(6);
889  }
890  return (*m_InvestigatorList);
891 }
892 
893 inline
894 bool CBook_Base::IsSetVolume(void) const
895 {
896  return m_Volume.NotEmpty();
897 }
898 
899 inline
900 bool CBook_Base::CanGetVolume(void) const
901 {
902  return IsSetVolume();
903 }
904 
905 inline
907 {
908  if (!CanGetVolume()) {
909  ThrowUnassigned(7);
910  }
911  return (*m_Volume);
912 }
913 
914 inline
916 {
917  return m_VolumeTitle.NotEmpty();
918 }
919 
920 inline
922 {
923  return IsSetVolumeTitle();
924 }
925 
926 inline
928 {
929  if (!CanGetVolumeTitle()) {
930  ThrowUnassigned(8);
931  }
932  return (*m_VolumeTitle);
933 }
934 
935 inline
936 bool CBook_Base::IsSetEdition(void) const
937 {
938  return m_Edition.NotEmpty();
939 }
940 
941 inline
943 {
944  return IsSetEdition();
945 }
946 
947 inline
949 {
950  if (!CanGetEdition()) {
951  ThrowUnassigned(9);
952  }
953  return (*m_Edition);
954 }
955 
956 inline
958 {
959  return m_CollectionTitle.NotEmpty();
960 }
961 
962 inline
964 {
965  return IsSetCollectionTitle();
966 }
967 
968 inline
970 {
971  if (!CanGetCollectionTitle()) {
972  ThrowUnassigned(10);
973  }
974  return (*m_CollectionTitle);
975 }
976 
977 inline
978 bool CBook_Base::IsSetIsbn(void) const
979 {
980  return ((m_set_State[0] & 0xc00000) != 0);
981 }
982 
983 inline
984 bool CBook_Base::CanGetIsbn(void) const
985 {
986  return true;
987 }
988 
989 inline
991 {
992  return m_Isbn;
993 }
994 
995 inline
997 {
998  m_set_State[0] |= 0x400000;
999  return m_Isbn;
1000 }
1001 
1002 inline
1004 {
1005  return ((m_set_State[0] & 0x3000000) != 0);
1006 }
1007 
1008 inline
1010 {
1011  return true;
1012 }
1013 
1014 inline
1016 {
1017  return m_ELocationID;
1018 }
1019 
1020 inline
1022 {
1023  m_set_State[0] |= 0x1000000;
1024  return m_ELocationID;
1025 }
1026 
1027 inline
1028 bool CBook_Base::IsSetMedium(void) const
1029 {
1030  return m_Medium.NotEmpty();
1031 }
1032 
1033 inline
1035 {
1036  return IsSetMedium();
1037 }
1038 
1039 inline
1041 {
1042  if (!CanGetMedium()) {
1043  ThrowUnassigned(13);
1044  }
1045  return (*m_Medium);
1046 }
1047 
1048 inline
1050 {
1051  return m_ReportNumber.NotEmpty();
1052 }
1053 
1054 inline
1056 {
1057  return IsSetReportNumber();
1058 }
1059 
1060 inline
1062 {
1063  if (!CanGetReportNumber()) {
1064  ThrowUnassigned(14);
1065  }
1066  return (*m_ReportNumber);
1067 }
1068 
1069 ///////////////////////////////////////////////////////////
1070 ////////////////// end of inline methods //////////////////
1071 ///////////////////////////////////////////////////////////
1072 
1073 
1074 
1075 
1076 
1077 END_eutils_SCOPE // namespace eutils::
1078 
1079 
1080 #endif // eutils__OBJTOOLS_EUTILS_EFETCH_BOOK_BASE_HPP
#define BEGIN_eutils_SCOPE
Definition: Book_.hpp:51
#define END_eutils_SCOPE
Definition: Book_.hpp:52
CAuthorList –.
Definition: AuthorList.hpp:64
CBeginningDate –.
CBookTitle –.
Definition: BookTitle.hpp:64
CBook_Base –.
Definition: Book_.hpp:89
CCollectionTitle –.
CELocationID –.
Definition: ELocationID.hpp:64
CEdition –.
Definition: Edition.hpp:64
CEndingDate –.
Definition: EndingDate.hpp:64
CInvestigatorList –.
CIsbn –.
Definition: Isbn.hpp:64
CMedium –.
Definition: Medium.hpp:64
CPubDate –.
Definition: PubDate.hpp:64
CPublisher –.
Definition: Publisher.hpp:64
CReportNumber –.
CVolumeTitle –.
Definition: VolumeTitle.hpp:64
CVolume –.
Definition: Volume.hpp:64
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
NCBI_NS_NCBI::CRef< TCollectionTitle > m_CollectionTitle
Definition: Book_.hpp:699
const TAuthorList & GetAuthorList(void) const
Get the AuthorList member data.
Definition: Book_.hpp:860
bool CanGetVolumeTitle(void) const
Check if it is safe to call GetVolumeTitle method.
Definition: Book_.hpp:921
const TBeginningDate & GetBeginningDate(void) const
Get the BeginningDate member data.
Definition: Book_.hpp:818
TBeginningDate & SetBeginningDate(void)
Assign a value to BeginningDate data member.
Definition: Book_.cpp:115
void ResetIsbn(void)
Reset Isbn data member.
Definition: Book_.cpp:230
const TELocationID & GetELocationID(void) const
Get the ELocationID member data.
Definition: Book_.hpp:1015
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIsbn > > m_Isbn
Definition: Book_.hpp:700
bool CanGetMedium(void) const
Check if it is safe to call GetMedium method.
Definition: Book_.hpp:1034
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIsbn > > TIsbn
Definition: Book_.hpp:112
virtual void Reset(void)
Reset the whole object.
Definition: Book_.cpp:276
bool CanGetPublisher(void) const
Check if it is safe to call GetPublisher method.
Definition: Book_.hpp:722
bool CanGetBeginningDate(void) const
Check if it is safe to call GetBeginningDate method.
Definition: Book_.hpp:812
void ResetPublisher(void)
Reset Publisher data member.
Definition: Book_.cpp:63
void ResetCollectionTitle(void)
Reset CollectionTitle data member.
Definition: Book_.cpp:213
CPublisher TPublisher
Definition: Book_.hpp:101
TEdition & SetEdition(void)
Assign a value to Edition data member.
Definition: Book_.cpp:206
bool CanGetAuthorList(void) const
Check if it is safe to call GetAuthorList method.
Definition: Book_.hpp:854
void ResetInvestigatorList(void)
Reset InvestigatorList data member.
Definition: Book_.cpp:145
TVolumeTitle & SetVolumeTitle(void)
Assign a value to VolumeTitle data member.
Definition: Book_.cpp:189
void ResetBookTitle(void)
Reset BookTitle data member.
Definition: Book_.cpp:77
Tparent::CMemberIndex< E_memberIndex, 16 > TmemberIndex
Definition: Book_.hpp:136
const TIsbn & GetIsbn(void) const
Get the Isbn member data.
Definition: Book_.hpp:990
CEdition TEdition
Definition: Book_.hpp:110
const TPubDate & GetPubDate(void) const
Get the PubDate member data.
Definition: Book_.hpp:788
bool IsSetEndingDate(void) const
Check if a value has been assigned to EndingDate data member.
Definition: Book_.hpp:827
TPublisher & SetPublisher(void)
Assign a value to Publisher data member.
Definition: Book_.hpp:737
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CELocationID > > TELocationID
Definition: Book_.hpp:113
bool IsSetPubDate(void) const
Check if a value has been assigned to PubDate data member.
Definition: Book_.hpp:776
void ResetVolumeTitle(void)
Reset VolumeTitle data member.
Definition: Book_.cpp:179
CInvestigatorList TInvestigatorList
Definition: Book_.hpp:107
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAuthorList > > TAuthorList
Definition: Book_.hpp:106
CVolumeTitle TVolumeTitle
Definition: Book_.hpp:109
TIsbn & SetIsbn(void)
Assign a value to Isbn data member.
Definition: Book_.hpp:996
bool IsSetBookTitle(void) const
Check if a value has been assigned to BookTitle data member.
Definition: Book_.hpp:746
TEndingDate & SetEndingDate(void)
Assign a value to EndingDate data member.
Definition: Book_.cpp:132
bool CanGetBookTitle(void) const
Check if it is safe to call GetBookTitle method.
Definition: Book_.hpp:752
bool IsSetInvestigatorList(void) const
Check if a value has been assigned to InvestigatorList data member.
Definition: Book_.hpp:873
TVolume & SetVolume(void)
Assign a value to Volume data member.
Definition: Book_.cpp:172
CBook_Base(const CBook_Base &)
bool IsSetVolumeTitle(void) const
Check if a value has been assigned to VolumeTitle data member.
Definition: Book_.hpp:915
TCollectionTitle & SetCollectionTitle(void)
Assign a value to CollectionTitle data member.
Definition: Book_.cpp:223
bool CanGetELocationID(void) const
Check if it is safe to call GetELocationID method.
Definition: Book_.hpp:1009
CEndingDate TEndingDate
Definition: Book_.hpp:105
TInvestigatorList & SetInvestigatorList(void)
Assign a value to InvestigatorList data member.
Definition: Book_.cpp:155
bool CanGetInvestigatorList(void) const
Check if it is safe to call GetInvestigatorList method.
Definition: Book_.hpp:879
void ResetVolume(void)
Reset Volume data member.
Definition: Book_.cpp:162
NCBI_NS_NCBI::CRef< TMedium > m_Medium
Definition: Book_.hpp:702
void ResetEdition(void)
Reset Edition data member.
Definition: Book_.cpp:196
bool IsSetAuthorList(void) const
Check if a value has been assigned to AuthorList data member.
Definition: Book_.hpp:848
NCBI_NS_NCBI::CRef< TBookTitle > m_BookTitle
Definition: Book_.hpp:690
bool CanGetVolume(void) const
Check if it is safe to call GetVolume method.
Definition: Book_.hpp:900
bool CanGetCollectionTitle(void) const
Check if it is safe to call GetCollectionTitle method.
Definition: Book_.hpp:963
DECLARE_INTERNAL_TYPE_INFO()
const TVolumeTitle & GetVolumeTitle(void) const
Get the VolumeTitle member data.
Definition: Book_.hpp:927
void ResetELocationID(void)
Reset ELocationID data member.
Definition: Book_.cpp:236
TReportNumber & SetReportNumber(void)
Assign a value to ReportNumber data member.
Definition: Book_.cpp:269
TELocationID & SetELocationID(void)
Assign a value to ELocationID data member.
Definition: Book_.hpp:1021
const TBookTitle & GetBookTitle(void) const
Get the BookTitle member data.
Definition: Book_.hpp:758
bool CanGetEndingDate(void) const
Check if it is safe to call GetEndingDate method.
Definition: Book_.hpp:833
CBook_Base(void)
Definition: Book_.cpp:321
const TPublisher & GetPublisher(void) const
Get the Publisher member data.
Definition: Book_.hpp:728
CBookTitle TBookTitle
Definition: Book_.hpp:102
void ResetMedium(void)
Reset Medium data member.
Definition: Book_.cpp:242
CVolume TVolume
Definition: Book_.hpp:108
TAuthorList & SetAuthorList(void)
Assign a value to AuthorList data member.
Definition: Book_.hpp:866
bool IsSetMedium(void) const
Check if a value has been assigned to Medium data member.
Definition: Book_.hpp:1028
bool IsSetVolume(void) const
Check if a value has been assigned to Volume data member.
Definition: Book_.hpp:894
NCBI_NS_NCBI::CRef< TVolume > m_Volume
Definition: Book_.hpp:696
NCBI_NS_NCBI::CRef< TBeginningDate > m_BeginningDate
Definition: Book_.hpp:692
void ResetReportNumber(void)
Reset ReportNumber data member.
Definition: Book_.cpp:259
bool CanGetIsbn(void) const
Check if it is safe to call GetIsbn method.
Definition: Book_.hpp:984
bool IsSetReportNumber(void) const
Check if a value has been assigned to ReportNumber data member.
Definition: Book_.hpp:1049
CMedium TMedium
Definition: Book_.hpp:114
bool IsSetEdition(void) const
Check if a value has been assigned to Edition data member.
Definition: Book_.hpp:936
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CELocationID > > m_ELocationID
Definition: Book_.hpp:701
NCBI_NS_NCBI::CRef< TReportNumber > m_ReportNumber
Definition: Book_.hpp:703
const TEdition & GetEdition(void) const
Get the Edition member data.
Definition: Book_.hpp:948
CBeginningDate TBeginningDate
Definition: Book_.hpp:104
const TVolume & GetVolume(void) const
Get the Volume member data.
Definition: Book_.hpp:906
NCBI_NS_NCBI::CRef< TInvestigatorList > m_InvestigatorList
Definition: Book_.hpp:695
bool IsSetELocationID(void) const
Check if a value has been assigned to ELocationID data member.
Definition: Book_.hpp:1003
bool IsSetPublisher(void) const
Check if a value has been assigned to Publisher data member.
Definition: Book_.hpp:716
CPubDate TPubDate
Definition: Book_.hpp:103
void ResetBeginningDate(void)
Reset BeginningDate data member.
Definition: Book_.cpp:105
NCBI_NS_NCBI::CRef< TEdition > m_Edition
Definition: Book_.hpp:698
NCBI_NS_NCBI::CRef< TEndingDate > m_EndingDate
Definition: Book_.hpp:693
CBook_Base & operator=(const CBook_Base &)
const TMedium & GetMedium(void) const
Get the Medium member data.
Definition: Book_.hpp:1040
void ResetEndingDate(void)
Reset EndingDate data member.
Definition: Book_.cpp:122
bool CanGetPubDate(void) const
Check if it is safe to call GetPubDate method.
Definition: Book_.hpp:782
virtual ~CBook_Base(void)
Definition: Book_.cpp:332
Uint4 m_set_State[1]
Definition: Book_.hpp:688
NCBI_NS_NCBI::CRef< TPublisher > m_Publisher
Definition: Book_.hpp:689
const TEndingDate & GetEndingDate(void) const
Get the EndingDate member data.
Definition: Book_.hpp:839
TMedium & SetMedium(void)
Assign a value to Medium data member.
Definition: Book_.cpp:252
bool CanGetReportNumber(void) const
Check if it is safe to call GetReportNumber method.
Definition: Book_.hpp:1055
NCBI_NS_NCBI::CRef< TVolumeTitle > m_VolumeTitle
Definition: Book_.hpp:697
const TInvestigatorList & GetInvestigatorList(void) const
Get the InvestigatorList member data.
Definition: Book_.hpp:885
NCBI_NS_NCBI::CSerialObject Tparent
Definition: Book_.hpp:90
NCBI_NS_NCBI::CRef< TPubDate > m_PubDate
Definition: Book_.hpp:691
const TCollectionTitle & GetCollectionTitle(void) const
Get the CollectionTitle member data.
Definition: Book_.hpp:969
bool CanGetEdition(void) const
Check if it is safe to call GetEdition method.
Definition: Book_.hpp:942
void ResetPubDate(void)
Reset PubDate data member.
Definition: Book_.cpp:91
bool IsSetIsbn(void) const
Check if a value has been assigned to Isbn data member.
Definition: Book_.hpp:978
const TReportNumber & GetReportNumber(void) const
Get the ReportNumber member data.
Definition: Book_.hpp:1061
void ResetAuthorList(void)
Reset AuthorList data member.
Definition: Book_.cpp:139
TPubDate & SetPubDate(void)
Assign a value to PubDate data member.
Definition: Book_.hpp:797
CCollectionTitle TCollectionTitle
Definition: Book_.hpp:111
bool IsSetBeginningDate(void) const
Check if a value has been assigned to BeginningDate data member.
Definition: Book_.hpp:806
bool IsSetCollectionTitle(void) const
Check if a value has been assigned to CollectionTitle data member.
Definition: Book_.hpp:957
TBookTitle & SetBookTitle(void)
Assign a value to BookTitle data member.
Definition: Book_.hpp:767
CReportNumber TReportNumber
Definition: Book_.hpp:115
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAuthorList > > m_AuthorList
Definition: Book_.hpp:694
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sat May 25 14:17:30 2024 by modify_doxy.py rev. 669887