NCBI C++ ToolKit
TMgr_CreateTracksetRequest_.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_CreateTracksetRequest_.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_CREATETRACKSETREQUEST_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_CREATETRACKSETREQUEST_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_DTrackId;
66 class CTMgr_Identity;
67 
68 
69 // generated classes
70 
71 
72 /** @addtogroup dataspec_NCBI_TrackManager
73  *
74  * @{
75  */
76 
77 /////////////////////////////////////////////////////////////////////////////
78 ///
79 /// CTMgr_CreateTracksetRequest_Base --
80 ///
81 
83 {
85 public:
86  // constructor
88  // destructor
89  virtual ~CTMgr_CreateTracksetRequest_Base(void);
90 
91  // type info
93 
94  // types
97  typedef CStringUTF8 TName;
99  typedef list< CRef< CTMgr_DTrackId > > TTracks;
100 
101  // member index
102  enum class E_memberIndex {
103  e__allMandatory = 0,
104  e_identity,
105  e_genome_context,
106  e_name,
107  e_description,
108  e_tracks
109  };
111 
112  // getters
113  // setters
114 
115  /// Check if a value has been assigned to Identity data member.
116  ///
117  /// Data member Identity is optional;
118  /// its type is defined as 'typedef CTMgr_Identity TIdentity'
119  /// @return
120  /// - true, if a value has been assigned.
121  /// - false, otherwise.
122  bool IsSetIdentity(void) const;
123 
124  /// Check if it is safe to call GetIdentity method.
125  ///
126  /// @return
127  /// - true, if the data member is getatable.
128  /// - false, otherwise.
129  bool CanGetIdentity(void) const;
130 
131  /// Reset Identity data member.
132  void ResetIdentity(void);
133 
134  /// Get the Identity member data.
135  ///
136  /// @return
137  /// Reference to the member data.
138  const TIdentity& GetIdentity(void) const;
139 
140  /// Assign a value to Identity data member.
141  ///
142  /// @param value
143  /// Reference to value.
144  void SetIdentity(TIdentity& value);
145 
146  /// Assign a value to Identity data member.
147  ///
148  /// @return
149  /// Reference to the data value.
150  TIdentity& SetIdentity(void);
151 
152  /// Check if a value has been assigned to Genome_context data member.
153  ///
154  /// Data member Genome_context is mandatory;
155  /// its type is defined as 'typedef CTMgr_GenomeContext TGenome_context'
156  /// @return
157  /// - true, if a value has been assigned.
158  /// - false, otherwise.
159  bool IsSetGenome_context(void) const;
160 
161  /// Check if it is safe to call GetGenome_context method.
162  ///
163  /// @return
164  /// - true, if the data member is getatable.
165  /// - false, otherwise.
166  bool CanGetGenome_context(void) const;
167 
168  /// Reset Genome_context data member.
169  void ResetGenome_context(void);
170 
171  /// Get the Genome_context member data.
172  ///
173  /// @return
174  /// Reference to the member data.
175  const TGenome_context& GetGenome_context(void) const;
176 
177  /// Assign a value to Genome_context data member.
178  ///
179  /// @param value
180  /// Reference to value.
181  void SetGenome_context(TGenome_context& value);
182 
183  /// Assign a value to Genome_context data member.
184  ///
185  /// @return
186  /// Reference to the data value.
187  TGenome_context& SetGenome_context(void);
188 
189  /// Check if a value has been assigned to Name data member.
190  ///
191  /// Data member Name is mandatory;
192  /// its type is defined as 'typedef CStringUTF8 TName'
193  /// @return
194  /// - true, if a value has been assigned.
195  /// - false, otherwise.
196  bool IsSetName(void) const;
197 
198  /// Check if it is safe to call GetName method.
199  ///
200  /// @return
201  /// - true, if the data member is getatable.
202  /// - false, otherwise.
203  bool CanGetName(void) const;
204 
205  /// Reset Name data member.
206  void ResetName(void);
207 
208  /// Get the Name member data.
209  ///
210  /// @return
211  /// Reference to the member data.
212  const TName& GetName(void) const;
213 
214  /// Assign a value to Name data member.
215  ///
216  /// @param value
217  /// Value to assign
218  void SetName(const TName& value);
219  void SetName(TName&& value);
220 
221  /// Assign a value to Name data member.
222  ///
223  /// @return
224  /// Reference to the data value.
225  TName& SetName(void);
226 
227  /// Check if a value has been assigned to Description data member.
228  ///
229  /// Data member Description is optional;
230  /// its type is defined as 'typedef CStringUTF8 TDescription'
231  /// @return
232  /// - true, if a value has been assigned.
233  /// - false, otherwise.
234  bool IsSetDescription(void) const;
235 
236  /// Check if it is safe to call GetDescription method.
237  ///
238  /// @return
239  /// - true, if the data member is getatable.
240  /// - false, otherwise.
241  bool CanGetDescription(void) const;
242 
243  /// Reset Description data member.
244  void ResetDescription(void);
245 
246  /// Get the Description member data.
247  ///
248  /// @return
249  /// Reference to the member data.
250  const TDescription& GetDescription(void) const;
251 
252  /// Assign a value to Description data member.
253  ///
254  /// @param value
255  /// Value to assign
256  void SetDescription(const TDescription& value);
257  void SetDescription(TDescription&& value);
258 
259  /// Assign a value to Description data member.
260  ///
261  /// @return
262  /// Reference to the data value.
263  TDescription& SetDescription(void);
264 
265  /// Check if a value has been assigned to Tracks data member.
266  ///
267  /// Data member Tracks is mandatory;
268  /// its type is defined as 'typedef list< CRef< CTMgr_DTrackId > > TTracks'
269  /// @return
270  /// - true, if a value has been assigned.
271  /// - false, otherwise.
272  bool IsSetTracks(void) const;
273 
274  /// Check if it is safe to call GetTracks method.
275  ///
276  /// @return
277  /// - true, if the data member is getatable.
278  /// - false, otherwise.
279  bool CanGetTracks(void) const;
280 
281  /// Reset Tracks data member.
282  void ResetTracks(void);
283 
284  /// Get the Tracks member data.
285  ///
286  /// @return
287  /// Reference to the member data.
288  const TTracks& GetTracks(void) const;
289 
290  /// Assign a value to Tracks data member.
291  ///
292  /// @return
293  /// Reference to the data value.
294  TTracks& SetTracks(void);
295 
296  /// Reset the whole object
297  virtual void Reset(void);
298 
299 
300 private:
301  // Prohibit copy constructor and assignment operator
304 
305  // data
306  Uint4 m_set_State[1];
311  list< CRef< CTMgr_DTrackId > > m_Tracks;
312 };
313 
314 /* @} */
315 
316 
317 
318 
319 
320 ///////////////////////////////////////////////////////////
321 ///////////////////// inline methods //////////////////////
322 ///////////////////////////////////////////////////////////
323 inline
325 {
326  return m_Identity.NotEmpty();
327 }
328 
329 inline
331 {
332  return IsSetIdentity();
333 }
334 
335 inline
337 {
338  if (!CanGetIdentity()) {
339  ThrowUnassigned(0);
340  }
341  return (*m_Identity);
342 }
343 
344 inline
346 {
347  return m_Genome_context.NotEmpty();
348 }
349 
350 inline
352 {
353  return true;
354 }
355 
356 inline
358 {
359  if ( !m_Genome_context ) {
361  }
362  return (*m_Genome_context);
363 }
364 
365 inline
367 {
368  if ( !m_Genome_context ) {
370  }
371  return (*m_Genome_context);
372 }
373 
374 inline
376 {
377  return ((m_set_State[0] & 0x30) != 0);
378 }
379 
380 inline
382 {
383  return IsSetName();
384 }
385 
386 inline
388 {
389  if (!CanGetName()) {
390  ThrowUnassigned(2);
391  }
392  return m_Name;
393 }
394 
395 inline
397 {
398  m_Name = value;
399  m_set_State[0] |= 0x30;
400 }
401 
402 inline
404 {
405  m_Name = std::forward<CTMgr_CreateTracksetRequest_Base::TName>(value);
406  m_set_State[0] |= 0x30;
407 }
408 
409 inline
411 {
412 #ifdef _DEBUG
413  if (!IsSetName()) {
415  }
416 #endif
417  m_set_State[0] |= 0x10;
418  return m_Name;
419 }
420 
421 inline
423 {
424  return ((m_set_State[0] & 0xc0) != 0);
425 }
426 
427 inline
429 {
430  return IsSetDescription();
431 }
432 
433 inline
435 {
436  if (!CanGetDescription()) {
437  ThrowUnassigned(3);
438  }
439  return m_Description;
440 }
441 
442 inline
444 {
446  m_set_State[0] |= 0xc0;
447 }
448 
449 inline
451 {
452  m_Description = std::forward<CTMgr_CreateTracksetRequest_Base::TDescription>(value);
453  m_set_State[0] |= 0xc0;
454 }
455 
456 inline
458 {
459 #ifdef _DEBUG
460  if (!IsSetDescription()) {
462  }
463 #endif
464  m_set_State[0] |= 0x40;
465  return m_Description;
466 }
467 
468 inline
470 {
471  return ((m_set_State[0] & 0x300) != 0);
472 }
473 
474 inline
476 {
477  return true;
478 }
479 
480 inline
482 {
483  return m_Tracks;
484 }
485 
486 inline
488 {
489  m_set_State[0] |= 0x100;
490  return m_Tracks;
491 }
492 
493 ///////////////////////////////////////////////////////////
494 ////////////////// end of inline methods //////////////////
495 ///////////////////////////////////////////////////////////
496 
497 
498 
499 
500 
501 END_objects_SCOPE // namespace ncbi::objects::
502 
504 
505 
506 #endif // OBJECTS_TRACKMGR_TMGR_CREATETRACKSETREQUEST_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_CreateTracksetRequest_Base –.
CTMgr_GenomeContext –.
CTMgr_Identity –.
static CStringUTF8 UnassignedStringUTF8(void)
Definition: serialbase.hpp:178
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
std::string CStringUTF8
Definition: ncbistl.hpp:254
bool IsSetIdentity(void) const
Check if a value has been assigned to Identity data member.
bool CanGetName(void) const
Check if it is safe to call GetName method.
const TTracks & GetTracks(void) const
Get the Tracks member data.
bool CanGetDescription(void) const
Check if it is safe to call GetDescription method.
TDescription & SetDescription(void)
Assign a value to Description data member.
const TDescription & GetDescription(void) const
Get the Description member data.
bool CanGetGenome_context(void) const
Check if it is safe to call GetGenome_context method.
TTracks & SetTracks(void)
Assign a value to Tracks data member.
TGenome_context & SetGenome_context(void)
Assign a value to Genome_context data member.
bool IsSetGenome_context(void) const
Check if a value has been assigned to Genome_context data member.
bool IsSetTracks(void) const
Check if a value has been assigned to Tracks data member.
const TGenome_context & GetGenome_context(void) const
Get the Genome_context member data.
list< CRef< CTMgr_DTrackId > > TTracks
bool IsSetName(void) const
Check if a value has been assigned to Name data member.
Tparent::CMemberIndex< E_memberIndex, 6 > TmemberIndex
const TIdentity & GetIdentity(void) const
Get the Identity member data.
TName & SetName(void)
Assign a value to Name data member.
void ResetGenome_context(void)
Reset Genome_context data member.
const TName & GetName(void) const
Get the Name member data.
CTMgr_CreateTracksetRequest_Base & operator=(const CTMgr_CreateTracksetRequest_Base &)
bool IsSetDescription(void) const
Check if a value has been assigned to Description data member.
bool CanGetIdentity(void) const
Check if it is safe to call GetIdentity method.
CTMgr_CreateTracksetRequest_Base(const CTMgr_CreateTracksetRequest_Base &)
bool CanGetTracks(void) const
Check if it is safe to call GetTracks 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:46:02 2024 by modify_doxy.py rev. 669887