NCBI C++ ToolKit
GBenchInitRequest_.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 GBenchInitRequest_.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_GBENCHINITREQUEST_BASE_HPP
42 #define GUI_OBJECTS_GBENCHINITREQUEST_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 /// At initialization, we only ask for the version of Genome Workbench
73 /// being run. We must respect our client's privacy, and only request
74 /// the barest minimum of information. A version request includes only
75 /// very general information about our clients (the version and build date
76 /// of the software, as well as an enumerated category for their operating
77 /// system)
78 ///
79 /// All of this information would otherwise be available through a weblog;
80 /// thus, we don't request anything that isn't already public
81 ///
82 ///
83 /// CGBenchInitRequest_Base --
84 ///
85 
87 {
89 public:
90  // constructor
92  // destructor
93  virtual ~CGBenchInitRequest_Base(void);
94 
95  // type info
97 
98  // types
100 
101  // member index
102  enum class E_memberIndex {
103  e__allMandatory = 0,
104  e_version
105  };
107 
108  // getters
109  // setters
110 
111  /// Check if a value has been assigned to Version data member.
112  ///
113  /// Data member Version is mandatory;
114  /// its type is defined as 'typedef CGBenchVersionInfo TVersion'
115  /// @return
116  /// - true, if a value has been assigned.
117  /// - false, otherwise.
118  bool IsSetVersion(void) const;
119 
120  /// Check if it is safe to call GetVersion method.
121  ///
122  /// @return
123  /// - true, if the data member is getatable.
124  /// - false, otherwise.
125  bool CanGetVersion(void) const;
126 
127  /// Reset Version data member.
128  void ResetVersion(void);
129 
130  /// Get the Version member data.
131  ///
132  /// @return
133  /// Reference to the member data.
134  const TVersion& GetVersion(void) const;
135 
136  /// Assign a value to Version data member.
137  ///
138  /// @param value
139  /// Reference to value.
140  void SetVersion(TVersion& value);
141 
142  /// Assign a value to Version data member.
143  ///
144  /// @return
145  /// Reference to the data value.
146  TVersion& SetVersion(void);
147 
148  /// Reset the whole object
149  virtual void Reset(void);
150 
151 
152 private:
153  // Prohibit copy constructor and assignment operator
156 
157  // data
158  Uint4 m_set_State[1];
160 };
161 
162 /* @} */
163 
164 
165 
166 
167 
168 ///////////////////////////////////////////////////////////
169 ///////////////////// inline methods //////////////////////
170 ///////////////////////////////////////////////////////////
171 inline
173 {
174  return m_Version.NotEmpty();
175 }
176 
177 inline
179 {
180  return true;
181 }
182 
183 inline
185 {
186  if ( !m_Version ) {
187  const_cast<CGBenchInitRequest_Base*>(this)->ResetVersion();
188  }
189  return (*m_Version);
190 }
191 
192 inline
194 {
195  if ( !m_Version ) {
196  ResetVersion();
197  }
198  return (*m_Version);
199 }
200 
201 ///////////////////////////////////////////////////////////
202 ////////////////// end of inline methods //////////////////
203 ///////////////////////////////////////////////////////////
204 
205 
206 
207 
208 
209 END_objects_SCOPE // namespace ncbi::objects::
210 
212 
213 
214 #endif // GUI_OBJECTS_GBENCHINITREQUEST_BASE_HPP
At initialization, we only ask for the version of Genome Workbench being run.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
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.
CGBenchInitRequest_Base & operator=(const CGBenchInitRequest_Base &)
const TVersion & GetVersion(void) const
Get the Version member data.
Tparent::CMemberIndex< E_memberIndex, 2 > TmemberIndex
CGBenchInitRequest_Base(const CGBenchInitRequest_Base &)
CGBenchVersionInfo TVersion
void ResetVersion(void)
Reset Version data member.
TVersion & SetVersion(void)
Assign a value to Version data member.
bool IsSetVersion(void) const
Check if a value has been assigned to Version data member.
Defines to provide correct exporting from DLLs in Windows.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Jun 12 11:18:11 2024 by modify_doxy.py rev. 669887