NCBI C++ ToolKit
GBenchVersionRequest_.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 GBenchVersionRequest_.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/gui/objects/gui_objects.asn">gui_objects.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.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 GUI_OBJECTS_GBENCHVERSIONREQUEST_BASE_HPP
42 #define GUI_OBJECTS_GBENCHVERSIONREQUEST_BASE_HPP
43 
44 // extra headers
45 #include <gui/gui_export.h>
46 
47 // standard includes
48 #include <serial/serialbase.hpp>
50 
51 #ifndef BEGIN_objects_SCOPE
52 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
53 # define END_objects_SCOPE END_SCOPE(objects)
54 #endif
55 BEGIN_objects_SCOPE // namespace ncbi::objects::
56 
57 
58 // forward declarations
59 class CGBenchVersionInfo;
60 
61 
62 // generated classes
63 
64 
65 /** @addtogroup dataspec_NCBI_GBenchService
66  *
67  * @{
68  */
69 
70 /////////////////////////////////////////////////////////////////////////////
71 ///
72 /// CGBenchVersionRequest_Base --
73 ///
74 
76 {
78 public:
79  // constructor
81  // destructor
82  virtual ~CGBenchVersionRequest_Base(void);
83 
84  // type info
86 
88  eVersion_request_download_url = 0,
89  eVersion_request_package = 1
90  };
91 
92  /// Access to EVersion_request's attributes (values, names) as defined in spec
93  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EVersion_request)(void);
94 
95  // types
98 
99  // member index
100  enum class E_memberIndex {
101  e__allMandatory = 0,
102  e_version,
103  e_version_request
104  };
106 
107  // getters
108  // setters
109 
110  /// Check if a value has been assigned to Version data member.
111  ///
112  /// Data member Version is mandatory;
113  /// its type is defined as 'typedef CGBenchVersionInfo TVersion'
114  /// @return
115  /// - true, if a value has been assigned.
116  /// - false, otherwise.
117  bool IsSetVersion(void) const;
118 
119  /// Check if it is safe to call GetVersion method.
120  ///
121  /// @return
122  /// - true, if the data member is getatable.
123  /// - false, otherwise.
124  bool CanGetVersion(void) const;
125 
126  /// Reset Version data member.
127  void ResetVersion(void);
128 
129  /// Get the Version member data.
130  ///
131  /// @return
132  /// Reference to the member data.
133  const TVersion& GetVersion(void) const;
134 
135  /// Assign a value to Version data member.
136  ///
137  /// @param value
138  /// Reference to value.
139  void SetVersion(TVersion& value);
140 
141  /// Assign a value to Version data member.
142  ///
143  /// @return
144  /// Reference to the data value.
145  TVersion& SetVersion(void);
146 
147  /// Check if a value has been assigned to Version_request data member.
148  ///
149  /// Data member Version_request is optional with default eVersion_request_download_url;
150  /// its type is defined as 'typedef EVersion_request TVersion_request'
151  /// @return
152  /// - true, if a value has been assigned.
153  /// - false, otherwise.
154  bool IsSetVersion_request(void) const;
155 
156  /// Check if it is safe to call GetVersion_request method.
157  ///
158  /// @return
159  /// - true, if the data member is getatable.
160  /// - false, otherwise.
161  bool CanGetVersion_request(void) const;
162 
163  /// Reset Version_request data member.
164  void ResetVersion_request(void);
165 
166  /// Assign default value to Version_request data member.
167  void SetDefaultVersion_request(void);
168 
169  /// Get the Version_request member data.
170  ///
171  /// @return
172  /// Copy of the member data.
173  TVersion_request GetVersion_request(void) const;
174 
175  /// Assign a value to Version_request data member.
176  ///
177  /// @param value
178  /// Value to assign
179  void SetVersion_request(TVersion_request value);
180 
181  /// Assign a value to Version_request data member.
182  ///
183  /// @return
184  /// Reference to the data value.
185  TVersion_request& SetVersion_request(void);
186 
187  /// Reset the whole object
188  virtual void Reset(void);
189 
190 
191 private:
192  // Prohibit copy constructor and assignment operator
195 
196  // data
197  Uint4 m_set_State[1];
200 };
201 
202 /* @} */
203 
204 
205 
206 
207 
208 ///////////////////////////////////////////////////////////
209 ///////////////////// inline methods //////////////////////
210 ///////////////////////////////////////////////////////////
211 inline
213 {
214  return m_Version.NotEmpty();
215 }
216 
217 inline
219 {
220  return true;
221 }
222 
223 inline
225 {
226  if ( !m_Version ) {
227  const_cast<CGBenchVersionRequest_Base*>(this)->ResetVersion();
228  }
229  return (*m_Version);
230 }
231 
232 inline
234 {
235  if ( !m_Version ) {
236  ResetVersion();
237  }
238  return (*m_Version);
239 }
240 
241 inline
243 {
244  return ((m_set_State[0] & 0xc) != 0);
245 }
246 
247 inline
249 {
250  return true;
251 }
252 
253 inline
255 {
257  m_set_State[0] &= ~0xc;
258 }
259 
260 inline
262 {
264 }
265 
266 inline
268 {
269  return m_Version_request;
270 }
271 
272 inline
274 {
276  m_set_State[0] |= 0xc;
277 }
278 
279 inline
281 {
282 #ifdef _DEBUG
283  if (!IsSetVersion_request()) {
285  }
286 #endif
287  m_set_State[0] |= 0x4;
288  return m_Version_request;
289 }
290 
291 ///////////////////////////////////////////////////////////
292 ////////////////// end of inline methods //////////////////
293 ///////////////////////////////////////////////////////////
294 
295 
296 
297 
298 
299 END_objects_SCOPE // namespace ncbi::objects::
300 
302 
303 
304 #endif // GUI_OBJECTS_GBENCHVERSIONREQUEST_BASE_HPP
CGBenchVersionRequest_Base –.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
static char UnassignedByte(void)
Definition: serialbase.hpp:181
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
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_GUIOBJECTS_EXPORT
Definition: gui_export.h:511
bool CanGetVersion(void) const
Check if it is safe to call GetVersion method.
TVersion & SetVersion(void)
Assign a value to Version data member.
CGBenchVersionRequest_Base(const CGBenchVersionRequest_Base &)
void SetDefaultVersion_request(void)
Assign default value to Version_request data member.
void ResetVersion(void)
Reset Version data member.
bool CanGetVersion_request(void) const
Check if it is safe to call GetVersion_request method.
bool IsSetVersion(void) const
Check if a value has been assigned to Version data member.
CGBenchVersionRequest_Base & operator=(const CGBenchVersionRequest_Base &)
void ResetVersion_request(void)
Reset Version_request data member.
bool IsSetVersion_request(void) const
Check if a value has been assigned to Version_request data member.
TVersion_request & SetVersion_request(void)
Assign a value to Version_request data member.
TVersion_request GetVersion_request(void) const
Get the Version_request member data.
const TVersion & GetVersion(void) const
Get the Version member data.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Defines to provide correct exporting from DLLs in Windows.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Jun 19 17:04:54 2024 by modify_doxy.py rev. 669887