NCBI C++ ToolKit
TMgr_TrackAttrValueReply_.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 TMgr_TrackAttrValueReply_.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/trackmgr/trackmgr.asn">trackmgr.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/trackmgr/trackmgr.def">trackmgr.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_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP
43 
44 // extra headers
46 
47 // standard includes
48 #include <serial/serialbase.hpp>
49 
50 // generated includes
51 #include <list>
52 #include <string>
53 
55 
56 #ifndef BEGIN_objects_SCOPE
57 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
58 # define END_objects_SCOPE END_SCOPE(objects)
59 #endif
60 BEGIN_objects_SCOPE // namespace ncbi::objects::
61 
62 
63 // forward declarations
64 class CTMgr_AttrReply;
66 
67 
68 // generated classes
69 
70 
71 /** @addtogroup dataspec_NCBI_TrackManager
72  *
73  * @{
74  */
75 
76 /////////////////////////////////////////////////////////////////////////////
77 ///
78 /// CTMgr_TrackAttrValueReply_Base --
79 ///
80 
82 {
84 public:
85  // constructor
87  // destructor
88  virtual ~CTMgr_TrackAttrValueReply_Base(void);
89 
90  // type info
92 
93  // types
94  typedef list< string > TTrack_type_list;
96  typedef list< CRef< CTMgr_AttrValueReply > > TValue_list;
97 
98  // member index
99  enum class E_memberIndex {
100  e__allMandatory = 0,
101  e_track_type_list,
102  e_attr_list,
103  e_value_list
104  };
106 
107  // getters
108  // setters
109 
110  /// list of track types
111  /// Check if a value has been assigned to Track_type_list data member.
112  ///
113  /// Data member Track_type_list is optional;
114  /// its type is defined as 'typedef list< string > TTrack_type_list'
115  /// @return
116  /// - true, if a value has been assigned.
117  /// - false, otherwise.
118  bool IsSetTrack_type_list(void) const;
119 
120  /// Check if it is safe to call GetTrack_type_list method.
121  ///
122  /// @return
123  /// - true, if the data member is getatable.
124  /// - false, otherwise.
125  bool CanGetTrack_type_list(void) const;
126 
127  /// Reset Track_type_list data member.
128  void ResetTrack_type_list(void);
129 
130  /// Get the Track_type_list member data.
131  ///
132  /// @return
133  /// Reference to the member data.
134  const TTrack_type_list& GetTrack_type_list(void) const;
135 
136  /// Assign a value to Track_type_list data member.
137  ///
138  /// @return
139  /// Reference to the data value.
140  TTrack_type_list& SetTrack_type_list(void);
141 
142  /// Check if a value has been assigned to Attr_list data member.
143  ///
144  /// Data member Attr_list is optional;
145  /// its type is defined as 'typedef CTMgr_AttrReply TAttr_list'
146  /// @return
147  /// - true, if a value has been assigned.
148  /// - false, otherwise.
149  bool IsSetAttr_list(void) const;
150 
151  /// Check if it is safe to call GetAttr_list method.
152  ///
153  /// @return
154  /// - true, if the data member is getatable.
155  /// - false, otherwise.
156  bool CanGetAttr_list(void) const;
157 
158  /// Reset Attr_list data member.
159  void ResetAttr_list(void);
160 
161  /// Get the Attr_list member data.
162  ///
163  /// @return
164  /// Reference to the member data.
165  const TAttr_list& GetAttr_list(void) const;
166 
167  /// Assign a value to Attr_list data member.
168  ///
169  /// @param value
170  /// Reference to value.
171  void SetAttr_list(TAttr_list& value);
172 
173  /// Assign a value to Attr_list data member.
174  ///
175  /// @return
176  /// Reference to the data value.
177  TAttr_list& SetAttr_list(void);
178 
179  /// Check if a value has been assigned to Value_list data member.
180  ///
181  /// Data member Value_list is optional;
182  /// its type is defined as 'typedef list< CRef< CTMgr_AttrValueReply > > TValue_list'
183  /// @return
184  /// - true, if a value has been assigned.
185  /// - false, otherwise.
186  bool IsSetValue_list(void) const;
187 
188  /// Check if it is safe to call GetValue_list method.
189  ///
190  /// @return
191  /// - true, if the data member is getatable.
192  /// - false, otherwise.
193  bool CanGetValue_list(void) const;
194 
195  /// Reset Value_list data member.
196  void ResetValue_list(void);
197 
198  /// Get the Value_list member data.
199  ///
200  /// @return
201  /// Reference to the member data.
202  const TValue_list& GetValue_list(void) const;
203 
204  /// Assign a value to Value_list data member.
205  ///
206  /// @return
207  /// Reference to the data value.
208  TValue_list& SetValue_list(void);
209 
210  /// Reset the whole object
211  virtual void Reset(void);
212 
213 
214 private:
215  // Prohibit copy constructor and assignment operator
218 
219  // data
220  Uint4 m_set_State[1];
221  list< string > m_Track_type_list;
223  list< CRef< CTMgr_AttrValueReply > > m_Value_list;
224 };
225 
226 /* @} */
227 
228 
229 
230 
231 
232 ///////////////////////////////////////////////////////////
233 ///////////////////// inline methods //////////////////////
234 ///////////////////////////////////////////////////////////
235 inline
237 {
238  return ((m_set_State[0] & 0x3) != 0);
239 }
240 
241 inline
243 {
244  return true;
245 }
246 
247 inline
249 {
250  return m_Track_type_list;
251 }
252 
253 inline
255 {
256  m_set_State[0] |= 0x1;
257  return m_Track_type_list;
258 }
259 
260 inline
262 {
263  return m_Attr_list.NotEmpty();
264 }
265 
266 inline
268 {
269  return IsSetAttr_list();
270 }
271 
272 inline
274 {
275  if (!CanGetAttr_list()) {
276  ThrowUnassigned(1);
277  }
278  return (*m_Attr_list);
279 }
280 
281 inline
283 {
284  return ((m_set_State[0] & 0x30) != 0);
285 }
286 
287 inline
289 {
290  return true;
291 }
292 
293 inline
295 {
296  return m_Value_list;
297 }
298 
299 inline
301 {
302  m_set_State[0] |= 0x10;
303  return m_Value_list;
304 }
305 
306 ///////////////////////////////////////////////////////////
307 ////////////////// end of inline methods //////////////////
308 ///////////////////////////////////////////////////////////
309 
310 
311 
312 
313 
314 END_objects_SCOPE // namespace ncbi::objects::
315 
317 
318 
319 #endif // OBJECTS_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_AttrReply –.
CTMgr_AttrValueReply –.
CTMgr_TrackAttrValueReply_Base –.
void ThrowUnassigned(TMemberIndex index) const
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
CTMgr_TrackAttrValueReply_Base & operator=(const CTMgr_TrackAttrValueReply_Base &)
Tparent::CMemberIndex< E_memberIndex, 4 > TmemberIndex
TValue_list & SetValue_list(void)
Assign a value to Value_list data member.
list< CRef< CTMgr_AttrValueReply > > m_Value_list
const TValue_list & GetValue_list(void) const
Get the Value_list member data.
bool IsSetAttr_list(void) const
Check if a value has been assigned to Attr_list data member.
bool CanGetTrack_type_list(void) const
Check if it is safe to call GetTrack_type_list method.
const TTrack_type_list & GetTrack_type_list(void) const
Get the Track_type_list member data.
bool CanGetAttr_list(void) const
Check if it is safe to call GetAttr_list method.
CTMgr_TrackAttrValueReply_Base(const CTMgr_TrackAttrValueReply_Base &)
TTrack_type_list & SetTrack_type_list(void)
Assign a value to Track_type_list data member.
bool IsSetTrack_type_list(void) const
list of track types Check if a value has been assigned to Track_type_list data member.
list< CRef< CTMgr_AttrValueReply > > TValue_list
const TAttr_list & GetAttr_list(void) const
Get the Attr_list member data.
bool IsSetValue_list(void) const
Check if a value has been assigned to Value_list data member.
bool CanGetValue_list(void) const
Check if it is safe to call GetValue_list method.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Defines to provide correct exporting from DLLs in Windows.
#define NCBI_TRACKMGR_EXPORT
Modified on Sun May 19 04:40:20 2024 by modify_doxy.py rev. 669887