NCBI C++ ToolKit
TMgr_DisplayTrackRequest_.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_DisplayTrackRequest_.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_DISPLAYTRACKREQUEST_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_DISPLAYTRACKREQUEST_BASE_HPP
43 
44 // extra headers
46 
47 // standard includes
48 #include <serial/serialbase.hpp>
49 
50 // generated includes
51 #include <list>
52 
54 
55 #ifndef BEGIN_objects_SCOPE
56 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
57 # define END_objects_SCOPE END_SCOPE(objects)
58 #endif
59 BEGIN_objects_SCOPE // namespace ncbi::objects::
60 
61 
62 // forward declarations
63 class CTMgr_AttrSpec;
64 class CTMgr_ClientInfo;
66 class CTMgr_Identity;
68 
69 
70 // generated classes
71 
72 
73 /** @addtogroup dataspec_NCBI_TrackManager
74  *
75  * @{
76  */
77 
78 /////////////////////////////////////////////////////////////////////////////
79 ///
80 /// CTMgr_DisplayTrackRequest_Base --
81 ///
82 
84 {
86 public:
87  // constructor
89  // destructor
90  virtual ~CTMgr_DisplayTrackRequest_Base(void);
91 
92  // type info
94 
95  /////////////////////////////////////////////////////////////////////////////
96  ///
97  /// C_Flags --
98  ///
99 
101  {
103  public:
104  // constructor
105  C_Flags(void);
106  // destructor
107  ~C_Flags(void);
108 
109  // type info
111 
112  // types
113  typedef bool TInclude_stats;
115  typedef bool TInclude_track_items;
116  typedef bool TExpanded_rid_details;
117  typedef bool TInclude_track_hubs;
118  typedef bool TInclude_TMS_tracks;
119  typedef bool TInclude_user_tracks;
122 
123  // member index
124  enum class E_memberIndex {
125  e__allMandatory = 0,
126  e_include_stats,
127  e_include_default_tracks,
128  e_include_track_items,
129  e_expanded_rid_details,
130  e_include_track_hubs,
131  e_include_TMS_tracks,
132  e_include_user_tracks,
133  e_include_remote_tracks,
134  e_use_multiple_containers
135  };
137 
138  // getters
139  // setters
140 
141  /// Check if a value has been assigned to Include_stats data member.
142  ///
143  /// Data member Include_stats is optional with default false;
144  /// its type is defined as 'typedef bool TInclude_stats'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetInclude_stats(void) const;
149 
150  /// Check if it is safe to call GetInclude_stats method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetInclude_stats(void) const;
156 
157  /// Reset Include_stats data member.
158  void ResetInclude_stats(void);
159 
160  /// Assign default value to Include_stats data member.
161  void SetDefaultInclude_stats(void);
162 
163  /// Get the Include_stats member data.
164  ///
165  /// @return
166  /// Copy of the member data.
167  TInclude_stats GetInclude_stats(void) const;
168 
169  /// Assign a value to Include_stats data member.
170  ///
171  /// @param value
172  /// Value to assign
173  void SetInclude_stats(TInclude_stats value);
174 
175  /// Assign a value to Include_stats data member.
176  ///
177  /// @return
178  /// Reference to the data value.
179  TInclude_stats& SetInclude_stats(void);
180 
181  /// Check if a value has been assigned to Include_default_tracks data member.
182  ///
183  /// Data member Include_default_tracks is optional with default false;
184  /// its type is defined as 'typedef bool TInclude_default_tracks'
185  /// @return
186  /// - true, if a value has been assigned.
187  /// - false, otherwise.
188  bool IsSetInclude_default_tracks(void) const;
189 
190  /// Check if it is safe to call GetInclude_default_tracks method.
191  ///
192  /// @return
193  /// - true, if the data member is getatable.
194  /// - false, otherwise.
195  bool CanGetInclude_default_tracks(void) const;
196 
197  /// Reset Include_default_tracks data member.
198  void ResetInclude_default_tracks(void);
199 
200  /// Assign default value to Include_default_tracks data member.
201  void SetDefaultInclude_default_tracks(void);
202 
203  /// Get the Include_default_tracks member data.
204  ///
205  /// @return
206  /// Copy of the member data.
207  TInclude_default_tracks GetInclude_default_tracks(void) const;
208 
209  /// Assign a value to Include_default_tracks data member.
210  ///
211  /// @param value
212  /// Value to assign
213  void SetInclude_default_tracks(TInclude_default_tracks value);
214 
215  /// Assign a value to Include_default_tracks data member.
216  ///
217  /// @return
218  /// Reference to the data value.
219  TInclude_default_tracks& SetInclude_default_tracks(void);
220 
221  /// Check if a value has been assigned to Include_track_items data member.
222  ///
223  /// Data member Include_track_items is optional with default false;
224  /// its type is defined as 'typedef bool TInclude_track_items'
225  /// @return
226  /// - true, if a value has been assigned.
227  /// - false, otherwise.
228  bool IsSetInclude_track_items(void) const;
229 
230  /// Check if it is safe to call GetInclude_track_items method.
231  ///
232  /// @return
233  /// - true, if the data member is getatable.
234  /// - false, otherwise.
235  bool CanGetInclude_track_items(void) const;
236 
237  /// Reset Include_track_items data member.
238  void ResetInclude_track_items(void);
239 
240  /// Assign default value to Include_track_items data member.
241  void SetDefaultInclude_track_items(void);
242 
243  /// Get the Include_track_items member data.
244  ///
245  /// @return
246  /// Copy of the member data.
247  TInclude_track_items GetInclude_track_items(void) const;
248 
249  /// Assign a value to Include_track_items data member.
250  ///
251  /// @param value
252  /// Value to assign
253  void SetInclude_track_items(TInclude_track_items value);
254 
255  /// Assign a value to Include_track_items data member.
256  ///
257  /// @return
258  /// Reference to the data value.
259  TInclude_track_items& SetInclude_track_items(void);
260 
261  /// Check if a value has been assigned to Expanded_rid_details data member.
262  ///
263  /// Data member Expanded_rid_details is optional with default false;
264  /// its type is defined as 'typedef bool TExpanded_rid_details'
265  /// @return
266  /// - true, if a value has been assigned.
267  /// - false, otherwise.
268  bool IsSetExpanded_rid_details(void) const;
269 
270  /// Check if it is safe to call GetExpanded_rid_details method.
271  ///
272  /// @return
273  /// - true, if the data member is getatable.
274  /// - false, otherwise.
275  bool CanGetExpanded_rid_details(void) const;
276 
277  /// Reset Expanded_rid_details data member.
278  void ResetExpanded_rid_details(void);
279 
280  /// Assign default value to Expanded_rid_details data member.
281  void SetDefaultExpanded_rid_details(void);
282 
283  /// Get the Expanded_rid_details member data.
284  ///
285  /// @return
286  /// Copy of the member data.
287  TExpanded_rid_details GetExpanded_rid_details(void) const;
288 
289  /// Assign a value to Expanded_rid_details data member.
290  ///
291  /// @param value
292  /// Value to assign
293  void SetExpanded_rid_details(TExpanded_rid_details value);
294 
295  /// Assign a value to Expanded_rid_details data member.
296  ///
297  /// @return
298  /// Reference to the data value.
299  TExpanded_rid_details& SetExpanded_rid_details(void);
300 
301  /// Check if a value has been assigned to Include_track_hubs data member.
302  ///
303  /// Data member Include_track_hubs is optional with default false;
304  /// its type is defined as 'typedef bool TInclude_track_hubs'
305  /// @return
306  /// - true, if a value has been assigned.
307  /// - false, otherwise.
308  bool IsSetInclude_track_hubs(void) const;
309 
310  /// Check if it is safe to call GetInclude_track_hubs method.
311  ///
312  /// @return
313  /// - true, if the data member is getatable.
314  /// - false, otherwise.
315  bool CanGetInclude_track_hubs(void) const;
316 
317  /// Reset Include_track_hubs data member.
318  void ResetInclude_track_hubs(void);
319 
320  /// Assign default value to Include_track_hubs data member.
321  void SetDefaultInclude_track_hubs(void);
322 
323  /// Get the Include_track_hubs member data.
324  ///
325  /// @return
326  /// Copy of the member data.
327  TInclude_track_hubs GetInclude_track_hubs(void) const;
328 
329  /// Assign a value to Include_track_hubs data member.
330  ///
331  /// @param value
332  /// Value to assign
333  void SetInclude_track_hubs(TInclude_track_hubs value);
334 
335  /// Assign a value to Include_track_hubs data member.
336  ///
337  /// @return
338  /// Reference to the data value.
339  TInclude_track_hubs& SetInclude_track_hubs(void);
340 
341  /// Check if a value has been assigned to Include_TMS_tracks data member.
342  ///
343  /// Data member Include_TMS_tracks is optional with default true;
344  /// its type is defined as 'typedef bool TInclude_TMS_tracks'
345  /// @return
346  /// - true, if a value has been assigned.
347  /// - false, otherwise.
348  bool IsSetInclude_TMS_tracks(void) const;
349 
350  /// Check if it is safe to call GetInclude_TMS_tracks method.
351  ///
352  /// @return
353  /// - true, if the data member is getatable.
354  /// - false, otherwise.
355  bool CanGetInclude_TMS_tracks(void) const;
356 
357  /// Reset Include_TMS_tracks data member.
358  void ResetInclude_TMS_tracks(void);
359 
360  /// Assign default value to Include_TMS_tracks data member.
361  void SetDefaultInclude_TMS_tracks(void);
362 
363  /// Get the Include_TMS_tracks member data.
364  ///
365  /// @return
366  /// Copy of the member data.
367  TInclude_TMS_tracks GetInclude_TMS_tracks(void) const;
368 
369  /// Assign a value to Include_TMS_tracks data member.
370  ///
371  /// @param value
372  /// Value to assign
373  void SetInclude_TMS_tracks(TInclude_TMS_tracks value);
374 
375  /// Assign a value to Include_TMS_tracks data member.
376  ///
377  /// @return
378  /// Reference to the data value.
379  TInclude_TMS_tracks& SetInclude_TMS_tracks(void);
380 
381  /// Check if a value has been assigned to Include_user_tracks data member.
382  ///
383  /// Data member Include_user_tracks is optional with default true;
384  /// its type is defined as 'typedef bool TInclude_user_tracks'
385  /// @return
386  /// - true, if a value has been assigned.
387  /// - false, otherwise.
388  bool IsSetInclude_user_tracks(void) const;
389 
390  /// Check if it is safe to call GetInclude_user_tracks method.
391  ///
392  /// @return
393  /// - true, if the data member is getatable.
394  /// - false, otherwise.
395  bool CanGetInclude_user_tracks(void) const;
396 
397  /// Reset Include_user_tracks data member.
398  void ResetInclude_user_tracks(void);
399 
400  /// Assign default value to Include_user_tracks data member.
401  void SetDefaultInclude_user_tracks(void);
402 
403  /// Get the Include_user_tracks member data.
404  ///
405  /// @return
406  /// Copy of the member data.
407  TInclude_user_tracks GetInclude_user_tracks(void) const;
408 
409  /// Assign a value to Include_user_tracks data member.
410  ///
411  /// @param value
412  /// Value to assign
413  void SetInclude_user_tracks(TInclude_user_tracks value);
414 
415  /// Assign a value to Include_user_tracks data member.
416  ///
417  /// @return
418  /// Reference to the data value.
419  TInclude_user_tracks& SetInclude_user_tracks(void);
420 
421  /// Check if a value has been assigned to Include_remote_tracks data member.
422  ///
423  /// Data member Include_remote_tracks is optional with default true;
424  /// its type is defined as 'typedef bool TInclude_remote_tracks'
425  /// @return
426  /// - true, if a value has been assigned.
427  /// - false, otherwise.
428  bool IsSetInclude_remote_tracks(void) const;
429 
430  /// Check if it is safe to call GetInclude_remote_tracks method.
431  ///
432  /// @return
433  /// - true, if the data member is getatable.
434  /// - false, otherwise.
435  bool CanGetInclude_remote_tracks(void) const;
436 
437  /// Reset Include_remote_tracks data member.
438  void ResetInclude_remote_tracks(void);
439 
440  /// Assign default value to Include_remote_tracks data member.
441  void SetDefaultInclude_remote_tracks(void);
442 
443  /// Get the Include_remote_tracks member data.
444  ///
445  /// @return
446  /// Copy of the member data.
447  TInclude_remote_tracks GetInclude_remote_tracks(void) const;
448 
449  /// Assign a value to Include_remote_tracks data member.
450  ///
451  /// @param value
452  /// Value to assign
453  void SetInclude_remote_tracks(TInclude_remote_tracks value);
454 
455  /// Assign a value to Include_remote_tracks data member.
456  ///
457  /// @return
458  /// Reference to the data value.
459  TInclude_remote_tracks& SetInclude_remote_tracks(void);
460 
461  /// Check if a value has been assigned to Use_multiple_containers data member.
462  ///
463  /// Data member Use_multiple_containers is optional with default false;
464  /// its type is defined as 'typedef bool TUse_multiple_containers'
465  /// @return
466  /// - true, if a value has been assigned.
467  /// - false, otherwise.
468  bool IsSetUse_multiple_containers(void) const;
469 
470  /// Check if it is safe to call GetUse_multiple_containers method.
471  ///
472  /// @return
473  /// - true, if the data member is getatable.
474  /// - false, otherwise.
475  bool CanGetUse_multiple_containers(void) const;
476 
477  /// Reset Use_multiple_containers data member.
478  void ResetUse_multiple_containers(void);
479 
480  /// Assign default value to Use_multiple_containers data member.
481  void SetDefaultUse_multiple_containers(void);
482 
483  /// Get the Use_multiple_containers member data.
484  ///
485  /// @return
486  /// Copy of the member data.
487  TUse_multiple_containers GetUse_multiple_containers(void) const;
488 
489  /// Assign a value to Use_multiple_containers data member.
490  ///
491  /// @param value
492  /// Value to assign
493  void SetUse_multiple_containers(TUse_multiple_containers value);
494 
495  /// Assign a value to Use_multiple_containers data member.
496  ///
497  /// @return
498  /// Reference to the data value.
499  TUse_multiple_containers& SetUse_multiple_containers(void);
500 
501  /// Reset the whole object
502  void Reset(void);
503 
504 
505  private:
506  // Prohibit copy constructor and assignment operator
507  C_Flags(const C_Flags&);
509 
510  // data
511  Uint4 m_set_State[1];
521  };
522  // types
525  typedef list< CRef< CTMgr_AttrSpec > > TAttrs;
528  typedef C_Flags TFlags;
529 
530  // member index
531  enum class E_memberIndex {
532  e__allMandatory = 0,
533  e_client,
534  e_genome_context,
535  e_attrs,
536  e_identity,
537  e_authorization,
538  e_flags
539  };
541 
542  // getters
543  // setters
544 
545  /// Check if a value has been assigned to Client data member.
546  ///
547  /// Data member Client is mandatory;
548  /// its type is defined as 'typedef CTMgr_ClientInfo TClient'
549  /// @return
550  /// - true, if a value has been assigned.
551  /// - false, otherwise.
552  bool IsSetClient(void) const;
553 
554  /// Check if it is safe to call GetClient method.
555  ///
556  /// @return
557  /// - true, if the data member is getatable.
558  /// - false, otherwise.
559  bool CanGetClient(void) const;
560 
561  /// Reset Client data member.
562  void ResetClient(void);
563 
564  /// Get the Client member data.
565  ///
566  /// @return
567  /// Reference to the member data.
568  const TClient& GetClient(void) const;
569 
570  /// Assign a value to Client data member.
571  ///
572  /// @param value
573  /// Reference to value.
574  void SetClient(TClient& value);
575 
576  /// Assign a value to Client data member.
577  ///
578  /// @return
579  /// Reference to the data value.
580  TClient& SetClient(void);
581 
582  /// Check if a value has been assigned to Genome_context data member.
583  ///
584  /// Data member Genome_context is mandatory;
585  /// its type is defined as 'typedef CTMgr_GenomeContext TGenome_context'
586  /// @return
587  /// - true, if a value has been assigned.
588  /// - false, otherwise.
589  bool IsSetGenome_context(void) const;
590 
591  /// Check if it is safe to call GetGenome_context method.
592  ///
593  /// @return
594  /// - true, if the data member is getatable.
595  /// - false, otherwise.
596  bool CanGetGenome_context(void) const;
597 
598  /// Reset Genome_context data member.
599  void ResetGenome_context(void);
600 
601  /// Get the Genome_context member data.
602  ///
603  /// @return
604  /// Reference to the member data.
605  const TGenome_context& GetGenome_context(void) const;
606 
607  /// Assign a value to Genome_context data member.
608  ///
609  /// @param value
610  /// Reference to value.
611  void SetGenome_context(TGenome_context& value);
612 
613  /// Assign a value to Genome_context data member.
614  ///
615  /// @return
616  /// Reference to the data value.
617  TGenome_context& SetGenome_context(void);
618 
619  /// Check if a value has been assigned to Attrs data member.
620  ///
621  /// Data member Attrs is optional;
622  /// its type is defined as 'typedef list< CRef< CTMgr_AttrSpec > > TAttrs'
623  /// @return
624  /// - true, if a value has been assigned.
625  /// - false, otherwise.
626  bool IsSetAttrs(void) const;
627 
628  /// Check if it is safe to call GetAttrs method.
629  ///
630  /// @return
631  /// - true, if the data member is getatable.
632  /// - false, otherwise.
633  bool CanGetAttrs(void) const;
634 
635  /// Reset Attrs data member.
636  void ResetAttrs(void);
637 
638  /// Get the Attrs member data.
639  ///
640  /// @return
641  /// Reference to the member data.
642  const TAttrs& GetAttrs(void) const;
643 
644  /// Assign a value to Attrs data member.
645  ///
646  /// @return
647  /// Reference to the data value.
648  TAttrs& SetAttrs(void);
649 
650  /// Check if a value has been assigned to Identity data member.
651  ///
652  /// Data member Identity is optional;
653  /// its type is defined as 'typedef CTMgr_Identity TIdentity'
654  /// @return
655  /// - true, if a value has been assigned.
656  /// - false, otherwise.
657  bool IsSetIdentity(void) const;
658 
659  /// Check if it is safe to call GetIdentity method.
660  ///
661  /// @return
662  /// - true, if the data member is getatable.
663  /// - false, otherwise.
664  bool CanGetIdentity(void) const;
665 
666  /// Reset Identity data member.
667  void ResetIdentity(void);
668 
669  /// Get the Identity member data.
670  ///
671  /// @return
672  /// Reference to the member data.
673  const TIdentity& GetIdentity(void) const;
674 
675  /// Assign a value to Identity data member.
676  ///
677  /// @param value
678  /// Reference to value.
679  void SetIdentity(TIdentity& value);
680 
681  /// Assign a value to Identity data member.
682  ///
683  /// @return
684  /// Reference to the data value.
685  TIdentity& SetIdentity(void);
686 
687  /// Check if a value has been assigned to Authorization data member.
688  ///
689  /// Data member Authorization is optional;
690  /// its type is defined as 'typedef CTMgr_TrackACL_Authorization TAuthorization'
691  /// @return
692  /// - true, if a value has been assigned.
693  /// - false, otherwise.
694  bool IsSetAuthorization(void) const;
695 
696  /// Check if it is safe to call GetAuthorization method.
697  ///
698  /// @return
699  /// - true, if the data member is getatable.
700  /// - false, otherwise.
701  bool CanGetAuthorization(void) const;
702 
703  /// Reset Authorization data member.
704  void ResetAuthorization(void);
705 
706  /// Get the Authorization member data.
707  ///
708  /// @return
709  /// Reference to the member data.
710  const TAuthorization& GetAuthorization(void) const;
711 
712  /// Assign a value to Authorization data member.
713  ///
714  /// @param value
715  /// Reference to value.
716  void SetAuthorization(TAuthorization& value);
717 
718  /// Assign a value to Authorization data member.
719  ///
720  /// @return
721  /// Reference to the data value.
722  TAuthorization& SetAuthorization(void);
723 
724  /// Check if a value has been assigned to Flags data member.
725  ///
726  /// Data member Flags is optional;
727  /// its type is defined as 'typedef C_Flags TFlags'
728  /// @return
729  /// - true, if a value has been assigned.
730  /// - false, otherwise.
731  bool IsSetFlags(void) const;
732 
733  /// Check if it is safe to call GetFlags method.
734  ///
735  /// @return
736  /// - true, if the data member is getatable.
737  /// - false, otherwise.
738  bool CanGetFlags(void) const;
739 
740  /// Reset Flags data member.
741  void ResetFlags(void);
742 
743  /// Get the Flags member data.
744  ///
745  /// @return
746  /// Reference to the member data.
747  const TFlags& GetFlags(void) const;
748 
749  /// Assign a value to Flags data member.
750  ///
751  /// @param value
752  /// Reference to value.
753  void SetFlags(TFlags& value);
754 
755  /// Assign a value to Flags data member.
756  ///
757  /// @return
758  /// Reference to the data value.
759  TFlags& SetFlags(void);
760 
761  /// Reset the whole object
762  virtual void Reset(void);
763 
764 
765 private:
766  // Prohibit copy constructor and assignment operator
769 
770  // data
771  Uint4 m_set_State[1];
774  list< CRef< CTMgr_AttrSpec > > m_Attrs;
778 };
779 
780 /* @} */
781 
782 
783 
784 
785 
786 ///////////////////////////////////////////////////////////
787 ///////////////////// inline methods //////////////////////
788 ///////////////////////////////////////////////////////////
789 inline
791 {
792  return ((m_set_State[0] & 0x3) != 0);
793 }
794 
795 inline
797 {
798  return true;
799 }
800 
801 inline
803 {
804  m_Include_stats = false;
805  m_set_State[0] &= ~0x3;
806 }
807 
808 inline
810 {
811  ResetInclude_stats();
812 }
813 
814 inline
816 {
817  return m_Include_stats;
818 }
819 
820 inline
822 {
823  m_Include_stats = value;
824  m_set_State[0] |= 0x3;
825 }
826 
827 inline
829 {
830 #ifdef _DEBUG
831  if (!IsSetInclude_stats()) {
832  memset(&m_Include_stats,UnassignedByte(),sizeof(m_Include_stats));
833  }
834 #endif
835  m_set_State[0] |= 0x1;
836  return m_Include_stats;
837 }
838 
839 inline
841 {
842  return ((m_set_State[0] & 0xc) != 0);
843 }
844 
845 inline
847 {
848  return true;
849 }
850 
851 inline
853 {
854  m_Include_default_tracks = false;
855  m_set_State[0] &= ~0xc;
856 }
857 
858 inline
860 {
861  ResetInclude_default_tracks();
862 }
863 
864 inline
866 {
867  return m_Include_default_tracks;
868 }
869 
870 inline
872 {
873  m_Include_default_tracks = value;
874  m_set_State[0] |= 0xc;
875 }
876 
877 inline
879 {
880 #ifdef _DEBUG
881  if (!IsSetInclude_default_tracks()) {
882  memset(&m_Include_default_tracks,UnassignedByte(),sizeof(m_Include_default_tracks));
883  }
884 #endif
885  m_set_State[0] |= 0x4;
886  return m_Include_default_tracks;
887 }
888 
889 inline
891 {
892  return ((m_set_State[0] & 0x30) != 0);
893 }
894 
895 inline
897 {
898  return true;
899 }
900 
901 inline
903 {
904  m_Include_track_items = false;
905  m_set_State[0] &= ~0x30;
906 }
907 
908 inline
910 {
911  ResetInclude_track_items();
912 }
913 
914 inline
916 {
917  return m_Include_track_items;
918 }
919 
920 inline
922 {
923  m_Include_track_items = value;
924  m_set_State[0] |= 0x30;
925 }
926 
927 inline
929 {
930 #ifdef _DEBUG
931  if (!IsSetInclude_track_items()) {
932  memset(&m_Include_track_items,UnassignedByte(),sizeof(m_Include_track_items));
933  }
934 #endif
935  m_set_State[0] |= 0x10;
936  return m_Include_track_items;
937 }
938 
939 inline
941 {
942  return ((m_set_State[0] & 0xc0) != 0);
943 }
944 
945 inline
947 {
948  return true;
949 }
950 
951 inline
953 {
954  m_Expanded_rid_details = false;
955  m_set_State[0] &= ~0xc0;
956 }
957 
958 inline
960 {
961  ResetExpanded_rid_details();
962 }
963 
964 inline
966 {
967  return m_Expanded_rid_details;
968 }
969 
970 inline
972 {
973  m_Expanded_rid_details = value;
974  m_set_State[0] |= 0xc0;
975 }
976 
977 inline
979 {
980 #ifdef _DEBUG
981  if (!IsSetExpanded_rid_details()) {
982  memset(&m_Expanded_rid_details,UnassignedByte(),sizeof(m_Expanded_rid_details));
983  }
984 #endif
985  m_set_State[0] |= 0x40;
986  return m_Expanded_rid_details;
987 }
988 
989 inline
991 {
992  return ((m_set_State[0] & 0x300) != 0);
993 }
994 
995 inline
997 {
998  return true;
999 }
1000 
1001 inline
1003 {
1004  m_Include_track_hubs = false;
1005  m_set_State[0] &= ~0x300;
1006 }
1007 
1008 inline
1010 {
1011  ResetInclude_track_hubs();
1012 }
1013 
1014 inline
1016 {
1017  return m_Include_track_hubs;
1018 }
1019 
1020 inline
1022 {
1023  m_Include_track_hubs = value;
1024  m_set_State[0] |= 0x300;
1025 }
1026 
1027 inline
1029 {
1030 #ifdef _DEBUG
1031  if (!IsSetInclude_track_hubs()) {
1032  memset(&m_Include_track_hubs,UnassignedByte(),sizeof(m_Include_track_hubs));
1033  }
1034 #endif
1035  m_set_State[0] |= 0x100;
1036  return m_Include_track_hubs;
1037 }
1038 
1039 inline
1041 {
1042  return ((m_set_State[0] & 0xc00) != 0);
1043 }
1044 
1045 inline
1047 {
1048  return true;
1049 }
1050 
1051 inline
1053 {
1054  m_Include_TMS_tracks = true;
1055  m_set_State[0] &= ~0xc00;
1056 }
1057 
1058 inline
1060 {
1061  ResetInclude_TMS_tracks();
1062 }
1063 
1064 inline
1066 {
1067  return m_Include_TMS_tracks;
1068 }
1069 
1070 inline
1072 {
1073  m_Include_TMS_tracks = value;
1074  m_set_State[0] |= 0xc00;
1075 }
1076 
1077 inline
1079 {
1080 #ifdef _DEBUG
1081  if (!IsSetInclude_TMS_tracks()) {
1082  memset(&m_Include_TMS_tracks,UnassignedByte(),sizeof(m_Include_TMS_tracks));
1083  }
1084 #endif
1085  m_set_State[0] |= 0x400;
1086  return m_Include_TMS_tracks;
1087 }
1088 
1089 inline
1091 {
1092  return ((m_set_State[0] & 0x3000) != 0);
1093 }
1094 
1095 inline
1097 {
1098  return true;
1099 }
1100 
1101 inline
1103 {
1104  m_Include_user_tracks = true;
1105  m_set_State[0] &= ~0x3000;
1106 }
1107 
1108 inline
1110 {
1111  ResetInclude_user_tracks();
1112 }
1113 
1114 inline
1116 {
1117  return m_Include_user_tracks;
1118 }
1119 
1120 inline
1122 {
1123  m_Include_user_tracks = value;
1124  m_set_State[0] |= 0x3000;
1125 }
1126 
1127 inline
1129 {
1130 #ifdef _DEBUG
1131  if (!IsSetInclude_user_tracks()) {
1132  memset(&m_Include_user_tracks,UnassignedByte(),sizeof(m_Include_user_tracks));
1133  }
1134 #endif
1135  m_set_State[0] |= 0x1000;
1136  return m_Include_user_tracks;
1137 }
1138 
1139 inline
1141 {
1142  return ((m_set_State[0] & 0xc000) != 0);
1143 }
1144 
1145 inline
1147 {
1148  return true;
1149 }
1150 
1151 inline
1153 {
1154  m_Include_remote_tracks = true;
1155  m_set_State[0] &= ~0xc000;
1156 }
1157 
1158 inline
1160 {
1161  ResetInclude_remote_tracks();
1162 }
1163 
1164 inline
1166 {
1167  return m_Include_remote_tracks;
1168 }
1169 
1170 inline
1172 {
1173  m_Include_remote_tracks = value;
1174  m_set_State[0] |= 0xc000;
1175 }
1176 
1177 inline
1179 {
1180 #ifdef _DEBUG
1181  if (!IsSetInclude_remote_tracks()) {
1182  memset(&m_Include_remote_tracks,UnassignedByte(),sizeof(m_Include_remote_tracks));
1183  }
1184 #endif
1185  m_set_State[0] |= 0x4000;
1186  return m_Include_remote_tracks;
1187 }
1188 
1189 inline
1191 {
1192  return ((m_set_State[0] & 0x30000) != 0);
1193 }
1194 
1195 inline
1197 {
1198  return true;
1199 }
1200 
1201 inline
1203 {
1204  m_Use_multiple_containers = false;
1205  m_set_State[0] &= ~0x30000;
1206 }
1207 
1208 inline
1210 {
1211  ResetUse_multiple_containers();
1212 }
1213 
1214 inline
1216 {
1217  return m_Use_multiple_containers;
1218 }
1219 
1220 inline
1222 {
1223  m_Use_multiple_containers = value;
1224  m_set_State[0] |= 0x30000;
1225 }
1226 
1227 inline
1229 {
1230 #ifdef _DEBUG
1231  if (!IsSetUse_multiple_containers()) {
1232  memset(&m_Use_multiple_containers,UnassignedByte(),sizeof(m_Use_multiple_containers));
1233  }
1234 #endif
1235  m_set_State[0] |= 0x10000;
1236  return m_Use_multiple_containers;
1237 }
1238 
1239 inline
1241 {
1242  return m_Client.NotEmpty();
1243 }
1244 
1245 inline
1247 {
1248  return true;
1249 }
1250 
1251 inline
1253 {
1254  if ( !m_Client ) {
1255  const_cast<CTMgr_DisplayTrackRequest_Base*>(this)->ResetClient();
1256  }
1257  return (*m_Client);
1258 }
1259 
1260 inline
1262 {
1263  if ( !m_Client ) {
1264  ResetClient();
1265  }
1266  return (*m_Client);
1267 }
1268 
1269 inline
1271 {
1272  return m_Genome_context.NotEmpty();
1273 }
1274 
1275 inline
1277 {
1278  return true;
1279 }
1280 
1281 inline
1283 {
1284  if ( !m_Genome_context ) {
1286  }
1287  return (*m_Genome_context);
1288 }
1289 
1290 inline
1292 {
1293  if ( !m_Genome_context ) {
1295  }
1296  return (*m_Genome_context);
1297 }
1298 
1299 inline
1301 {
1302  return ((m_set_State[0] & 0x30) != 0);
1303 }
1304 
1305 inline
1307 {
1308  return true;
1309 }
1310 
1311 inline
1313 {
1314  return m_Attrs;
1315 }
1316 
1317 inline
1319 {
1320  m_set_State[0] |= 0x10;
1321  return m_Attrs;
1322 }
1323 
1324 inline
1326 {
1327  return m_Identity.NotEmpty();
1328 }
1329 
1330 inline
1332 {
1333  return IsSetIdentity();
1334 }
1335 
1336 inline
1338 {
1339  if (!CanGetIdentity()) {
1340  ThrowUnassigned(3);
1341  }
1342  return (*m_Identity);
1343 }
1344 
1345 inline
1347 {
1348  return m_Authorization.NotEmpty();
1349 }
1350 
1351 inline
1353 {
1354  return IsSetAuthorization();
1355 }
1356 
1357 inline
1359 {
1360  if (!CanGetAuthorization()) {
1361  ThrowUnassigned(4);
1362  }
1363  return (*m_Authorization);
1364 }
1365 
1366 inline
1368 {
1369  return m_Flags.NotEmpty();
1370 }
1371 
1372 inline
1374 {
1375  return IsSetFlags();
1376 }
1377 
1378 inline
1380 {
1381  if (!CanGetFlags()) {
1382  ThrowUnassigned(5);
1383  }
1384  return (*m_Flags);
1385 }
1386 
1387 ///////////////////////////////////////////////////////////
1388 ////////////////// end of inline methods //////////////////
1389 ///////////////////////////////////////////////////////////
1390 
1391 
1392 
1393 
1394 
1395 END_objects_SCOPE // namespace ncbi::objects::
1396 
1398 
1399 
1400 #endif // OBJECTS_TRACKMGR_TMGR_DISPLAYTRACKREQUEST_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_AttrSpec –.
CTMgr_DisplayTrackRequest_Base –.
CTMgr_GenomeContext –.
CTMgr_Identity –.
CTMgr_TrackACL_Authorization –.
static char UnassignedByte(void)
Definition: serialbase.hpp:181
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_TrackACL_Authorization TAuthorization
bool CanGetExpanded_rid_details(void) const
Check if it is safe to call GetExpanded_rid_details method.
void ResetGenome_context(void)
Reset Genome_context data member.
CTMgr_DisplayTrackRequest_Base(const CTMgr_DisplayTrackRequest_Base &)
list< CRef< CTMgr_AttrSpec > > TAttrs
bool IsSetUse_multiple_containers(void) const
Check if a value has been assigned to Use_multiple_containers data member.
bool IsSetIdentity(void) const
Check if a value has been assigned to Identity data member.
void ResetInclude_stats(void)
Reset Include_stats data member.
bool CanGetInclude_track_items(void) const
Check if it is safe to call GetInclude_track_items method.
bool CanGetInclude_stats(void) const
Check if it is safe to call GetInclude_stats method.
C_Flags & operator=(const C_Flags &)
TInclude_track_hubs & SetInclude_track_hubs(void)
Assign a value to Include_track_hubs data member.
TUse_multiple_containers GetUse_multiple_containers(void) const
Get the Use_multiple_containers member data.
void ResetInclude_track_items(void)
Reset Include_track_items data member.
const TAttrs & GetAttrs(void) const
Get the Attrs member data.
TExpanded_rid_details GetExpanded_rid_details(void) const
Get the Expanded_rid_details member data.
bool CanGetInclude_user_tracks(void) const
Check if it is safe to call GetInclude_user_tracks method.
void ResetInclude_remote_tracks(void)
Reset Include_remote_tracks data member.
TInclude_TMS_tracks GetInclude_TMS_tracks(void) const
Get the Include_TMS_tracks member data.
TInclude_track_hubs GetInclude_track_hubs(void) const
Get the Include_track_hubs member data.
bool CanGetGenome_context(void) const
Check if it is safe to call GetGenome_context method.
bool CanGetIdentity(void) const
Check if it is safe to call GetIdentity method.
void ResetExpanded_rid_details(void)
Reset Expanded_rid_details data member.
void SetDefaultInclude_default_tracks(void)
Assign default value to Include_default_tracks data member.
TInclude_default_tracks GetInclude_default_tracks(void) const
Get the Include_default_tracks member data.
void ResetInclude_track_hubs(void)
Reset Include_track_hubs data member.
TAttrs & SetAttrs(void)
Assign a value to Attrs data member.
bool IsSetGenome_context(void) const
Check if a value has been assigned to Genome_context data member.
bool IsSetInclude_track_items(void) const
Check if a value has been assigned to Include_track_items data member.
bool CanGetUse_multiple_containers(void) const
Check if it is safe to call GetUse_multiple_containers method.
bool CanGetInclude_TMS_tracks(void) const
Check if it is safe to call GetInclude_TMS_tracks method.
TGenome_context & SetGenome_context(void)
Assign a value to Genome_context data member.
TInclude_stats GetInclude_stats(void) const
Get the Include_stats member data.
bool IsSetExpanded_rid_details(void) const
Check if a value has been assigned to Expanded_rid_details data member.
bool IsSetClient(void) const
Check if a value has been assigned to Client data member.
bool IsSetInclude_track_hubs(void) const
Check if a value has been assigned to Include_track_hubs data member.
const TClient & GetClient(void) const
Get the Client member data.
bool IsSetInclude_default_tracks(void) const
Check if a value has been assigned to Include_default_tracks data member.
bool CanGetFlags(void) const
Check if it is safe to call GetFlags method.
bool CanGetInclude_track_hubs(void) const
Check if it is safe to call GetInclude_track_hubs method.
void SetDefaultInclude_remote_tracks(void)
Assign default value to Include_remote_tracks data member.
void SetDefaultInclude_track_hubs(void)
Assign default value to Include_track_hubs data member.
CTMgr_DisplayTrackRequest_Base & operator=(const CTMgr_DisplayTrackRequest_Base &)
void ResetInclude_default_tracks(void)
Reset Include_default_tracks data member.
bool IsSetInclude_stats(void) const
Check if a value has been assigned to Include_stats data member.
const TAuthorization & GetAuthorization(void) const
Get the Authorization member data.
void ResetInclude_TMS_tracks(void)
Reset Include_TMS_tracks data member.
Tparent::CMemberIndex< E_memberIndex, 7 > TmemberIndex
void SetDefaultInclude_stats(void)
Assign default value to Include_stats data member.
TInclude_track_items & SetInclude_track_items(void)
Assign a value to Include_track_items data member.
void ResetInclude_user_tracks(void)
Reset Include_user_tracks data member.
TExpanded_rid_details & SetExpanded_rid_details(void)
Assign a value to Expanded_rid_details data member.
void SetDefaultInclude_TMS_tracks(void)
Assign default value to Include_TMS_tracks data member.
void SetDefaultExpanded_rid_details(void)
Assign default value to Expanded_rid_details data member.
void ResetClient(void)
Reset Client data member.
TInclude_track_items GetInclude_track_items(void) const
Get the Include_track_items member data.
TInclude_user_tracks GetInclude_user_tracks(void) const
Get the Include_user_tracks member data.
bool IsSetInclude_user_tracks(void) const
Check if a value has been assigned to Include_user_tracks data member.
TInclude_TMS_tracks & SetInclude_TMS_tracks(void)
Assign a value to Include_TMS_tracks data member.
void SetDefaultUse_multiple_containers(void)
Assign default value to Use_multiple_containers data member.
Tparent::CMemberIndex< E_memberIndex, 10 > TmemberIndex
bool CanGetAttrs(void) const
Check if it is safe to call GetAttrs method.
void SetDefaultInclude_user_tracks(void)
Assign default value to Include_user_tracks data member.
bool IsSetAuthorization(void) const
Check if a value has been assigned to Authorization data member.
const TGenome_context & GetGenome_context(void) const
Get the Genome_context member data.
bool IsSetAttrs(void) const
Check if a value has been assigned to Attrs data member.
bool CanGetInclude_remote_tracks(void) const
Check if it is safe to call GetInclude_remote_tracks method.
TClient & SetClient(void)
Assign a value to Client data member.
TInclude_default_tracks & SetInclude_default_tracks(void)
Assign a value to Include_default_tracks data member.
void ResetUse_multiple_containers(void)
Reset Use_multiple_containers data member.
TInclude_user_tracks & SetInclude_user_tracks(void)
Assign a value to Include_user_tracks data member.
TUse_multiple_containers & SetUse_multiple_containers(void)
Assign a value to Use_multiple_containers data member.
const TIdentity & GetIdentity(void) const
Get the Identity member data.
bool IsSetFlags(void) const
Check if a value has been assigned to Flags data member.
TInclude_remote_tracks & SetInclude_remote_tracks(void)
Assign a value to Include_remote_tracks data member.
list< CRef< CTMgr_AttrSpec > > m_Attrs
bool IsSetInclude_remote_tracks(void) const
Check if a value has been assigned to Include_remote_tracks data member.
const TFlags & GetFlags(void) const
Get the Flags member data.
TInclude_remote_tracks GetInclude_remote_tracks(void) const
Get the Include_remote_tracks member data.
TInclude_stats & SetInclude_stats(void)
Assign a value to Include_stats data member.
void SetDefaultInclude_track_items(void)
Assign default value to Include_track_items data member.
bool IsSetInclude_TMS_tracks(void) const
Check if a value has been assigned to Include_TMS_tracks data member.
bool CanGetClient(void) const
Check if it is safe to call GetClient method.
bool CanGetAuthorization(void) const
Check if it is safe to call GetAuthorization method.
bool CanGetInclude_default_tracks(void) const
Check if it is safe to call GetInclude_default_tracks 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 Fri Sep 20 14:58:02 2024 by modify_doxy.py rev. 669887