NCBI C++ ToolKit
Abstract_.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 Abstract_.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_ABSTRACT_BASE_HPP
42 #define eutils__OBJTOOLS_EUTILS_EFETCH_ABSTRACT_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 CAbstractText;
60 
61 
62 // generated classes
63 
64 
65 /** @addtogroup dataspec_efetch
66  *
67  * @{
68  */
69 
70 /////////////////////////////////////////////////////////////////////////////
71 /// =================================================================
72 /// Everything else in alphabetical order
73 /// =================================================================
74 ///
75 /// CAbstract_Base --
76 ///
77 
78 class CAbstract_Base : public NCBI_NS_NCBI::CSerialObject
79 {
80  typedef NCBI_NS_NCBI::CSerialObject Tparent;
81 public:
82  // constructor
83  CAbstract_Base(void);
84  // destructor
85  virtual ~CAbstract_Base(void);
86 
87  // type info
89 
90  // types
91  typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAbstractText > > TAbstractText;
93 
94  // member index
95  enum class E_memberIndex {
96  e__allMandatory = 0,
99  };
100  typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
101 
102  // getters
103  // setters
104 
105  /// Check if a value has been assigned to AbstractText data member.
106  ///
107  /// Data member AbstractText is mandatory;
108  /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAbstractText > > TAbstractText'
109  /// @return
110  /// - true, if a value has been assigned.
111  /// - false, otherwise.
112  bool IsSetAbstractText(void) const;
113 
114  /// Check if it is safe to call GetAbstractText method.
115  ///
116  /// @return
117  /// - true, if the data member is getatable.
118  /// - false, otherwise.
119  bool CanGetAbstractText(void) const;
120 
121  /// Reset AbstractText data member.
122  void ResetAbstractText(void);
123 
124  /// Get the AbstractText member data.
125  ///
126  /// @return
127  /// Reference to the member data.
128  const TAbstractText& GetAbstractText(void) const;
129 
130  /// Assign a value to AbstractText data member.
131  ///
132  /// @return
133  /// Reference to the data value.
135 
136  /// Check if a value has been assigned to CopyrightInformation data member.
137  ///
138  /// Data member CopyrightInformation is optional;
139  /// its type is defined as 'typedef CCopyrightInformation TCopyrightInformation'
140  /// @return
141  /// - true, if a value has been assigned.
142  /// - false, otherwise.
143  bool IsSetCopyrightInformation(void) const;
144 
145  /// Check if it is safe to call GetCopyrightInformation method.
146  ///
147  /// @return
148  /// - true, if the data member is getatable.
149  /// - false, otherwise.
150  bool CanGetCopyrightInformation(void) const;
151 
152  /// Reset CopyrightInformation data member.
153  void ResetCopyrightInformation(void);
154 
155  /// Get the CopyrightInformation member data.
156  ///
157  /// @return
158  /// Reference to the member data.
160 
161  /// Assign a value to CopyrightInformation data member.
162  ///
163  /// @param value
164  /// Reference to value.
166 
167  /// Assign a value to CopyrightInformation data member.
168  ///
169  /// @return
170  /// Reference to the data value.
172 
173  /// Reset the whole object
174  virtual void Reset(void);
175 
176 
177 private:
178  // Prohibit copy constructor and assignment operator
181 
182  // data
184  NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAbstractText > > m_AbstractText;
185  NCBI_NS_NCBI::CRef< TCopyrightInformation > m_CopyrightInformation;
186 };
187 
188 /* @} */
189 
190 
191 
192 
193 
194 ///////////////////////////////////////////////////////////
195 ///////////////////// inline methods //////////////////////
196 ///////////////////////////////////////////////////////////
197 inline
199 {
200  return ((m_set_State[0] & 0x3) != 0);
201 }
202 
203 inline
205 {
206  return true;
207 }
208 
209 inline
211 {
212  return m_AbstractText;
213 }
214 
215 inline
217 {
218  m_set_State[0] |= 0x1;
219  return m_AbstractText;
220 }
221 
222 inline
224 {
225  return m_CopyrightInformation.NotEmpty();
226 }
227 
228 inline
230 {
231  return IsSetCopyrightInformation();
232 }
233 
234 inline
236 {
238  ThrowUnassigned(1);
239  }
240  return (*m_CopyrightInformation);
241 }
242 
243 ///////////////////////////////////////////////////////////
244 ////////////////// end of inline methods //////////////////
245 ///////////////////////////////////////////////////////////
246 
247 
248 
249 
250 
251 END_eutils_SCOPE // namespace eutils::
252 
253 
254 #endif // eutils__OBJTOOLS_EUTILS_EFETCH_ABSTRACT_BASE_HPP
#define BEGIN_eutils_SCOPE
Definition: Abstract_.hpp:51
#define END_eutils_SCOPE
Definition: Abstract_.hpp:52
CAbstractText –.
================================================================= Everything else in alphabetical ord...
Definition: Abstract_.hpp:79
CCopyrightInformation –.
char value[7]
Definition: config.c:431
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
NCBI_NS_NCBI::CRef< TCopyrightInformation > m_CopyrightInformation
Definition: Abstract_.hpp:185
virtual void Reset(void)
Reset the whole object.
Definition: Abstract_.cpp:73
CAbstract_Base & operator=(const CAbstract_Base &)
CAbstract_Base(const CAbstract_Base &)
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Definition: Abstract_.hpp:100
TAbstractText & SetAbstractText(void)
Assign a value to AbstractText data member.
Definition: Abstract_.hpp:216
void ResetCopyrightInformation(void)
Reset CopyrightInformation data member.
Definition: Abstract_.cpp:56
const TCopyrightInformation & GetCopyrightInformation(void) const
Get the CopyrightInformation member data.
Definition: Abstract_.hpp:235
CAbstract_Base(void)
Definition: Abstract_.cpp:92
TCopyrightInformation & SetCopyrightInformation(void)
Assign a value to CopyrightInformation data member.
Definition: Abstract_.cpp:66
virtual ~CAbstract_Base(void)
Definition: Abstract_.cpp:98
bool CanGetAbstractText(void) const
Check if it is safe to call GetAbstractText method.
Definition: Abstract_.hpp:204
void ResetAbstractText(void)
Reset AbstractText data member.
Definition: Abstract_.cpp:50
NCBI_NS_NCBI::CSerialObject Tparent
Definition: Abstract_.hpp:80
DECLARE_INTERNAL_TYPE_INFO()
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAbstractText > > TAbstractText
Definition: Abstract_.hpp:91
NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAbstractText > > m_AbstractText
Definition: Abstract_.hpp:184
bool IsSetCopyrightInformation(void) const
Check if a value has been assigned to CopyrightInformation data member.
Definition: Abstract_.hpp:223
Uint4 m_set_State[1]
Definition: Abstract_.hpp:183
bool CanGetCopyrightInformation(void) const
Check if it is safe to call GetCopyrightInformation method.
Definition: Abstract_.hpp:229
CCopyrightInformation TCopyrightInformation
Definition: Abstract_.hpp:92
bool IsSetAbstractText(void) const
Check if a value has been assigned to AbstractText data member.
Definition: Abstract_.hpp:198
const TAbstractText & GetAbstractText(void) const
Get the AbstractText member data.
Definition: Abstract_.hpp:210
Modified on Fri Jan 05 07:24:20 2024 by modify_doxy.py rev. 669887