NCBI C++ ToolKit
ID2_Request_Get_Packages_.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 ID2_Request_Get_Packages_.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/id2/id2.asn">id2.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/id2/id2.def">id2.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_ID2_ID2_REQUEST_GET_PACKAGES_BASE_HPP
42 #define OBJECTS_ID2_ID2_REQUEST_GET_PACKAGES_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 #include <string>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 
60 // generated classes
61 
62 
63 /** @addtogroup dataspec_NCBI_ID2Access
64  *
65  * @{
66  */
67 
68 /////////////////////////////////////////////////////////////////////////////
69 /// Request for set of params packages know by server.
70 /// Packages can be used to abbreviate parameters of request.
71 ///
72 /// CID2_Request_Get_Packages_Base --
73 ///
74 
76 {
78 public:
79  // constructor
81  // destructor
82  virtual ~CID2_Request_Get_Packages_Base(void);
83 
84  // type info
86 
87  // types
88  typedef list< string > TNames;
89 
90  // member index
91  enum class E_memberIndex {
92  e__allMandatory = 0,
93  e_names,
94  e_no_contents
95  };
97 
98  // getters
99  // setters
100 
101  /// return known packages from this list
102  /// if unset - return all known packages
103  /// Check if a value has been assigned to Names data member.
104  ///
105  /// Data member Names is optional;
106  /// its type is defined as 'typedef list< string > TNames'
107  /// @return
108  /// - true, if a value has been assigned.
109  /// - false, otherwise.
110  bool IsSetNames(void) const;
111 
112  /// Check if it is safe to call GetNames method.
113  ///
114  /// @return
115  /// - true, if the data member is getatable.
116  /// - false, otherwise.
117  bool CanGetNames(void) const;
118 
119  /// Reset Names data member.
120  void ResetNames(void);
121 
122  /// Get the Names member data.
123  ///
124  /// @return
125  /// Reference to the member data.
126  const TNames& GetNames(void) const;
127 
128  /// Assign a value to Names data member.
129  ///
130  /// @return
131  /// Reference to the data value.
132  TNames& SetNames(void);
133 
134  /// return packages' names only
135  /// Check if a value has been assigned to No_contents data member.
136  ///
137  /// Data member No_contents is optional
138  /// @return
139  /// - true, if a value has been assigned.
140  /// - false, otherwise.
141  bool IsSetNo_contents(void) const;
142 
143  /// Check if value of No_contents member is getatable.
144  ///
145  /// @return
146  /// - false; the data member of type 'NULL' has no value.
147  bool CanGetNo_contents(void) const;
148 
149  /// Reset No_contents data member.
150  void ResetNo_contents(void);
151 
152  /// Set NULL data member (assign 'NULL' value to No_contents data member).
153  void SetNo_contents(void);
154 
155  /// Reset the whole object
156  virtual void Reset(void);
157 
158 
159 private:
160  // Prohibit copy constructor and assignment operator
163 
164  // data
165  Uint4 m_set_State[1];
166  list< string > m_Names;
167 };
168 
169 /* @} */
170 
171 
172 
173 
174 
175 ///////////////////////////////////////////////////////////
176 ///////////////////// inline methods //////////////////////
177 ///////////////////////////////////////////////////////////
178 inline
180 {
181  return ((m_set_State[0] & 0x3) != 0);
182 }
183 
184 inline
186 {
187  return true;
188 }
189 
190 inline
192 {
193  return m_Names;
194 }
195 
196 inline
198 {
199  m_set_State[0] |= 0x1;
200  return m_Names;
201 }
202 
203 inline
205 {
206  return ((m_set_State[0] & 0xc) != 0);
207 }
208 
209 inline
211 {
212  return false;
213 }
214 
215 inline
217 {
218  m_set_State[0] &= ~0xc;
219 }
220 
221 inline
223 {
224  m_set_State[0] |= 0xc;
225 }
226 
227 ///////////////////////////////////////////////////////////
228 ////////////////// end of inline methods //////////////////
229 ///////////////////////////////////////////////////////////
230 
231 
232 
233 
234 
235 END_objects_SCOPE // namespace ncbi::objects::
236 
238 
239 
240 #endif // OBJECTS_ID2_ID2_REQUEST_GET_PACKAGES_BASE_HPP
Request for set of params packages know by server.
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_ID2_EXPORT
Definition: ncbi_export.h:552
bool IsSetNo_contents(void) const
return packages' names only Check if a value has been assigned to No_contents data member.
CID2_Request_Get_Packages_Base(const CID2_Request_Get_Packages_Base &)
void SetNo_contents(void)
Set NULL data member (assign 'NULL' value to No_contents data member).
CID2_Request_Get_Packages_Base & operator=(const CID2_Request_Get_Packages_Base &)
bool CanGetNo_contents(void) const
Check if value of No_contents member is getatable.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
void ResetNo_contents(void)
Reset No_contents data member.
bool IsSetNames(void) const
return known packages from this list if unset - return all known packages Check if a value has been a...
bool CanGetNames(void) const
Check if it is safe to call GetNames method.
const TNames & GetNames(void) const
Get the Names member data.
TNames & SetNames(void)
Assign a value to Names data member.
Modified on Sat Jun 22 10:41:10 2024 by modify_doxy.py rev. 669887