NCBI C++ ToolKit
History_.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 History_.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_HISTORY_BASE_HPP
42 #define eutils__OBJTOOLS_EUTILS_EFETCH_HISTORY_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 CPubMedPubDate;
59 
60 
61 // generated classes
62 
63 
64 /** @addtogroup dataspec_efetch
65  *
66  * @{
67  */
68 
69 /////////////////////////////////////////////////////////////////////////////
70 ///
71 /// CHistory_Base --
72 ///
73 
74 class CHistory_Base : public NCBI_NS_NCBI::CSerialObject
75 {
76  typedef NCBI_NS_NCBI::CSerialObject Tparent;
77 public:
78  // constructor
79  CHistory_Base(void);
80  // destructor
81  virtual ~CHistory_Base(void);
82 
83  // type info
85 
86  // types
88  typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CPubMedPubDate > > TPubMedPubDate;
89 
90  // member index
91  enum class E_memberIndex {
92  e__allMandatory = 0,
94  };
95  typedef Tparent::CMemberIndex<E_memberIndex, 2> TmemberIndex;
96 
97  // getters
98  // setters
99 
100  /// Check if a value has been assigned to PubMedPubDate data member.
101  ///
102  /// Data member PubMedPubDate is mandatory;
103  /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CPubMedPubDate > > TPubMedPubDate'
104  /// @return
105  /// - true, if a value has been assigned.
106  /// - false, otherwise.
107  bool IsSetPubMedPubDate(void) const;
108 
109  /// Check if it is safe to call GetPubMedPubDate method.
110  ///
111  /// @return
112  /// - true, if the data member is getatable.
113  /// - false, otherwise.
114  bool CanGetPubMedPubDate(void) const;
115 
116  /// Reset PubMedPubDate data member.
117  void ResetPubMedPubDate(void);
118 
119  /// Get the PubMedPubDate member data.
120  ///
121  /// @return
122  /// Reference to the member data.
123  const TPubMedPubDate& GetPubMedPubDate(void) const;
124 
125  /// Assign a value to PubMedPubDate data member.
126  ///
127  /// @return
128  /// Reference to the data value.
130 
131  /// Reset the whole object
132  virtual void Reset(void);
133 
134 
135 private:
136  // Prohibit copy constructor and assignment operator
139 
140  // data
142  NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CPubMedPubDate > > m_PubMedPubDate;
143 };
144 
145 /* @} */
146 
147 
148 
149 
150 
151 ///////////////////////////////////////////////////////////
152 ///////////////////// inline methods //////////////////////
153 ///////////////////////////////////////////////////////////
154 inline
156 {
157  return ((m_set_State[0] & 0x3) != 0);
158 }
159 
160 inline
162 {
163  return true;
164 }
165 
166 inline
168 {
169  return m_PubMedPubDate;
170 }
171 
172 inline
174 {
175  m_set_State[0] |= 0x1;
176  return m_PubMedPubDate;
177 }
178 
179 ///////////////////////////////////////////////////////////
180 ////////////////// end of inline methods //////////////////
181 ///////////////////////////////////////////////////////////
182 
183 
184 
185 
186 
187 END_eutils_SCOPE // namespace eutils::
188 
189 
190 #endif // eutils__OBJTOOLS_EUTILS_EFETCH_HISTORY_BASE_HPP
#define BEGIN_eutils_SCOPE
Definition: History_.hpp:51
#define END_eutils_SCOPE
Definition: History_.hpp:52
CHistory_Base –.
Definition: History_.hpp:75
CPubMedPubDate –.
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
virtual ~CHistory_Base(void)
Definition: History_.cpp:78
TPubMedPubDate & SetPubMedPubDate(void)
Assign a value to PubMedPubDate data member.
Definition: History_.hpp:173
Uint4 m_set_State[1]
Definition: History_.hpp:141
virtual void Reset(void)
Reset the whole object.
Definition: History_.cpp:55
DECLARE_INTERNAL_TYPE_INFO()
CHistory_Base(const CHistory_Base &)
bool IsSetPubMedPubDate(void) const
Check if a value has been assigned to PubMedPubDate data member.
Definition: History_.hpp:155
Tparent::CMemberIndex< E_memberIndex, 2 > TmemberIndex
Definition: History_.hpp:95
CPubMedPubDate C_E
Definition: History_.hpp:87
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CPubMedPubDate > > TPubMedPubDate
Definition: History_.hpp:88
NCBI_NS_NCBI::CSerialObject Tparent
Definition: History_.hpp:76
void ResetPubMedPubDate(void)
Reset PubMedPubDate data member.
Definition: History_.cpp:49
const TPubMedPubDate & GetPubMedPubDate(void) const
Get the PubMedPubDate member data.
Definition: History_.hpp:167
CHistory_Base & operator=(const CHistory_Base &)
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CPubMedPubDate > > m_PubMedPubDate
Definition: History_.hpp:142
bool CanGetPubMedPubDate(void) const
Check if it is safe to call GetPubMedPubDate method.
Definition: History_.hpp:161
CHistory_Base(void)
Definition: History_.cpp:72
Modified on Fri Mar 01 10:05:19 2024 by modify_doxy.py rev. 669887