NCBI C++ ToolKit
Mim_page_.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 Mim_page_.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/mim/mim.asn">mim.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mim/mim.def">mim.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_MIM_MIM_PAGE_BASE_HPP
42 #define OBJECTS_MIM_MIM_PAGE_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
49 
51 
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
55 #endif
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57 
58 
59 // generated classes
60 
61 
62 /** @addtogroup dataspec_NCBI_Mim
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///
69 /// CMim_page_Base --
70 ///
71 
73 {
75 public:
76  // constructor
77  CMim_page_Base(void);
78  // destructor
79  virtual ~CMim_page_Base(void);
80 
81  // type info
83 
84  // types
85  typedef string TFrom;
86  typedef string TTo;
87 
88  // member index
89  enum class E_memberIndex {
90  e__allMandatory = 0,
91  e_from,
92  e_to
93  };
95 
96  // getters
97  // setters
98 
99  /// Check if a value has been assigned to From data member.
100  ///
101  /// Data member From is mandatory;
102  /// its type is defined as 'typedef string TFrom'
103  /// @return
104  /// - true, if a value has been assigned.
105  /// - false, otherwise.
106  bool IsSetFrom(void) const;
107 
108  /// Check if it is safe to call GetFrom method.
109  ///
110  /// @return
111  /// - true, if the data member is getatable.
112  /// - false, otherwise.
113  bool CanGetFrom(void) const;
114 
115  /// Reset From data member.
116  void ResetFrom(void);
117 
118  /// Get the From member data.
119  ///
120  /// @return
121  /// Reference to the member data.
122  const TFrom& GetFrom(void) const;
123 
124  /// Assign a value to From data member.
125  ///
126  /// @param value
127  /// Value to assign
128  void SetFrom(const TFrom& value);
129  void SetFrom(TFrom&& value);
130 
131  /// Assign a value to From data member.
132  ///
133  /// @return
134  /// Reference to the data value.
135  TFrom& SetFrom(void);
136 
137  /// Check if a value has been assigned to To data member.
138  ///
139  /// Data member To is optional;
140  /// its type is defined as 'typedef string TTo'
141  /// @return
142  /// - true, if a value has been assigned.
143  /// - false, otherwise.
144  bool IsSetTo(void) const;
145 
146  /// Check if it is safe to call GetTo method.
147  ///
148  /// @return
149  /// - true, if the data member is getatable.
150  /// - false, otherwise.
151  bool CanGetTo(void) const;
152 
153  /// Reset To data member.
154  void ResetTo(void);
155 
156  /// Get the To member data.
157  ///
158  /// @return
159  /// Reference to the member data.
160  const TTo& GetTo(void) const;
161 
162  /// Assign a value to To data member.
163  ///
164  /// @param value
165  /// Value to assign
166  void SetTo(const TTo& value);
167  void SetTo(TTo&& value);
168 
169  /// Assign a value to To data member.
170  ///
171  /// @return
172  /// Reference to the data value.
173  TTo& SetTo(void);
174 
175  /// Reset the whole object
176  virtual void Reset(void);
177 
178 
179 private:
180  // Prohibit copy constructor and assignment operator
183 
184  // data
185  Uint4 m_set_State[1];
186  string m_From;
187  string m_To;
188 };
189 
190 /* @} */
191 
192 
193 
194 
195 
196 ///////////////////////////////////////////////////////////
197 ///////////////////// inline methods //////////////////////
198 ///////////////////////////////////////////////////////////
199 inline
201 {
202  return ((m_set_State[0] & 0x3) != 0);
203 }
204 
205 inline
207 {
208  return IsSetFrom();
209 }
210 
211 inline
213 {
214  if (!CanGetFrom()) {
215  ThrowUnassigned(0);
216  }
217  return m_From;
218 }
219 
220 inline
222 {
223  m_From = value;
224  m_set_State[0] |= 0x3;
225 }
226 
227 inline
229 {
230  m_From = std::forward<CMim_page_Base::TFrom>(value);
231  m_set_State[0] |= 0x3;
232 }
233 
234 inline
236 {
237 #ifdef _DEBUG
238  if (!IsSetFrom()) {
240  }
241 #endif
242  m_set_State[0] |= 0x1;
243  return m_From;
244 }
245 
246 inline
247 bool CMim_page_Base::IsSetTo(void) const
248 {
249  return ((m_set_State[0] & 0xc) != 0);
250 }
251 
252 inline
253 bool CMim_page_Base::CanGetTo(void) const
254 {
255  return IsSetTo();
256 }
257 
258 inline
260 {
261  if (!CanGetTo()) {
262  ThrowUnassigned(1);
263  }
264  return m_To;
265 }
266 
267 inline
269 {
270  m_To = value;
271  m_set_State[0] |= 0xc;
272 }
273 
274 inline
276 {
277  m_To = std::forward<CMim_page_Base::TTo>(value);
278  m_set_State[0] |= 0xc;
279 }
280 
281 inline
283 {
284 #ifdef _DEBUG
285  if (!IsSetTo()) {
287  }
288 #endif
289  m_set_State[0] |= 0x4;
290  return m_To;
291 }
292 
293 ///////////////////////////////////////////////////////////
294 ////////////////// end of inline methods //////////////////
295 ///////////////////////////////////////////////////////////
296 
297 
298 
299 
300 
301 END_objects_SCOPE // namespace ncbi::objects::
302 
304 
305 
306 #endif // OBJECTS_MIM_MIM_PAGE_BASE_HPP
CMim_page_Base –.
Definition: Mim_page_.hpp:73
Base class for all serializable objects.
Definition: serialbase.hpp:150
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
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_MIM_EXPORT
Definition: ncbi_export.h:608
bool CanGetFrom(void) const
Check if it is safe to call GetFrom method.
Definition: Mim_page_.hpp:206
const TTo & GetTo(void) const
Get the To member data.
Definition: Mim_page_.hpp:259
CSerialObject Tparent
Definition: Mim_page_.hpp:74
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Definition: Mim_page_.hpp:94
CMim_page_Base & operator=(const CMim_page_Base &)
bool IsSetFrom(void) const
Check if a value has been assigned to From data member.
Definition: Mim_page_.hpp:200
TFrom & SetFrom(void)
Assign a value to From data member.
Definition: Mim_page_.hpp:235
bool CanGetTo(void) const
Check if it is safe to call GetTo method.
Definition: Mim_page_.hpp:253
bool IsSetTo(void) const
Check if a value has been assigned to To data member.
Definition: Mim_page_.hpp:247
CMim_page_Base(const CMim_page_Base &)
const TFrom & GetFrom(void) const
Get the From member data.
Definition: Mim_page_.hpp:212
Uint4 m_set_State[1]
Definition: Mim_page_.hpp:185
TTo & SetTo(void)
Assign a value to To data member.
Definition: Mim_page_.hpp:282
DECLARE_INTERNAL_TYPE_INFO()
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Apr 17 13:10:14 2024 by modify_doxy.py rev. 669887