NCBI C++ ToolKit
Cit_pat_.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 Cit_pat_.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/biblio/biblio.asn">biblio.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/biblio/biblio.def">biblio.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_BIBLIO_CIT_PAT_BASE_HPP
42 #define OBJECTS_BIBLIO_CIT_PAT_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 
60 // forward declarations
61 class CAuth_list;
62 class CDate;
63 class CPatent_priority;
64 
65 
66 // generated classes
67 
68 
69 /** @addtogroup dataspec_NCBI_Biblio
70  *
71  * @{
72  */
73 
74 /////////////////////////////////////////////////////////////////////////////
75 /// Patent number and date-issue were made optional in 1997 to
76 /// support patent applications being issued from the USPTO
77 /// Semantically a Cit-pat must have either a patent number or
78 /// an application number (or both) to be valid
79 /// patent citation
80 ///
81 /// CCit_pat_Base --
82 ///
83 
85 {
87 public:
88  // constructor
89  CCit_pat_Base(void);
90  // destructor
91  virtual ~CCit_pat_Base(void);
92 
93  // type info
95 
96  // types
97  typedef string TTitle;
99  typedef string TCountry;
100  typedef string TDoc_type;
101  typedef string TNumber;
103  typedef list< string > TClass;
104  typedef string TApp_number;
105  typedef CDate TApp_date;
108  typedef list< CRef< CPatent_priority > > TPriority;
109  typedef string TAbstract;
110 
111  // member index
112  enum class E_memberIndex {
113  e__allMandatory = 0,
114  e_title,
115  e_authors,
116  e_country,
117  e_doc_type,
118  e_number,
119  e_date_issue,
120  e_class,
121  e_app_number,
122  e_app_date,
123  e_applicants,
124  e_assignees,
125  e_priority,
126  e_abstract
127  };
129 
130  // getters
131  // setters
132 
133  /// Check if a value has been assigned to Title data member.
134  ///
135  /// Data member Title is mandatory;
136  /// its type is defined as 'typedef string TTitle'
137  /// @return
138  /// - true, if a value has been assigned.
139  /// - false, otherwise.
140  bool IsSetTitle(void) const;
141 
142  /// Check if it is safe to call GetTitle method.
143  ///
144  /// @return
145  /// - true, if the data member is getatable.
146  /// - false, otherwise.
147  bool CanGetTitle(void) const;
148 
149  /// Reset Title data member.
150  void ResetTitle(void);
151 
152  /// Get the Title member data.
153  ///
154  /// @return
155  /// Reference to the member data.
156  const TTitle& GetTitle(void) const;
157 
158  /// Assign a value to Title data member.
159  ///
160  /// @param value
161  /// Value to assign
162  void SetTitle(const TTitle& value);
163  void SetTitle(TTitle&& value);
164 
165  /// Assign a value to Title data member.
166  ///
167  /// @return
168  /// Reference to the data value.
169  TTitle& SetTitle(void);
170 
171  /// author/inventor
172  /// Check if a value has been assigned to Authors data member.
173  ///
174  /// Data member Authors is mandatory;
175  /// its type is defined as 'typedef CAuth_list TAuthors'
176  /// @return
177  /// - true, if a value has been assigned.
178  /// - false, otherwise.
179  bool IsSetAuthors(void) const;
180 
181  /// Check if it is safe to call GetAuthors method.
182  ///
183  /// @return
184  /// - true, if the data member is getatable.
185  /// - false, otherwise.
186  bool CanGetAuthors(void) const;
187 
188  /// Reset Authors data member.
189  void ResetAuthors(void);
190 
191  /// Get the Authors member data.
192  ///
193  /// @return
194  /// Reference to the member data.
195  const TAuthors& GetAuthors(void) const;
196 
197  /// Assign a value to Authors data member.
198  ///
199  /// @param value
200  /// Reference to value.
201  void SetAuthors(TAuthors& value);
202 
203  /// Assign a value to Authors data member.
204  ///
205  /// @return
206  /// Reference to the data value.
207  TAuthors& SetAuthors(void);
208 
209  /// Patent Document Country
210  /// Check if a value has been assigned to Country data member.
211  ///
212  /// Data member Country is mandatory;
213  /// its type is defined as 'typedef string TCountry'
214  /// @return
215  /// - true, if a value has been assigned.
216  /// - false, otherwise.
217  bool IsSetCountry(void) const;
218 
219  /// Check if it is safe to call GetCountry method.
220  ///
221  /// @return
222  /// - true, if the data member is getatable.
223  /// - false, otherwise.
224  bool CanGetCountry(void) const;
225 
226  /// Reset Country data member.
227  void ResetCountry(void);
228 
229  /// Get the Country member data.
230  ///
231  /// @return
232  /// Reference to the member data.
233  const TCountry& GetCountry(void) const;
234 
235  /// Assign a value to Country data member.
236  ///
237  /// @param value
238  /// Value to assign
239  void SetCountry(const TCountry& value);
240  void SetCountry(TCountry&& value);
241 
242  /// Assign a value to Country data member.
243  ///
244  /// @return
245  /// Reference to the data value.
246  TCountry& SetCountry(void);
247 
248  /// Patent Document Type
249  /// Check if a value has been assigned to Doc_type data member.
250  ///
251  /// Data member Doc_type is mandatory;
252  /// its type is defined as 'typedef string TDoc_type'
253  /// @return
254  /// - true, if a value has been assigned.
255  /// - false, otherwise.
256  bool IsSetDoc_type(void) const;
257 
258  /// Check if it is safe to call GetDoc_type method.
259  ///
260  /// @return
261  /// - true, if the data member is getatable.
262  /// - false, otherwise.
263  bool CanGetDoc_type(void) const;
264 
265  /// Reset Doc_type data member.
266  void ResetDoc_type(void);
267 
268  /// Get the Doc_type member data.
269  ///
270  /// @return
271  /// Reference to the member data.
272  const TDoc_type& GetDoc_type(void) const;
273 
274  /// Assign a value to Doc_type data member.
275  ///
276  /// @param value
277  /// Value to assign
278  void SetDoc_type(const TDoc_type& value);
279  void SetDoc_type(TDoc_type&& value);
280 
281  /// Assign a value to Doc_type data member.
282  ///
283  /// @return
284  /// Reference to the data value.
285  TDoc_type& SetDoc_type(void);
286 
287  /// Patent Document Number
288  /// Check if a value has been assigned to Number data member.
289  ///
290  /// Data member Number is optional;
291  /// its type is defined as 'typedef string TNumber'
292  /// @return
293  /// - true, if a value has been assigned.
294  /// - false, otherwise.
295  bool IsSetNumber(void) const;
296 
297  /// Check if it is safe to call GetNumber method.
298  ///
299  /// @return
300  /// - true, if the data member is getatable.
301  /// - false, otherwise.
302  bool CanGetNumber(void) const;
303 
304  /// Reset Number data member.
305  void ResetNumber(void);
306 
307  /// Get the Number member data.
308  ///
309  /// @return
310  /// Reference to the member data.
311  const TNumber& GetNumber(void) const;
312 
313  /// Assign a value to Number data member.
314  ///
315  /// @param value
316  /// Value to assign
317  void SetNumber(const TNumber& value);
318  void SetNumber(TNumber&& value);
319 
320  /// Assign a value to Number data member.
321  ///
322  /// @return
323  /// Reference to the data value.
324  TNumber& SetNumber(void);
325 
326  /// Patent Issue/Pub Date
327  /// Check if a value has been assigned to Date_issue data member.
328  ///
329  /// Data member Date_issue is optional;
330  /// its type is defined as 'typedef CDate TDate_issue'
331  /// @return
332  /// - true, if a value has been assigned.
333  /// - false, otherwise.
334  bool IsSetDate_issue(void) const;
335 
336  /// Check if it is safe to call GetDate_issue method.
337  ///
338  /// @return
339  /// - true, if the data member is getatable.
340  /// - false, otherwise.
341  bool CanGetDate_issue(void) const;
342 
343  /// Reset Date_issue data member.
344  void ResetDate_issue(void);
345 
346  /// Get the Date_issue member data.
347  ///
348  /// @return
349  /// Reference to the member data.
350  const TDate_issue& GetDate_issue(void) const;
351 
352  /// Assign a value to Date_issue data member.
353  ///
354  /// @param value
355  /// Reference to value.
356  void SetDate_issue(TDate_issue& value);
357 
358  /// Assign a value to Date_issue data member.
359  ///
360  /// @return
361  /// Reference to the data value.
362  TDate_issue& SetDate_issue(void);
363 
364  /// Patent Doc Class Code
365  /// Check if a value has been assigned to Class data member.
366  ///
367  /// Data member Class is optional;
368  /// its type is defined as 'typedef list< string > TClass'
369  /// @return
370  /// - true, if a value has been assigned.
371  /// - false, otherwise.
372  bool IsSetClass(void) const;
373 
374  /// Check if it is safe to call GetClass method.
375  ///
376  /// @return
377  /// - true, if the data member is getatable.
378  /// - false, otherwise.
379  bool CanGetClass(void) const;
380 
381  /// Reset Class data member.
382  void ResetClass(void);
383 
384  /// Get the Class member data.
385  ///
386  /// @return
387  /// Reference to the member data.
388  const TClass& GetClass(void) const;
389 
390  /// Assign a value to Class data member.
391  ///
392  /// @return
393  /// Reference to the data value.
394  TClass& SetClass(void);
395 
396  /// Patent Doc Appl Number
397  /// Check if a value has been assigned to App_number data member.
398  ///
399  /// Data member App_number is optional;
400  /// its type is defined as 'typedef string TApp_number'
401  /// @return
402  /// - true, if a value has been assigned.
403  /// - false, otherwise.
404  bool IsSetApp_number(void) const;
405 
406  /// Check if it is safe to call GetApp_number method.
407  ///
408  /// @return
409  /// - true, if the data member is getatable.
410  /// - false, otherwise.
411  bool CanGetApp_number(void) const;
412 
413  /// Reset App_number data member.
414  void ResetApp_number(void);
415 
416  /// Get the App_number member data.
417  ///
418  /// @return
419  /// Reference to the member data.
420  const TApp_number& GetApp_number(void) const;
421 
422  /// Assign a value to App_number data member.
423  ///
424  /// @param value
425  /// Value to assign
426  void SetApp_number(const TApp_number& value);
427  void SetApp_number(TApp_number&& value);
428 
429  /// Assign a value to App_number data member.
430  ///
431  /// @return
432  /// Reference to the data value.
433  TApp_number& SetApp_number(void);
434 
435  /// Patent Appl File Date
436  /// Check if a value has been assigned to App_date data member.
437  ///
438  /// Data member App_date is optional;
439  /// its type is defined as 'typedef CDate TApp_date'
440  /// @return
441  /// - true, if a value has been assigned.
442  /// - false, otherwise.
443  bool IsSetApp_date(void) const;
444 
445  /// Check if it is safe to call GetApp_date method.
446  ///
447  /// @return
448  /// - true, if the data member is getatable.
449  /// - false, otherwise.
450  bool CanGetApp_date(void) const;
451 
452  /// Reset App_date data member.
453  void ResetApp_date(void);
454 
455  /// Get the App_date member data.
456  ///
457  /// @return
458  /// Reference to the member data.
459  const TApp_date& GetApp_date(void) const;
460 
461  /// Assign a value to App_date data member.
462  ///
463  /// @param value
464  /// Reference to value.
465  void SetApp_date(TApp_date& value);
466 
467  /// Assign a value to App_date data member.
468  ///
469  /// @return
470  /// Reference to the data value.
471  TApp_date& SetApp_date(void);
472 
473  /// Applicants
474  /// Check if a value has been assigned to Applicants data member.
475  ///
476  /// Data member Applicants is optional;
477  /// its type is defined as 'typedef CAuth_list TApplicants'
478  /// @return
479  /// - true, if a value has been assigned.
480  /// - false, otherwise.
481  bool IsSetApplicants(void) const;
482 
483  /// Check if it is safe to call GetApplicants method.
484  ///
485  /// @return
486  /// - true, if the data member is getatable.
487  /// - false, otherwise.
488  bool CanGetApplicants(void) const;
489 
490  /// Reset Applicants data member.
491  void ResetApplicants(void);
492 
493  /// Get the Applicants member data.
494  ///
495  /// @return
496  /// Reference to the member data.
497  const TApplicants& GetApplicants(void) const;
498 
499  /// Assign a value to Applicants data member.
500  ///
501  /// @param value
502  /// Reference to value.
503  void SetApplicants(TApplicants& value);
504 
505  /// Assign a value to Applicants data member.
506  ///
507  /// @return
508  /// Reference to the data value.
509  TApplicants& SetApplicants(void);
510 
511  /// Assignees
512  /// Check if a value has been assigned to Assignees data member.
513  ///
514  /// Data member Assignees is optional;
515  /// its type is defined as 'typedef CAuth_list TAssignees'
516  /// @return
517  /// - true, if a value has been assigned.
518  /// - false, otherwise.
519  bool IsSetAssignees(void) const;
520 
521  /// Check if it is safe to call GetAssignees method.
522  ///
523  /// @return
524  /// - true, if the data member is getatable.
525  /// - false, otherwise.
526  bool CanGetAssignees(void) const;
527 
528  /// Reset Assignees data member.
529  void ResetAssignees(void);
530 
531  /// Get the Assignees member data.
532  ///
533  /// @return
534  /// Reference to the member data.
535  const TAssignees& GetAssignees(void) const;
536 
537  /// Assign a value to Assignees data member.
538  ///
539  /// @param value
540  /// Reference to value.
541  void SetAssignees(TAssignees& value);
542 
543  /// Assign a value to Assignees data member.
544  ///
545  /// @return
546  /// Reference to the data value.
547  TAssignees& SetAssignees(void);
548 
549  /// Priorities
550  /// Check if a value has been assigned to Priority data member.
551  ///
552  /// Data member Priority is optional;
553  /// its type is defined as 'typedef list< CRef< CPatent_priority > > TPriority'
554  /// @return
555  /// - true, if a value has been assigned.
556  /// - false, otherwise.
557  bool IsSetPriority(void) const;
558 
559  /// Check if it is safe to call GetPriority method.
560  ///
561  /// @return
562  /// - true, if the data member is getatable.
563  /// - false, otherwise.
564  bool CanGetPriority(void) const;
565 
566  /// Reset Priority data member.
567  void ResetPriority(void);
568 
569  /// Get the Priority member data.
570  ///
571  /// @return
572  /// Reference to the member data.
573  const TPriority& GetPriority(void) const;
574 
575  /// Assign a value to Priority data member.
576  ///
577  /// @return
578  /// Reference to the data value.
579  TPriority& SetPriority(void);
580 
581  /// abstract of patent
582  /// Check if a value has been assigned to Abstract data member.
583  ///
584  /// Data member Abstract is optional;
585  /// its type is defined as 'typedef string TAbstract'
586  /// @return
587  /// - true, if a value has been assigned.
588  /// - false, otherwise.
589  bool IsSetAbstract(void) const;
590 
591  /// Check if it is safe to call GetAbstract method.
592  ///
593  /// @return
594  /// - true, if the data member is getatable.
595  /// - false, otherwise.
596  bool CanGetAbstract(void) const;
597 
598  /// Reset Abstract data member.
599  void ResetAbstract(void);
600 
601  /// Get the Abstract member data.
602  ///
603  /// @return
604  /// Reference to the member data.
605  const TAbstract& GetAbstract(void) const;
606 
607  /// Assign a value to Abstract data member.
608  ///
609  /// @param value
610  /// Value to assign
611  void SetAbstract(const TAbstract& value);
612  void SetAbstract(TAbstract&& value);
613 
614  /// Assign a value to Abstract data member.
615  ///
616  /// @return
617  /// Reference to the data value.
618  TAbstract& SetAbstract(void);
619 
620  /// Reset the whole object
621  virtual void Reset(void);
622 
623 
624 private:
625  // Prohibit copy constructor and assignment operator
628 
629  // data
630  Uint4 m_set_State[1];
631  string m_Title;
633  string m_Country;
634  string m_Doc_type;
635  string m_Number;
637  list< string > m_Class;
638  string m_App_number;
642  list< CRef< CPatent_priority > > m_Priority;
643  string m_Abstract;
644 };
645 
646 /* @} */
647 
648 
649 
650 
651 
652 ///////////////////////////////////////////////////////////
653 ///////////////////// inline methods //////////////////////
654 ///////////////////////////////////////////////////////////
655 inline
657 {
658  return ((m_set_State[0] & 0x3) != 0);
659 }
660 
661 inline
663 {
664  return IsSetTitle();
665 }
666 
667 inline
669 {
670  if (!CanGetTitle()) {
671  ThrowUnassigned(0);
672  }
673  return m_Title;
674 }
675 
676 inline
678 {
679  m_Title = value;
680  m_set_State[0] |= 0x3;
681 }
682 
683 inline
685 {
686  m_Title = std::forward<CCit_pat_Base::TTitle>(value);
687  m_set_State[0] |= 0x3;
688 }
689 
690 inline
692 {
693 #ifdef _DEBUG
694  if (!IsSetTitle()) {
696  }
697 #endif
698  m_set_State[0] |= 0x1;
699  return m_Title;
700 }
701 
702 inline
704 {
705  return m_Authors.NotEmpty();
706 }
707 
708 inline
710 {
711  return true;
712 }
713 
714 inline
716 {
717  if ( !m_Authors ) {
718  const_cast<CCit_pat_Base*>(this)->ResetAuthors();
719  }
720  return (*m_Authors);
721 }
722 
723 inline
725 {
726  if ( !m_Authors ) {
727  ResetAuthors();
728  }
729  return (*m_Authors);
730 }
731 
732 inline
734 {
735  return ((m_set_State[0] & 0x30) != 0);
736 }
737 
738 inline
740 {
741  return IsSetCountry();
742 }
743 
744 inline
746 {
747  if (!CanGetCountry()) {
748  ThrowUnassigned(2);
749  }
750  return m_Country;
751 }
752 
753 inline
755 {
756  m_Country = value;
757  m_set_State[0] |= 0x30;
758 }
759 
760 inline
762 {
763  m_Country = std::forward<CCit_pat_Base::TCountry>(value);
764  m_set_State[0] |= 0x30;
765 }
766 
767 inline
769 {
770 #ifdef _DEBUG
771  if (!IsSetCountry()) {
773  }
774 #endif
775  m_set_State[0] |= 0x10;
776  return m_Country;
777 }
778 
779 inline
781 {
782  return ((m_set_State[0] & 0xc0) != 0);
783 }
784 
785 inline
787 {
788  return IsSetDoc_type();
789 }
790 
791 inline
793 {
794  if (!CanGetDoc_type()) {
795  ThrowUnassigned(3);
796  }
797  return m_Doc_type;
798 }
799 
800 inline
802 {
803  m_Doc_type = value;
804  m_set_State[0] |= 0xc0;
805 }
806 
807 inline
809 {
810  m_Doc_type = std::forward<CCit_pat_Base::TDoc_type>(value);
811  m_set_State[0] |= 0xc0;
812 }
813 
814 inline
816 {
817 #ifdef _DEBUG
818  if (!IsSetDoc_type()) {
820  }
821 #endif
822  m_set_State[0] |= 0x40;
823  return m_Doc_type;
824 }
825 
826 inline
828 {
829  return ((m_set_State[0] & 0x300) != 0);
830 }
831 
832 inline
834 {
835  return IsSetNumber();
836 }
837 
838 inline
840 {
841  if (!CanGetNumber()) {
842  ThrowUnassigned(4);
843  }
844  return m_Number;
845 }
846 
847 inline
849 {
850  m_Number = value;
851  m_set_State[0] |= 0x300;
852 }
853 
854 inline
856 {
857  m_Number = std::forward<CCit_pat_Base::TNumber>(value);
858  m_set_State[0] |= 0x300;
859 }
860 
861 inline
863 {
864 #ifdef _DEBUG
865  if (!IsSetNumber()) {
867  }
868 #endif
869  m_set_State[0] |= 0x100;
870  return m_Number;
871 }
872 
873 inline
875 {
876  return m_Date_issue.NotEmpty();
877 }
878 
879 inline
881 {
882  return IsSetDate_issue();
883 }
884 
885 inline
887 {
888  if (!CanGetDate_issue()) {
889  ThrowUnassigned(5);
890  }
891  return (*m_Date_issue);
892 }
893 
894 inline
896 {
897  return ((m_set_State[0] & 0x3000) != 0);
898 }
899 
900 inline
902 {
903  return true;
904 }
905 
906 inline
908 {
909  return m_Class;
910 }
911 
912 inline
914 {
915  m_set_State[0] |= 0x1000;
916  return m_Class;
917 }
918 
919 inline
921 {
922  return ((m_set_State[0] & 0xc000) != 0);
923 }
924 
925 inline
927 {
928  return IsSetApp_number();
929 }
930 
931 inline
933 {
934  if (!CanGetApp_number()) {
935  ThrowUnassigned(7);
936  }
937  return m_App_number;
938 }
939 
940 inline
942 {
944  m_set_State[0] |= 0xc000;
945 }
946 
947 inline
949 {
950  m_App_number = std::forward<CCit_pat_Base::TApp_number>(value);
951  m_set_State[0] |= 0xc000;
952 }
953 
954 inline
956 {
957 #ifdef _DEBUG
958  if (!IsSetApp_number()) {
960  }
961 #endif
962  m_set_State[0] |= 0x4000;
963  return m_App_number;
964 }
965 
966 inline
968 {
969  return m_App_date.NotEmpty();
970 }
971 
972 inline
974 {
975  return IsSetApp_date();
976 }
977 
978 inline
980 {
981  if (!CanGetApp_date()) {
982  ThrowUnassigned(8);
983  }
984  return (*m_App_date);
985 }
986 
987 inline
989 {
990  return m_Applicants.NotEmpty();
991 }
992 
993 inline
995 {
996  return IsSetApplicants();
997 }
998 
999 inline
1001 {
1002  if (!CanGetApplicants()) {
1003  ThrowUnassigned(9);
1004  }
1005  return (*m_Applicants);
1006 }
1007 
1008 inline
1010 {
1011  return m_Assignees.NotEmpty();
1012 }
1013 
1014 inline
1016 {
1017  return IsSetAssignees();
1018 }
1019 
1020 inline
1022 {
1023  if (!CanGetAssignees()) {
1024  ThrowUnassigned(10);
1025  }
1026  return (*m_Assignees);
1027 }
1028 
1029 inline
1031 {
1032  return ((m_set_State[0] & 0xc00000) != 0);
1033 }
1034 
1035 inline
1037 {
1038  return true;
1039 }
1040 
1041 inline
1043 {
1044  return m_Priority;
1045 }
1046 
1047 inline
1049 {
1050  m_set_State[0] |= 0x400000;
1051  return m_Priority;
1052 }
1053 
1054 inline
1056 {
1057  return ((m_set_State[0] & 0x3000000) != 0);
1058 }
1059 
1060 inline
1062 {
1063  return IsSetAbstract();
1064 }
1065 
1066 inline
1068 {
1069  if (!CanGetAbstract()) {
1070  ThrowUnassigned(12);
1071  }
1072  return m_Abstract;
1073 }
1074 
1075 inline
1077 {
1078  m_Abstract = value;
1079  m_set_State[0] |= 0x3000000;
1080 }
1081 
1082 inline
1084 {
1085  m_Abstract = std::forward<CCit_pat_Base::TAbstract>(value);
1086  m_set_State[0] |= 0x3000000;
1087 }
1088 
1089 inline
1091 {
1092 #ifdef _DEBUG
1093  if (!IsSetAbstract()) {
1095  }
1096 #endif
1097  m_set_State[0] |= 0x1000000;
1098  return m_Abstract;
1099 }
1100 
1101 ///////////////////////////////////////////////////////////
1102 ////////////////// end of inline methods //////////////////
1103 ///////////////////////////////////////////////////////////
1104 
1105 
1106 
1107 
1108 
1109 END_objects_SCOPE // namespace ncbi::objects::
1110 
1112 
1113 
1114 #endif // OBJECTS_BIBLIO_CIT_PAT_BASE_HPP
@Auth_list.hpp User-defined methods of the data storage class.
Definition: Auth_list.hpp:57
Patent number and date-issue were made optional in 1997 to support patent applications being issued f...
Definition: Cit_pat_.hpp:85
Definition: Date.hpp:53
CPatent_priority –.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
char value[7]
Definition: config.c:431
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
NCBI_XOBJUTIL_EXPORT string GetTitle(const CBioseq_Handle &hnd, TGetTitleFlags flags=0)
Definition: seqtitle.cpp:106
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_BIBLIO_EXPORT
Definition: ncbi_export.h:312
list< CRef< CPatent_priority > > m_Priority
Definition: Cit_pat_.hpp:642
TPriority & SetPriority(void)
Assign a value to Priority data member.
Definition: Cit_pat_.hpp:1048
bool IsSetPriority(void) const
Priorities Check if a value has been assigned to Priority data member.
Definition: Cit_pat_.hpp:1030
const TDoc_type & GetDoc_type(void) const
Get the Doc_type member data.
Definition: Cit_pat_.hpp:792
bool IsSetNumber(void) const
Patent Document Number Check if a value has been assigned to Number data member.
Definition: Cit_pat_.hpp:827
string TApp_number
Definition: Cit_pat_.hpp:104
bool IsSetAbstract(void) const
abstract of patent Check if a value has been assigned to Abstract data member.
Definition: Cit_pat_.hpp:1055
string TAbstract
Definition: Cit_pat_.hpp:109
CRef< TApplicants > m_Applicants
Definition: Cit_pat_.hpp:640
string m_Country
Definition: Cit_pat_.hpp:633
bool IsSetApplicants(void) const
Applicants Check if a value has been assigned to Applicants data member.
Definition: Cit_pat_.hpp:988
CAuth_list TApplicants
Definition: Cit_pat_.hpp:106
string TDoc_type
Definition: Cit_pat_.hpp:100
bool IsSetAssignees(void) const
Assignees Check if a value has been assigned to Assignees data member.
Definition: Cit_pat_.hpp:1009
CCit_pat_Base & operator=(const CCit_pat_Base &)
CCit_pat_Base(const CCit_pat_Base &)
const TApp_date & GetApp_date(void) const
Get the App_date member data.
Definition: Cit_pat_.hpp:979
const TAbstract & GetAbstract(void) const
Get the Abstract member data.
Definition: Cit_pat_.hpp:1067
CRef< TAuthors > m_Authors
Definition: Cit_pat_.hpp:632
string TCountry
Definition: Cit_pat_.hpp:99
DECLARE_INTERNAL_TYPE_INFO()
string m_Title
Definition: Cit_pat_.hpp:631
bool CanGetClass(void) const
Check if it is safe to call GetClass method.
Definition: Cit_pat_.hpp:901
const TDate_issue & GetDate_issue(void) const
Get the Date_issue member data.
Definition: Cit_pat_.hpp:886
TAbstract & SetAbstract(void)
Assign a value to Abstract data member.
Definition: Cit_pat_.hpp:1090
bool CanGetAbstract(void) const
Check if it is safe to call GetAbstract method.
Definition: Cit_pat_.hpp:1061
CRef< TApp_date > m_App_date
Definition: Cit_pat_.hpp:639
string TNumber
Definition: Cit_pat_.hpp:101
string m_Number
Definition: Cit_pat_.hpp:635
bool CanGetDate_issue(void) const
Check if it is safe to call GetDate_issue method.
Definition: Cit_pat_.hpp:880
bool CanGetDoc_type(void) const
Check if it is safe to call GetDoc_type method.
Definition: Cit_pat_.hpp:786
string m_Abstract
Definition: Cit_pat_.hpp:643
bool CanGetCountry(void) const
Check if it is safe to call GetCountry method.
Definition: Cit_pat_.hpp:739
list< CRef< CPatent_priority > > TPriority
Definition: Cit_pat_.hpp:108
bool CanGetApp_number(void) const
Check if it is safe to call GetApp_number method.
Definition: Cit_pat_.hpp:926
bool CanGetNumber(void) const
Check if it is safe to call GetNumber method.
Definition: Cit_pat_.hpp:833
bool IsSetAuthors(void) const
author/inventor Check if a value has been assigned to Authors data member.
Definition: Cit_pat_.hpp:703
bool CanGetPriority(void) const
Check if it is safe to call GetPriority method.
Definition: Cit_pat_.hpp:1036
bool IsSetDoc_type(void) const
Patent Document Type Check if a value has been assigned to Doc_type data member.
Definition: Cit_pat_.hpp:780
CDate TDate_issue
Definition: Cit_pat_.hpp:102
const TNumber & GetNumber(void) const
Get the Number member data.
Definition: Cit_pat_.hpp:839
CSerialObject Tparent
Definition: Cit_pat_.hpp:86
const TPriority & GetPriority(void) const
Get the Priority member data.
Definition: Cit_pat_.hpp:1042
const TAuthors & GetAuthors(void) const
Get the Authors member data.
Definition: Cit_pat_.hpp:715
const TApplicants & GetApplicants(void) const
Get the Applicants member data.
Definition: Cit_pat_.hpp:1000
CRef< TAssignees > m_Assignees
Definition: Cit_pat_.hpp:641
bool CanGetAuthors(void) const
Check if it is safe to call GetAuthors method.
Definition: Cit_pat_.hpp:709
bool IsSetTitle(void) const
Check if a value has been assigned to Title data member.
Definition: Cit_pat_.hpp:656
TDoc_type & SetDoc_type(void)
Assign a value to Doc_type data member.
Definition: Cit_pat_.hpp:815
bool CanGetAssignees(void) const
Check if it is safe to call GetAssignees method.
Definition: Cit_pat_.hpp:1015
CAuth_list TAssignees
Definition: Cit_pat_.hpp:107
CDate TApp_date
Definition: Cit_pat_.hpp:105
bool IsSetClass(void) const
Patent Doc Class Code Check if a value has been assigned to Class data member.
Definition: Cit_pat_.hpp:895
Tparent::CMemberIndex< E_memberIndex, 14 > TmemberIndex
Definition: Cit_pat_.hpp:128
bool CanGetApplicants(void) const
Check if it is safe to call GetApplicants method.
Definition: Cit_pat_.hpp:994
TApp_number & SetApp_number(void)
Assign a value to App_number data member.
Definition: Cit_pat_.hpp:955
void ResetAuthors(void)
Reset Authors data member.
Definition: Cit_pat_.cpp:59
TNumber & SetNumber(void)
Assign a value to Number data member.
Definition: Cit_pat_.hpp:862
TClass & SetClass(void)
Assign a value to Class data member.
Definition: Cit_pat_.hpp:913
TAuthors & SetAuthors(void)
Assign a value to Authors data member.
Definition: Cit_pat_.hpp:724
bool IsSetApp_date(void) const
Patent Appl File Date Check if a value has been assigned to App_date data member.
Definition: Cit_pat_.hpp:967
bool IsSetApp_number(void) const
Patent Doc Appl Number Check if a value has been assigned to App_number data member.
Definition: Cit_pat_.hpp:920
bool CanGetApp_date(void) const
Check if it is safe to call GetApp_date method.
Definition: Cit_pat_.hpp:973
const TClass & GetClass(void) const
Get the Class member data.
Definition: Cit_pat_.hpp:907
const TApp_number & GetApp_number(void) const
Get the App_number member data.
Definition: Cit_pat_.hpp:932
string m_Doc_type
Definition: Cit_pat_.hpp:634
const TAssignees & GetAssignees(void) const
Get the Assignees member data.
Definition: Cit_pat_.hpp:1021
bool CanGetTitle(void) const
Check if it is safe to call GetTitle method.
Definition: Cit_pat_.hpp:662
list< string > m_Class
Definition: Cit_pat_.hpp:637
const TTitle & GetTitle(void) const
Get the Title member data.
Definition: Cit_pat_.hpp:668
Uint4 m_set_State[1]
Definition: Cit_pat_.hpp:630
TTitle & SetTitle(void)
Assign a value to Title data member.
Definition: Cit_pat_.hpp:691
TCountry & SetCountry(void)
Assign a value to Country data member.
Definition: Cit_pat_.hpp:768
string m_App_number
Definition: Cit_pat_.hpp:638
bool IsSetDate_issue(void) const
Patent Issue/Pub Date Check if a value has been assigned to Date_issue data member.
Definition: Cit_pat_.hpp:874
list< string > TClass
Definition: Cit_pat_.hpp:103
const TCountry & GetCountry(void) const
Get the Country member data.
Definition: Cit_pat_.hpp:745
string TTitle
Definition: Cit_pat_.hpp:97
CAuth_list TAuthors
Definition: Cit_pat_.hpp:98
CRef< TDate_issue > m_Date_issue
Definition: Cit_pat_.hpp:636
bool IsSetCountry(void) const
Patent Document Country Check if a value has been assigned to Country data member.
Definition: Cit_pat_.hpp:733
static void SetTitle(CRef< CSeq_entry > entry, string title)
Modified on Tue Feb 27 05:50:04 2024 by modify_doxy.py rev. 669887