NCBI C++ ToolKit
TMgr_CreateRemoteTrackRequ_.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_CreateRemoteTrackRequ_.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_CREATEREMOTETRACKREQU_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_CREATEREMOTETRACKREQU_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>
54 
56 
57 #ifndef BEGIN_objects_SCOPE
58 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
59 # define END_objects_SCOPE END_SCOPE(objects)
60 #endif
61 BEGIN_objects_SCOPE // namespace ncbi::objects::
62 
63 
64 // forward declarations
65 class CTMgr_Attribute;
66 class CTMgr_ClientInfo;
67 class CTMgr_Hub;
68 class CTMgr_HubTrack;
69 class CTMgr_Identity;
70 
71 
72 // generated classes
73 
74 
75 /** @addtogroup dataspec_NCBI_TrackManager
76  *
77  * @{
78  */
79 
80 /////////////////////////////////////////////////////////////////////////////
81 ///-
82 ///- Used to create remote tracks, hubs and tracks in hubs
83 ///-
84 ///
85 /// CTMgr_CreateRemoteTrackRequest_Base --
86 ///
87 
89 {
91 public:
92  // constructor
94  // destructor
96 
97  // type info
99 
100  /////////////////////////////////////////////////////////////////////////////
101  /// Hub Track Database specific fields
102  ///
103  /// C_Track_db --
104  ///
105 
107  {
109  public:
110  // constructor
111  C_Track_db(void);
112  // destructor
113  ~C_Track_db(void);
114 
115  // type info
117 
118 
119  /// Choice variants.
120  enum E_Choice {
121  e_not_set = 0, ///< No variant selected
123  e_Track
124  };
125  /// Maximum+1 value of the choice variant enumerator.
127  e_MaxChoice = 3 ///< == e_Track+1
128  };
129 
130  /// Reset the whole object
131  void Reset(void);
132 
133  /// Reset the selection (set it to e_not_set).
134  void ResetSelection(void);
135 
136  /// Which variant is currently selected.
137  ///
138  /// @return
139  /// Choice state enumerator.
140  E_Choice Which(void) const;
141 
142  /// Verify selection, throw exception if it differs from the expected.
143  ///
144  /// @param index
145  /// Expected selection.
146  void CheckSelected(E_Choice index) const;
147 
148  /// Throw 'InvalidSelection' exception.
149  ///
150  /// @param index
151  /// Expected selection.
152  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
153 
154  /// Retrieve selection name (for diagnostic purposes).
155  ///
156  /// @param index
157  /// One of possible selection states.
158  /// @return
159  /// Name string.
160  static string SelectionName(E_Choice index);
161 
162  /// Select the requested variant if needed.
163  ///
164  /// @param index
165  /// New selection state.
166  /// @param reset
167  /// Flag that defines the resetting of the variant data. The data will
168  /// be reset if either the current selection differs from the new one,
169  /// or the flag is set to eDoResetVariant.
171  /// Select the requested variant if needed,
172  /// allocating CObject variants from memory pool.
173  void Select(E_Choice index,
174  EResetVariant reset,
175  CObjectMemoryPool* pool);
176 
177  // types
178  typedef CTMgr_Hub THub;
180 
181  // getters
182  // setters
183 
184 
185  /// Check if variant Hub is selected.
186  ///
187  /// Hub type is defined as 'typedef CTMgr_Hub THub'.
188  /// @return
189  /// - true, if the variant is selected.
190  /// - false, otherwise.
191  bool IsHub(void) const;
192 
193  /// Get the variant data.
194  ///
195  /// @return
196  /// Reference to the data.
197  const THub& GetHub(void) const;
198 
199  /// Select the variant.
200  ///
201  /// @return
202  /// Reference to the variant data.
203  THub& SetHub(void);
204  /// Select the variant and set its data.
205  ///
206  /// @param value
207  /// Reference to the data.
208  void SetHub(THub& value);
209 
210 
211  /// Check if variant Track is selected.
212  ///
213  /// Track type is defined as 'typedef CTMgr_HubTrack TTrack'.
214  /// @return
215  /// - true, if the variant is selected.
216  /// - false, otherwise.
217  bool IsTrack(void) const;
218 
219  /// Get the variant data.
220  ///
221  /// @return
222  /// Reference to the data.
223  const TTrack& GetTrack(void) const;
224 
225  /// Select the variant.
226  ///
227  /// @return
228  /// Reference to the variant data.
229  TTrack& SetTrack(void);
230  /// Select the variant and set its data.
231  ///
232  /// @param value
233  /// Reference to the data.
234  void SetTrack(TTrack& value);
235 
236 
237  private:
238  // copy constructor and assignment operator
241  // choice state
243  // helper methods
244  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
245 
246  static const char* const sm_SelectionNames[];
247  // data
248  NCBI_NS_NCBI::CSerialObject *m_object;
249  };
250  // types
252  typedef string TAssembly_acc;
253  typedef string TUrl;
254  typedef int TType;
255  typedef string TTrack_name;
256  typedef string TIndex_url;
258  typedef list< CRef< CTMgr_Attribute > > TAttrs;
260 
261  // member index
262  enum class E_memberIndex {
263  e__allMandatory = 0,
264  e_identity,
265  e_assembly_acc,
266  e_url,
267  e_type,
268  e_track_name,
269  e_index_url,
270  e_track_db,
271  e_attrs,
272  e_client
273  };
275 
276  // getters
277  // setters
278 
279  /// common to hubs and tracks
280  /// identity of user
281  /// Check if a value has been assigned to Identity data member.
282  ///
283  /// Data member Identity is mandatory;
284  /// its type is defined as 'typedef CTMgr_Identity TIdentity'
285  /// @return
286  /// - true, if a value has been assigned.
287  /// - false, otherwise.
288  bool IsSetIdentity(void) const;
289 
290  /// Check if it is safe to call GetIdentity method.
291  ///
292  /// @return
293  /// - true, if the data member is getatable.
294  /// - false, otherwise.
295  bool CanGetIdentity(void) const;
296 
297  /// Reset Identity data member.
298  void ResetIdentity(void);
299 
300  /// Get the Identity member data.
301  ///
302  /// @return
303  /// Reference to the member data.
304  const TIdentity& GetIdentity(void) const;
305 
306  /// Assign a value to Identity data member.
307  ///
308  /// @param value
309  /// Reference to value.
310  void SetIdentity(TIdentity& value);
311 
312  /// Assign a value to Identity data member.
313  ///
314  /// @return
315  /// Reference to the data value.
316  TIdentity& SetIdentity(void);
317 
318  /// NCBI assembly accession
319  /// Check if a value has been assigned to Assembly_acc data member.
320  ///
321  /// Data member Assembly_acc is mandatory;
322  /// its type is defined as 'typedef string TAssembly_acc'
323  /// @return
324  /// - true, if a value has been assigned.
325  /// - false, otherwise.
326  bool IsSetAssembly_acc(void) const;
327 
328  /// Check if it is safe to call GetAssembly_acc method.
329  ///
330  /// @return
331  /// - true, if the data member is getatable.
332  /// - false, otherwise.
333  bool CanGetAssembly_acc(void) const;
334 
335  /// Reset Assembly_acc data member.
336  void ResetAssembly_acc(void);
337 
338  /// Get the Assembly_acc member data.
339  ///
340  /// @return
341  /// Reference to the member data.
342  const TAssembly_acc& GetAssembly_acc(void) const;
343 
344  /// Assign a value to Assembly_acc data member.
345  ///
346  /// @param value
347  /// Value to assign
348  void SetAssembly_acc(const TAssembly_acc& value);
349  void SetAssembly_acc(TAssembly_acc&& value);
350 
351  /// Assign a value to Assembly_acc data member.
352  ///
353  /// @return
354  /// Reference to the data value.
355  TAssembly_acc& SetAssembly_acc(void);
356 
357  /// url to track data or hub.txt
358  /// Check if a value has been assigned to Url data member.
359  ///
360  /// Data member Url is mandatory;
361  /// its type is defined as 'typedef string TUrl'
362  /// @return
363  /// - true, if a value has been assigned.
364  /// - false, otherwise.
365  bool IsSetUrl(void) const;
366 
367  /// Check if it is safe to call GetUrl method.
368  ///
369  /// @return
370  /// - true, if the data member is getatable.
371  /// - false, otherwise.
372  bool CanGetUrl(void) const;
373 
374  /// Reset Url data member.
375  void ResetUrl(void);
376 
377  /// Get the Url member data.
378  ///
379  /// @return
380  /// Reference to the member data.
381  const TUrl& GetUrl(void) const;
382 
383  /// Assign a value to Url data member.
384  ///
385  /// @param value
386  /// Value to assign
387  void SetUrl(const TUrl& value);
388  void SetUrl(TUrl&& value);
389 
390  /// Assign a value to Url data member.
391  ///
392  /// @return
393  /// Reference to the data value.
394  TUrl& SetUrl(void);
395 
396  /// Check if a value has been assigned to Type data member.
397  ///
398  /// Data member Type is mandatory;
399  /// its type is defined as 'typedef int TType'
400  /// @return
401  /// - true, if a value has been assigned.
402  /// - false, otherwise.
403  bool IsSetType(void) const;
404 
405  /// Check if it is safe to call GetType method.
406  ///
407  /// @return
408  /// - true, if the data member is getatable.
409  /// - false, otherwise.
410  bool CanGetType(void) const;
411 
412  /// Reset Type data member.
413  void ResetType(void);
414 
415  /// Get the Type member data.
416  ///
417  /// @return
418  /// Copy of the member data.
419  TType GetType(void) const;
420 
421  /// Assign a value to Type data member.
422  ///
423  /// @param value
424  /// Value to assign
425  void SetType(TType value);
426 
427  /// Assign a value to Type data member.
428  ///
429  /// @return
430  /// Reference to the data value.
431  TType& SetType(void);
432 
433  /// track specific, i.e., when type != hub
434  /// Check if a value has been assigned to Track_name data member.
435  ///
436  /// Data member Track_name is optional;
437  /// its type is defined as 'typedef string TTrack_name'
438  /// @return
439  /// - true, if a value has been assigned.
440  /// - false, otherwise.
441  bool IsSetTrack_name(void) const;
442 
443  /// Check if it is safe to call GetTrack_name method.
444  ///
445  /// @return
446  /// - true, if the data member is getatable.
447  /// - false, otherwise.
448  bool CanGetTrack_name(void) const;
449 
450  /// Reset Track_name data member.
451  void ResetTrack_name(void);
452 
453  /// Get the Track_name member data.
454  ///
455  /// @return
456  /// Reference to the member data.
457  const TTrack_name& GetTrack_name(void) const;
458 
459  /// Assign a value to Track_name data member.
460  ///
461  /// @param value
462  /// Value to assign
463  void SetTrack_name(const TTrack_name& value);
464  void SetTrack_name(TTrack_name&& value);
465 
466  /// Assign a value to Track_name data member.
467  ///
468  /// @return
469  /// Reference to the data value.
470  TTrack_name& SetTrack_name(void);
471 
472  /// for tracks only, not hubs
473  /// Check if a value has been assigned to Index_url data member.
474  ///
475  /// Data member Index_url is optional;
476  /// its type is defined as 'typedef string TIndex_url'
477  /// @return
478  /// - true, if a value has been assigned.
479  /// - false, otherwise.
480  bool IsSetIndex_url(void) const;
481 
482  /// Check if it is safe to call GetIndex_url method.
483  ///
484  /// @return
485  /// - true, if the data member is getatable.
486  /// - false, otherwise.
487  bool CanGetIndex_url(void) const;
488 
489  /// Reset Index_url data member.
490  void ResetIndex_url(void);
491 
492  /// Get the Index_url member data.
493  ///
494  /// @return
495  /// Reference to the member data.
496  const TIndex_url& GetIndex_url(void) const;
497 
498  /// Assign a value to Index_url data member.
499  ///
500  /// @param value
501  /// Value to assign
502  void SetIndex_url(const TIndex_url& value);
503  void SetIndex_url(TIndex_url&& value);
504 
505  /// Assign a value to Index_url data member.
506  ///
507  /// @return
508  /// Reference to the data value.
509  TIndex_url& SetIndex_url(void);
510 
511  /// Check if a value has been assigned to Track_db data member.
512  ///
513  /// Data member Track_db is optional;
514  /// its type is defined as 'typedef C_Track_db TTrack_db'
515  /// @return
516  /// - true, if a value has been assigned.
517  /// - false, otherwise.
518  bool IsSetTrack_db(void) const;
519 
520  /// Check if it is safe to call GetTrack_db method.
521  ///
522  /// @return
523  /// - true, if the data member is getatable.
524  /// - false, otherwise.
525  bool CanGetTrack_db(void) const;
526 
527  /// Reset Track_db data member.
528  void ResetTrack_db(void);
529 
530  /// Get the Track_db member data.
531  ///
532  /// @return
533  /// Reference to the member data.
534  const TTrack_db& GetTrack_db(void) const;
535 
536  /// Assign a value to Track_db data member.
537  ///
538  /// @param value
539  /// Reference to value.
540  void SetTrack_db(TTrack_db& value);
541 
542  /// Assign a value to Track_db data member.
543  ///
544  /// @return
545  /// Reference to the data value.
546  TTrack_db& SetTrack_db(void);
547 
548  /// future use
549  /// Check if a value has been assigned to Attrs data member.
550  ///
551  /// Data member Attrs is optional;
552  /// its type is defined as 'typedef list< CRef< CTMgr_Attribute > > TAttrs'
553  /// @return
554  /// - true, if a value has been assigned.
555  /// - false, otherwise.
556  bool IsSetAttrs(void) const;
557 
558  /// Check if it is safe to call GetAttrs method.
559  ///
560  /// @return
561  /// - true, if the data member is getatable.
562  /// - false, otherwise.
563  bool CanGetAttrs(void) const;
564 
565  /// Reset Attrs data member.
566  void ResetAttrs(void);
567 
568  /// Get the Attrs member data.
569  ///
570  /// @return
571  /// Reference to the member data.
572  const TAttrs& GetAttrs(void) const;
573 
574  /// Assign a value to Attrs data member.
575  ///
576  /// @return
577  /// Reference to the data value.
578  TAttrs& SetAttrs(void);
579 
580  /// Client information
581  /// Check if a value has been assigned to Client data member.
582  ///
583  /// Data member Client is optional;
584  /// its type is defined as 'typedef CTMgr_ClientInfo TClient'
585  /// @return
586  /// - true, if a value has been assigned.
587  /// - false, otherwise.
588  bool IsSetClient(void) const;
589 
590  /// Check if it is safe to call GetClient method.
591  ///
592  /// @return
593  /// - true, if the data member is getatable.
594  /// - false, otherwise.
595  bool CanGetClient(void) const;
596 
597  /// Reset Client data member.
598  void ResetClient(void);
599 
600  /// Get the Client member data.
601  ///
602  /// @return
603  /// Reference to the member data.
604  const TClient& GetClient(void) const;
605 
606  /// Assign a value to Client data member.
607  ///
608  /// @param value
609  /// Reference to value.
610  void SetClient(TClient& value);
611 
612  /// Assign a value to Client data member.
613  ///
614  /// @return
615  /// Reference to the data value.
616  TClient& SetClient(void);
617 
618  /// Reset the whole object
619  virtual void Reset(void);
620 
621 
622 private:
623  // Prohibit copy constructor and assignment operator
626 
627  // data
628  Uint4 m_set_State[1];
631  string m_Url;
632  int m_Type;
633  string m_Track_name;
634  string m_Index_url;
636  list< CRef< CTMgr_Attribute > > m_Attrs;
638 };
639 
640 /* @} */
641 
642 
643 
644 
645 
646 ///////////////////////////////////////////////////////////
647 ///////////////////// inline methods //////////////////////
648 ///////////////////////////////////////////////////////////
649 inline
651 {
652  return m_choice;
653 }
654 
655 inline
657 {
658  if ( m_choice != index )
659  ThrowInvalidSelection(index);
660 }
661 
662 inline
663 void CTMgr_CreateRemoteTrackRequest_Base::C_Track_db::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
664 {
665  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
666  if ( m_choice != e_not_set )
667  ResetSelection();
668  DoSelect(index, pool);
669  }
670 }
671 
672 inline
674 {
675  Select(index, reset, 0);
676 }
677 
678 inline
680 {
681  return m_choice == e_Hub;
682 }
683 
684 inline
686 {
687  return m_choice == e_Track;
688 }
689 
690 inline
692 {
693  return m_Identity.NotEmpty();
694 }
695 
696 inline
698 {
699  return true;
700 }
701 
702 inline
704 {
705  if ( !m_Identity ) {
707  }
708  return (*m_Identity);
709 }
710 
711 inline
713 {
714  if ( !m_Identity ) {
715  ResetIdentity();
716  }
717  return (*m_Identity);
718 }
719 
720 inline
722 {
723  return ((m_set_State[0] & 0xc) != 0);
724 }
725 
726 inline
728 {
729  return IsSetAssembly_acc();
730 }
731 
732 inline
734 {
735  if (!CanGetAssembly_acc()) {
736  ThrowUnassigned(1);
737  }
738  return m_Assembly_acc;
739 }
740 
741 inline
743 {
745  m_set_State[0] |= 0xc;
746 }
747 
748 inline
750 {
751  m_Assembly_acc = std::forward<CTMgr_CreateRemoteTrackRequest_Base::TAssembly_acc>(value);
752  m_set_State[0] |= 0xc;
753 }
754 
755 inline
757 {
758 #ifdef _DEBUG
759  if (!IsSetAssembly_acc()) {
761  }
762 #endif
763  m_set_State[0] |= 0x4;
764  return m_Assembly_acc;
765 }
766 
767 inline
769 {
770  return ((m_set_State[0] & 0x30) != 0);
771 }
772 
773 inline
775 {
776  return IsSetUrl();
777 }
778 
779 inline
781 {
782  if (!CanGetUrl()) {
783  ThrowUnassigned(2);
784  }
785  return m_Url;
786 }
787 
788 inline
790 {
791  m_Url = value;
792  m_set_State[0] |= 0x30;
793 }
794 
795 inline
797 {
798  m_Url = std::forward<CTMgr_CreateRemoteTrackRequest_Base::TUrl>(value);
799  m_set_State[0] |= 0x30;
800 }
801 
802 inline
804 {
805 #ifdef _DEBUG
806  if (!IsSetUrl()) {
808  }
809 #endif
810  m_set_State[0] |= 0x10;
811  return m_Url;
812 }
813 
814 inline
816 {
817  return ((m_set_State[0] & 0xc0) != 0);
818 }
819 
820 inline
822 {
823  return IsSetType();
824 }
825 
826 inline
828 {
829  m_Type = (int)(0);
830  m_set_State[0] &= ~0xc0;
831 }
832 
833 inline
835 {
836  if (!CanGetType()) {
837  ThrowUnassigned(3);
838  }
839  return m_Type;
840 }
841 
842 inline
844 {
845  m_Type = value;
846  m_set_State[0] |= 0xc0;
847 }
848 
849 inline
851 {
852 #ifdef _DEBUG
853  if (!IsSetType()) {
854  memset(&m_Type,UnassignedByte(),sizeof(m_Type));
855  }
856 #endif
857  m_set_State[0] |= 0x40;
858  return m_Type;
859 }
860 
861 inline
863 {
864  return ((m_set_State[0] & 0x300) != 0);
865 }
866 
867 inline
869 {
870  return IsSetTrack_name();
871 }
872 
873 inline
875 {
876  if (!CanGetTrack_name()) {
877  ThrowUnassigned(4);
878  }
879  return m_Track_name;
880 }
881 
882 inline
884 {
886  m_set_State[0] |= 0x300;
887 }
888 
889 inline
891 {
892  m_Track_name = std::forward<CTMgr_CreateRemoteTrackRequest_Base::TTrack_name>(value);
893  m_set_State[0] |= 0x300;
894 }
895 
896 inline
898 {
899 #ifdef _DEBUG
900  if (!IsSetTrack_name()) {
902  }
903 #endif
904  m_set_State[0] |= 0x100;
905  return m_Track_name;
906 }
907 
908 inline
910 {
911  return ((m_set_State[0] & 0xc00) != 0);
912 }
913 
914 inline
916 {
917  return IsSetIndex_url();
918 }
919 
920 inline
922 {
923  if (!CanGetIndex_url()) {
924  ThrowUnassigned(5);
925  }
926  return m_Index_url;
927 }
928 
929 inline
931 {
932  m_Index_url = value;
933  m_set_State[0] |= 0xc00;
934 }
935 
936 inline
938 {
939  m_Index_url = std::forward<CTMgr_CreateRemoteTrackRequest_Base::TIndex_url>(value);
940  m_set_State[0] |= 0xc00;
941 }
942 
943 inline
945 {
946 #ifdef _DEBUG
947  if (!IsSetIndex_url()) {
949  }
950 #endif
951  m_set_State[0] |= 0x400;
952  return m_Index_url;
953 }
954 
955 inline
957 {
958  return m_Track_db.NotEmpty();
959 }
960 
961 inline
963 {
964  return IsSetTrack_db();
965 }
966 
967 inline
969 {
970  if (!CanGetTrack_db()) {
971  ThrowUnassigned(6);
972  }
973  return (*m_Track_db);
974 }
975 
976 inline
978 {
979  return ((m_set_State[0] & 0xc000) != 0);
980 }
981 
982 inline
984 {
985  return true;
986 }
987 
988 inline
990 {
991  return m_Attrs;
992 }
993 
994 inline
996 {
997  m_set_State[0] |= 0x4000;
998  return m_Attrs;
999 }
1000 
1001 inline
1003 {
1004  return m_Client.NotEmpty();
1005 }
1006 
1007 inline
1009 {
1010  return IsSetClient();
1011 }
1012 
1013 inline
1015 {
1016  if (!CanGetClient()) {
1017  ThrowUnassigned(8);
1018  }
1019  return (*m_Client);
1020 }
1021 
1022 ///////////////////////////////////////////////////////////
1023 ////////////////// end of inline methods //////////////////
1024 ///////////////////////////////////////////////////////////
1025 
1026 
1027 
1028 
1029 
1030 END_objects_SCOPE // namespace ncbi::objects::
1031 
1033 
1034 
1035 #endif // OBJECTS_TRACKMGR_TMGR_CREATEREMOTETRACKREQU_BASE_HPP
User-defined methods of the data storage class.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_Attribute –.
CTMgr_HubTrack –.
CTMgr_Hub –.
Definition: TMgr_Hub.hpp:66
CTMgr_Identity –.
char value[7]
Definition: config.c:431
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
EResetVariant
Definition: serialbase.hpp:76
static string UnassignedString(void)
Definition: serialbase.hpp:175
@ eDoResetVariant
Definition: serialbase.hpp:77
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
bool IsSetIdentity(void) const
common to hubs and tracks identity of user Check if a value has been assigned to Identity data member...
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
bool CanGetIdentity(void) const
Check if it is safe to call GetIdentity method.
bool IsSetUrl(void) const
url to track data or hub.txt Check if a value has been assigned to Url data member.
bool IsSetIndex_url(void) const
for tracks only, not hubs Check if a value has been assigned to Index_url data member.
bool IsSetAttrs(void) const
future use Check if a value has been assigned to Attrs data member.
const TAssembly_acc & GetAssembly_acc(void) const
Get the Assembly_acc member data.
void ResetType(void)
Reset Type data member.
const TTrack_name & GetTrack_name(void) const
Get the Track_name member data.
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
bool IsSetTrack_db(void) const
Check if a value has been assigned to Track_db data member.
bool CanGetIndex_url(void) const
Check if it is safe to call GetIndex_url method.
bool CanGetAssembly_acc(void) const
Check if it is safe to call GetAssembly_acc method.
TIndex_url & SetIndex_url(void)
Assign a value to Index_url data member.
const TAttrs & GetAttrs(void) const
Get the Attrs member data.
TType GetType(void) const
Get the Type member data.
const TUrl & GetUrl(void) const
Get the Url member data.
const TClient & GetClient(void) const
Get the Client member data.
bool IsHub(void) const
Check if variant Hub is selected.
const TIdentity & GetIdentity(void) const
Get the Identity member data.
bool CanGetClient(void) const
Check if it is safe to call GetClient method.
bool IsSetType(void) const
Check if a value has been assigned to Type data member.
bool CanGetType(void) const
Check if it is safe to call GetType method.
E_Choice Which(void) const
Which variant is currently selected.
bool CanGetAttrs(void) const
Check if it is safe to call GetAttrs method.
Tparent::CMemberIndex< E_memberIndex, 10 > TmemberIndex
TIdentity & SetIdentity(void)
Assign a value to Identity data member.
TAssembly_acc & SetAssembly_acc(void)
Assign a value to Assembly_acc data member.
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
bool CanGetUrl(void) const
Check if it is safe to call GetUrl method.
bool CanGetTrack_db(void) const
Check if it is safe to call GetTrack_db method.
C_Track_db & operator=(const C_Track_db &)
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
void ResetIdentity(void)
Reset Identity data member.
bool IsSetTrack_name(void) const
track specific, i.e., when type != hub Check if a value has been assigned to Track_name data member.
TType & SetType(void)
Assign a value to Type data member.
bool IsTrack(void) const
Check if variant Track is selected.
bool IsSetClient(void) const
Client information Check if a value has been assigned to Client data member.
bool IsSetAssembly_acc(void) const
NCBI assembly accession Check if a value has been assigned to Assembly_acc data member.
bool CanGetTrack_name(void) const
Check if it is safe to call GetTrack_name method.
const TIndex_url & GetIndex_url(void) const
Get the Index_url member data.
CTMgr_CreateRemoteTrackRequest_Base(const CTMgr_CreateRemoteTrackRequest_Base &)
TUrl & SetUrl(void)
Assign a value to Url data member.
TTrack_name & SetTrack_name(void)
Assign a value to Track_name data member.
const TTrack_db & GetTrack_db(void) const
Get the Track_db member data.
CTMgr_CreateRemoteTrackRequest_Base & operator=(const CTMgr_CreateRemoteTrackRequest_Base &)
TAttrs & SetAttrs(void)
Assign a value to Attrs data member.
unsigned int
A callback function used to compare two keys in a database.
Definition: types.hpp:1210
@ e_not_set
Defines to provide correct exporting from DLLs in Windows.
#define NCBI_TRACKMGR_EXPORT
Modified on Thu Dec 07 10:06:41 2023 by modify_doxy.py rev. 669887