NCBI C++ ToolKit
Blast_get_searc_info_reply_.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 Blast_get_searc_info_reply_.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/blast/blast.asn">blast.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blast/blast.def">blast.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_BLAST_BLAST_GET_SEARC_INFO_REPLY_BASE_HPP
42 #define OBJECTS_BLAST_BLAST_GET_SEARC_INFO_REPLY_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 // forward declarations
60 class CBlast4_parameters;
61 
62 
63 // generated classes
64 
65 
66 /** @addtogroup dataspec_NCBI_Blast4
67  *
68  * @{
69  */
70 
71 /////////////////////////////////////////////////////////////////////////////
72 ///
73 /// CBlast4_get_search_info_reply_Base --
74 ///
75 
77 {
79 public:
80  // constructor
82  // destructor
84 
85  // type info
87 
88  // types
89  typedef string TRequest_id;
91 
92  // member index
93  enum class E_memberIndex {
94  e__allMandatory = 0,
95  e_request_id,
96  e_info
97  };
99 
100  // getters
101  // setters
102 
103  /// Check if a value has been assigned to Request_id data member.
104  ///
105  /// Data member Request_id is mandatory;
106  /// its type is defined as 'typedef string TRequest_id'
107  /// @return
108  /// - true, if a value has been assigned.
109  /// - false, otherwise.
110  bool IsSetRequest_id(void) const;
111 
112  /// Check if it is safe to call GetRequest_id method.
113  ///
114  /// @return
115  /// - true, if the data member is getatable.
116  /// - false, otherwise.
117  bool CanGetRequest_id(void) const;
118 
119  /// Reset Request_id data member.
120  void ResetRequest_id(void);
121 
122  /// Get the Request_id member data.
123  ///
124  /// @return
125  /// Reference to the member data.
126  const TRequest_id& GetRequest_id(void) const;
127 
128  /// Assign a value to Request_id data member.
129  ///
130  /// @param value
131  /// Value to assign
132  void SetRequest_id(const TRequest_id& value);
133  void SetRequest_id(TRequest_id&& value);
134 
135  /// Assign a value to Request_id data member.
136  ///
137  /// @return
138  /// Reference to the data value.
139  TRequest_id& SetRequest_id(void);
140 
141  /// Check if a value has been assigned to Info data member.
142  ///
143  /// Data member Info is optional;
144  /// its type is defined as 'typedef CBlast4_parameters TInfo'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetInfo(void) const;
149 
150  /// Check if it is safe to call GetInfo method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetInfo(void) const;
156 
157  /// Reset Info data member.
158  void ResetInfo(void);
159 
160  /// Get the Info member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TInfo& GetInfo(void) const;
165 
166  /// Assign a value to Info data member.
167  ///
168  /// @param value
169  /// Reference to value.
170  void SetInfo(TInfo& value);
171 
172  /// Assign a value to Info data member.
173  ///
174  /// @return
175  /// Reference to the data value.
176  TInfo& SetInfo(void);
177 
178  /// Reset the whole object
179  virtual void Reset(void);
180 
181 
182 private:
183  // Prohibit copy constructor and assignment operator
186 
187  // data
188  Uint4 m_set_State[1];
189  string m_Request_id;
191 };
192 
193 /* @} */
194 
195 
196 
197 
198 
199 ///////////////////////////////////////////////////////////
200 ///////////////////// inline methods //////////////////////
201 ///////////////////////////////////////////////////////////
202 inline
204 {
205  return ((m_set_State[0] & 0x3) != 0);
206 }
207 
208 inline
210 {
211  return IsSetRequest_id();
212 }
213 
214 inline
216 {
217  if (!CanGetRequest_id()) {
218  ThrowUnassigned(0);
219  }
220  return m_Request_id;
221 }
222 
223 inline
225 {
227  m_set_State[0] |= 0x3;
228 }
229 
230 inline
232 {
233  m_Request_id = std::forward<CBlast4_get_search_info_reply_Base::TRequest_id>(value);
234  m_set_State[0] |= 0x3;
235 }
236 
237 inline
239 {
240 #ifdef _DEBUG
241  if (!IsSetRequest_id()) {
243  }
244 #endif
245  m_set_State[0] |= 0x1;
246  return m_Request_id;
247 }
248 
249 inline
251 {
252  return m_Info.NotEmpty();
253 }
254 
255 inline
257 {
258  return IsSetInfo();
259 }
260 
261 inline
263 {
264  if (!CanGetInfo()) {
265  ThrowUnassigned(1);
266  }
267  return (*m_Info);
268 }
269 
270 ///////////////////////////////////////////////////////////
271 ////////////////// end of inline methods //////////////////
272 ///////////////////////////////////////////////////////////
273 
274 
275 
276 
277 
278 END_objects_SCOPE // namespace ncbi::objects::
279 
281 
282 
283 #endif // OBJECTS_BLAST_BLAST_GET_SEARC_INFO_REPLY_BASE_HPP
CBlast4_get_search_info_reply_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
char value[7]
Definition: config.c:431
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
bool NotEmpty(void) const THROWS_NONE
Check if CRef is not empty – pointing to an object and has a non-null value.
Definition: ncbiobj.hpp:726
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_BLAST_EXPORT
Definition: ncbi_export.h:360
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
const TInfo & GetInfo(void) const
Get the Info member data.
bool CanGetRequest_id(void) const
Check if it is safe to call GetRequest_id method.
bool IsSetRequest_id(void) const
Check if a value has been assigned to Request_id data member.
bool CanGetInfo(void) const
Check if it is safe to call GetInfo method.
CBlast4_get_search_info_reply_Base(const CBlast4_get_search_info_reply_Base &)
TRequest_id & SetRequest_id(void)
Assign a value to Request_id data member.
const TRequest_id & GetRequest_id(void) const
Get the Request_id member data.
CBlast4_get_search_info_reply_Base & operator=(const CBlast4_get_search_info_reply_Base &)
bool IsSetInfo(void) const
Check if a value has been assigned to Info data member.
Modified on Tue Feb 27 05:54:35 2024 by modify_doxy.py rev. 669887