NCBI C++ ToolKit
ID2_Reply_.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_Reply_.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_REPLY_BASE_HPP
42 #define OBJECTS_ID2_ID2_REPLY_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
49 
51 
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
55 #endif
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57 
58 
59 // forward declarations
62 class CID2_Error;
63 class CID2_Params;
70 
71 
72 // generated classes
73 
74 
75 /** @addtogroup dataspec_NCBI_ID2Access
76  *
77  * @{
78  */
79 
80 /////////////////////////////////////////////////////////////////////////////
81 ///*********************************************************************
82 /// reply types
83 ///*********************************************************************
84 ///
85 /// CID2_Reply_Base --
86 ///
87 
89 {
91 public:
92  // constructor
93  CID2_Reply_Base(void);
94  // destructor
95  virtual ~CID2_Reply_Base(void);
96 
97  // type info
99 
100  /////////////////////////////////////////////////////////////////////////////
101  /// reply data moved at the end to make it easier to construct
102  /// the reply data manually from precalculated data
103  ///
104  /// C_Reply --
105  ///
106 
108  {
110  public:
111  // constructor
112  C_Reply(void);
113  // destructor
114  ~C_Reply(void);
115 
116  // type info
118 
119 
120  /// Choice variants.
121  enum E_Choice {
122  e_not_set = 0, ///< No variant selected
132  e_Get_chunk
133  };
134  /// Maximum+1 value of the choice variant enumerator.
136  e_MaxChoice = 11 ///< == e_Get_chunk+1
137  };
138 
139  /// Reset the whole object
140  void Reset(void);
141 
142  /// Reset the selection (set it to e_not_set).
143  void ResetSelection(void);
144 
145  /// Which variant is currently selected.
146  ///
147  /// @return
148  /// Choice state enumerator.
149  E_Choice Which(void) const;
150 
151  /// Verify selection, throw exception if it differs from the expected.
152  ///
153  /// @param index
154  /// Expected selection.
155  void CheckSelected(E_Choice index) const;
156 
157  /// Throw 'InvalidSelection' exception.
158  ///
159  /// @param index
160  /// Expected selection.
161  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
162 
163  /// Retrieve selection name (for diagnostic purposes).
164  ///
165  /// @param index
166  /// One of possible selection states.
167  /// @return
168  /// Name string.
169  static string SelectionName(E_Choice index);
170 
171  /// Select the requested variant if needed.
172  ///
173  /// @param index
174  /// New selection state.
175  /// @param reset
176  /// Flag that defines the resetting of the variant data. The data will
177  /// be reset if either the current selection differs from the new one,
178  /// or the flag is set to eDoResetVariant.
180  /// Select the requested variant if needed,
181  /// allocating CObject variants from memory pool.
182  void Select(E_Choice index,
183  EResetVariant reset,
184  CObjectMemoryPool* pool);
185 
186  // types
195 
196  // getters
197  // setters
198 
199 
200  /// Check if variant Init is selected.
201  ///
202  /// @return
203  /// - true, if the variant is selected.
204  /// - false, otherwise.
205  bool IsInit(void) const;
206 
207  /// Select the variant.
208  void SetInit(void);
209 
210 
211  /// Check if variant Empty is selected.
212  ///
213  /// @return
214  /// - true, if the variant is selected.
215  /// - false, otherwise.
216  bool IsEmpty(void) const;
217 
218  /// Select the variant.
219  void SetEmpty(void);
220 
221 
222  /// Check if variant Get_package is selected.
223  ///
224  /// Get_package type is defined as 'typedef CID2_Reply_Get_Package TGet_package'.
225  /// @return
226  /// - true, if the variant is selected.
227  /// - false, otherwise.
228  bool IsGet_package(void) const;
229 
230  /// Get the variant data.
231  ///
232  /// @return
233  /// Reference to the data.
234  const TGet_package& GetGet_package(void) const;
235 
236  /// Select the variant.
237  ///
238  /// @return
239  /// Reference to the variant data.
240  TGet_package& SetGet_package(void);
241  /// Select the variant and set its data.
242  ///
243  /// @param value
244  /// Reference to the data.
245  void SetGet_package(TGet_package& value);
246 
247 
248  /// Check if variant Get_seq_id is selected.
249  ///
250  /// Get_seq_id type is defined as 'typedef CID2_Reply_Get_Seq_id TGet_seq_id'.
251  /// @return
252  /// - true, if the variant is selected.
253  /// - false, otherwise.
254  bool IsGet_seq_id(void) const;
255 
256  /// Get the variant data.
257  ///
258  /// @return
259  /// Reference to the data.
260  const TGet_seq_id& GetGet_seq_id(void) const;
261 
262  /// Select the variant.
263  ///
264  /// @return
265  /// Reference to the variant data.
266  TGet_seq_id& SetGet_seq_id(void);
267  /// Select the variant and set its data.
268  ///
269  /// @param value
270  /// Reference to the data.
271  void SetGet_seq_id(TGet_seq_id& value);
272 
273 
274  /// Check if variant Get_blob_id is selected.
275  ///
276  /// Get_blob_id type is defined as 'typedef CID2_Reply_Get_Blob_Id TGet_blob_id'.
277  /// @return
278  /// - true, if the variant is selected.
279  /// - false, otherwise.
280  bool IsGet_blob_id(void) const;
281 
282  /// Get the variant data.
283  ///
284  /// @return
285  /// Reference to the data.
286  const TGet_blob_id& GetGet_blob_id(void) const;
287 
288  /// Select the variant.
289  ///
290  /// @return
291  /// Reference to the variant data.
292  TGet_blob_id& SetGet_blob_id(void);
293  /// Select the variant and set its data.
294  ///
295  /// @param value
296  /// Reference to the data.
297  void SetGet_blob_id(TGet_blob_id& value);
298 
299 
300  /// Check if variant Get_blob_seq_ids is selected.
301  ///
302  /// Get_blob_seq_ids type is defined as 'typedef CID2_Reply_Get_Blob_Seq_ids TGet_blob_seq_ids'.
303  /// @return
304  /// - true, if the variant is selected.
305  /// - false, otherwise.
306  bool IsGet_blob_seq_ids(void) const;
307 
308  /// Get the variant data.
309  ///
310  /// @return
311  /// Reference to the data.
312  const TGet_blob_seq_ids& GetGet_blob_seq_ids(void) const;
313 
314  /// Select the variant.
315  ///
316  /// @return
317  /// Reference to the variant data.
318  TGet_blob_seq_ids& SetGet_blob_seq_ids(void);
319  /// Select the variant and set its data.
320  ///
321  /// @param value
322  /// Reference to the data.
323  void SetGet_blob_seq_ids(TGet_blob_seq_ids& value);
324 
325 
326  /// Check if variant Get_blob is selected.
327  ///
328  /// Get_blob type is defined as 'typedef CID2_Reply_Get_Blob TGet_blob'.
329  /// @return
330  /// - true, if the variant is selected.
331  /// - false, otherwise.
332  bool IsGet_blob(void) const;
333 
334  /// Get the variant data.
335  ///
336  /// @return
337  /// Reference to the data.
338  const TGet_blob& GetGet_blob(void) const;
339 
340  /// Select the variant.
341  ///
342  /// @return
343  /// Reference to the variant data.
344  TGet_blob& SetGet_blob(void);
345  /// Select the variant and set its data.
346  ///
347  /// @param value
348  /// Reference to the data.
349  void SetGet_blob(TGet_blob& value);
350 
351 
352  /// Check if variant Reget_blob is selected.
353  ///
354  /// Reget_blob type is defined as 'typedef CID2_Reply_ReGet_Blob TReget_blob'.
355  /// @return
356  /// - true, if the variant is selected.
357  /// - false, otherwise.
358  bool IsReget_blob(void) const;
359 
360  /// Get the variant data.
361  ///
362  /// @return
363  /// Reference to the data.
364  const TReget_blob& GetReget_blob(void) const;
365 
366  /// Select the variant.
367  ///
368  /// @return
369  /// Reference to the variant data.
370  TReget_blob& SetReget_blob(void);
371  /// Select the variant and set its data.
372  ///
373  /// @param value
374  /// Reference to the data.
375  void SetReget_blob(TReget_blob& value);
376 
377 
378  /// Check if variant Get_split_info is selected.
379  ///
380  /// Get_split_info type is defined as 'typedef CID2S_Reply_Get_Split_Info TGet_split_info'.
381  /// @return
382  /// - true, if the variant is selected.
383  /// - false, otherwise.
384  bool IsGet_split_info(void) const;
385 
386  /// Get the variant data.
387  ///
388  /// @return
389  /// Reference to the data.
390  const TGet_split_info& GetGet_split_info(void) const;
391 
392  /// Select the variant.
393  ///
394  /// @return
395  /// Reference to the variant data.
396  TGet_split_info& SetGet_split_info(void);
397  /// Select the variant and set its data.
398  ///
399  /// @param value
400  /// Reference to the data.
401  void SetGet_split_info(TGet_split_info& value);
402 
403 
404  /// Check if variant Get_chunk is selected.
405  ///
406  /// Get_chunk type is defined as 'typedef CID2S_Reply_Get_Chunk TGet_chunk'.
407  /// @return
408  /// - true, if the variant is selected.
409  /// - false, otherwise.
410  bool IsGet_chunk(void) const;
411 
412  /// Get the variant data.
413  ///
414  /// @return
415  /// Reference to the data.
416  const TGet_chunk& GetGet_chunk(void) const;
417 
418  /// Select the variant.
419  ///
420  /// @return
421  /// Reference to the variant data.
422  TGet_chunk& SetGet_chunk(void);
423  /// Select the variant and set its data.
424  ///
425  /// @param value
426  /// Reference to the data.
427  void SetGet_chunk(TGet_chunk& value);
428 
429 
430  private:
431  // copy constructor and assignment operator
432  C_Reply(const C_Reply& );
434  // choice state
436  // helper methods
437  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
438 
439  static const char* const sm_SelectionNames[];
440  // data
441  union {
442  NCBI_NS_NCBI::CSerialObject *m_object;
443  };
444  };
445  /// additional error flag if the reply is broken in the middle
446  /// of transfer.
447  /// 'last-octet-string', and 'nothing' mean that
448  /// client may use ReGet request to get the remaining data.
449  enum EDiscard {
450  eDiscard_reply = 0, ///< whole reply should be discarded
451  eDiscard_last_octet_string = 1, ///< all data in embedded ID2-Reply-Data except last OCTET STRING is correct
452  eDiscard_nothing = 2 ///< all data in embedded ID2-Reply-Data is correct, but is incomplete
453  };
454 
455  /// Access to EDiscard's attributes (values, names) as defined in spec
456  static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EDiscard)(void);
457 
458  // types
459  typedef int TSerial_number;
461  typedef list< CRef< CID2_Error > > TError;
462  typedef C_Reply TReply;
464 
465  // member index
466  enum class E_memberIndex {
467  e__allMandatory = 0,
468  e_serial_number,
469  e_params,
470  e_error,
471  e_end_of_reply,
472  e_reply,
473  e_discard
474  };
476 
477  // getters
478  // setters
479 
480  /// request's serial number, copy from request
481  /// Check if a value has been assigned to Serial_number data member.
482  ///
483  /// Data member Serial_number is optional;
484  /// its type is defined as 'typedef int TSerial_number'
485  /// @return
486  /// - true, if a value has been assigned.
487  /// - false, otherwise.
488  bool IsSetSerial_number(void) const;
489 
490  /// Check if it is safe to call GetSerial_number method.
491  ///
492  /// @return
493  /// - true, if the data member is getatable.
494  /// - false, otherwise.
495  bool CanGetSerial_number(void) const;
496 
497  /// Reset Serial_number data member.
498  void ResetSerial_number(void);
499 
500  /// Get the Serial_number member data.
501  ///
502  /// @return
503  /// Copy of the member data.
504  TSerial_number GetSerial_number(void) const;
505 
506  /// Assign a value to Serial_number data member.
507  ///
508  /// @param value
509  /// Value to assign
510  void SetSerial_number(TSerial_number value);
511 
512  /// Assign a value to Serial_number data member.
513  ///
514  /// @return
515  /// Reference to the data value.
516  TSerial_number& SetSerial_number(void);
517 
518  /// Check if a value has been assigned to Params data member.
519  ///
520  /// Data member Params is optional;
521  /// its type is defined as 'typedef CID2_Params TParams'
522  /// @return
523  /// - true, if a value has been assigned.
524  /// - false, otherwise.
525  bool IsSetParams(void) const;
526 
527  /// Check if it is safe to call GetParams method.
528  ///
529  /// @return
530  /// - true, if the data member is getatable.
531  /// - false, otherwise.
532  bool CanGetParams(void) const;
533 
534  /// Reset Params data member.
535  void ResetParams(void);
536 
537  /// Get the Params member data.
538  ///
539  /// @return
540  /// Reference to the member data.
541  const TParams& GetParams(void) const;
542 
543  /// Assign a value to Params data member.
544  ///
545  /// @param value
546  /// Reference to value.
547  void SetParams(TParams& value);
548 
549  /// Assign a value to Params data member.
550  ///
551  /// @return
552  /// Reference to the data value.
553  TParams& SetParams(void);
554 
555  /// Check if a value has been assigned to Error data member.
556  ///
557  /// Data member Error is optional;
558  /// its type is defined as 'typedef list< CRef< CID2_Error > > TError'
559  /// @return
560  /// - true, if a value has been assigned.
561  /// - false, otherwise.
562  bool IsSetError(void) const;
563 
564  /// Check if it is safe to call GetError method.
565  ///
566  /// @return
567  /// - true, if the data member is getatable.
568  /// - false, otherwise.
569  bool CanGetError(void) const;
570 
571  /// Reset Error data member.
572  void ResetError(void);
573 
574  /// Get the Error member data.
575  ///
576  /// @return
577  /// Reference to the member data.
578  const TError& GetError(void) const;
579 
580  /// Assign a value to Error data member.
581  ///
582  /// @return
583  /// Reference to the data value.
584  TError& SetError(void);
585 
586  /// true if this reply is the last one for the request
587  /// false if more replies will follow
588  /// Check if a value has been assigned to End_of_reply data member.
589  ///
590  /// Data member End_of_reply is optional
591  /// @return
592  /// - true, if a value has been assigned.
593  /// - false, otherwise.
594  bool IsSetEnd_of_reply(void) const;
595 
596  /// Check if value of End_of_reply member is getatable.
597  ///
598  /// @return
599  /// - false; the data member of type 'NULL' has no value.
600  bool CanGetEnd_of_reply(void) const;
601 
602  /// Reset End_of_reply data member.
603  void ResetEnd_of_reply(void);
604 
605  /// Set NULL data member (assign 'NULL' value to End_of_reply data member).
606  void SetEnd_of_reply(void);
607 
608  /// Check if a value has been assigned to Reply data member.
609  ///
610  /// Data member Reply is mandatory;
611  /// its type is defined as 'typedef C_Reply TReply'
612  /// @return
613  /// - true, if a value has been assigned.
614  /// - false, otherwise.
615  bool IsSetReply(void) const;
616 
617  /// Check if it is safe to call GetReply method.
618  ///
619  /// @return
620  /// - true, if the data member is getatable.
621  /// - false, otherwise.
622  bool CanGetReply(void) const;
623 
624  /// Reset Reply data member.
625  void ResetReply(void);
626 
627  /// Get the Reply member data.
628  ///
629  /// @return
630  /// Reference to the member data.
631  const TReply& GetReply(void) const;
632 
633  /// Assign a value to Reply data member.
634  ///
635  /// @param value
636  /// Reference to value.
637  void SetReply(TReply& value);
638 
639  /// Assign a value to Reply data member.
640  ///
641  /// @return
642  /// Reference to the data value.
643  TReply& SetReply(void);
644 
645  /// Check if a value has been assigned to Discard data member.
646  ///
647  /// Data member Discard is optional;
648  /// its type is defined as 'typedef EDiscard TDiscard'
649  /// @return
650  /// - true, if a value has been assigned.
651  /// - false, otherwise.
652  bool IsSetDiscard(void) const;
653 
654  /// Check if it is safe to call GetDiscard method.
655  ///
656  /// @return
657  /// - true, if the data member is getatable.
658  /// - false, otherwise.
659  bool CanGetDiscard(void) const;
660 
661  /// Reset Discard data member.
662  void ResetDiscard(void);
663 
664  /// Get the Discard member data.
665  ///
666  /// @return
667  /// Copy of the member data.
668  TDiscard GetDiscard(void) const;
669 
670  /// Assign a value to Discard data member.
671  ///
672  /// @param value
673  /// Value to assign
674  void SetDiscard(TDiscard value);
675 
676  /// Assign a value to Discard data member.
677  ///
678  /// @return
679  /// Reference to the data value.
680  TDiscard& SetDiscard(void);
681 
682  /// Reset the whole object
683  virtual void Reset(void);
684 
685 
686 private:
687  // Prohibit copy constructor and assignment operator
690 
691  // data
692  Uint4 m_set_State[1];
695  list< CRef< CID2_Error > > m_Error;
698 };
699 
700 /* @} */
701 
702 
703 
704 
705 
706 ///////////////////////////////////////////////////////////
707 ///////////////////// inline methods //////////////////////
708 ///////////////////////////////////////////////////////////
709 inline
711 {
712  return m_choice;
713 }
714 
715 inline
717 {
718  if ( m_choice != index )
719  ThrowInvalidSelection(index);
720 }
721 
722 inline
723 void CID2_Reply_Base::C_Reply::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
724 {
725  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
726  if ( m_choice != e_not_set )
727  ResetSelection();
728  DoSelect(index, pool);
729  }
730 }
731 
732 inline
734 {
735  Select(index, reset, 0);
736 }
737 
738 inline
740 {
741  return m_choice == e_Init;
742 }
743 
744 inline
746 {
747  Select(e_Init, NCBI_NS_NCBI::eDoNotResetVariant);
748 }
749 
750 inline
752 {
753  return m_choice == e_Empty;
754 }
755 
756 inline
758 {
759  Select(e_Empty, NCBI_NS_NCBI::eDoNotResetVariant);
760 }
761 
762 inline
764 {
765  return m_choice == e_Get_package;
766 }
767 
768 inline
770 {
771  return m_choice == e_Get_seq_id;
772 }
773 
774 inline
776 {
777  return m_choice == e_Get_blob_id;
778 }
779 
780 inline
782 {
783  return m_choice == e_Get_blob_seq_ids;
784 }
785 
786 inline
788 {
789  return m_choice == e_Get_blob;
790 }
791 
792 inline
794 {
795  return m_choice == e_Reget_blob;
796 }
797 
798 inline
800 {
801  return m_choice == e_Get_split_info;
802 }
803 
804 inline
806 {
807  return m_choice == e_Get_chunk;
808 }
809 
810 inline
812 {
813  return ((m_set_State[0] & 0x3) != 0);
814 }
815 
816 inline
818 {
819  return IsSetSerial_number();
820 }
821 
822 inline
824 {
825  m_Serial_number = 0;
826  m_set_State[0] &= ~0x3;
827 }
828 
829 inline
831 {
832  if (!CanGetSerial_number()) {
833  ThrowUnassigned(0);
834  }
835  return m_Serial_number;
836 }
837 
838 inline
840 {
842  m_set_State[0] |= 0x3;
843 }
844 
845 inline
847 {
848 #ifdef _DEBUG
849  if (!IsSetSerial_number()) {
851  }
852 #endif
853  m_set_State[0] |= 0x1;
854  return m_Serial_number;
855 }
856 
857 inline
859 {
860  return m_Params.NotEmpty();
861 }
862 
863 inline
865 {
866  return IsSetParams();
867 }
868 
869 inline
871 {
872  if (!CanGetParams()) {
873  ThrowUnassigned(1);
874  }
875  return (*m_Params);
876 }
877 
878 inline
880 {
881  return ((m_set_State[0] & 0x30) != 0);
882 }
883 
884 inline
886 {
887  return true;
888 }
889 
890 inline
892 {
893  return m_Error;
894 }
895 
896 inline
898 {
899  m_set_State[0] |= 0x10;
900  return m_Error;
901 }
902 
903 inline
905 {
906  return ((m_set_State[0] & 0xc0) != 0);
907 }
908 
909 inline
911 {
912  return false;
913 }
914 
915 inline
917 {
918  m_set_State[0] &= ~0xc0;
919 }
920 
921 inline
923 {
924  m_set_State[0] |= 0xc0;
925 }
926 
927 inline
929 {
930  return m_Reply.NotEmpty();
931 }
932 
933 inline
935 {
936  return true;
937 }
938 
939 inline
941 {
942  if ( !m_Reply ) {
943  const_cast<CID2_Reply_Base*>(this)->ResetReply();
944  }
945  return (*m_Reply);
946 }
947 
948 inline
950 {
951  if ( !m_Reply ) {
952  ResetReply();
953  }
954  return (*m_Reply);
955 }
956 
957 inline
959 {
960  return ((m_set_State[0] & 0xc00) != 0);
961 }
962 
963 inline
965 {
966  return IsSetDiscard();
967 }
968 
969 inline
971 {
972  m_Discard = (EDiscard)(0);
973  m_set_State[0] &= ~0xc00;
974 }
975 
976 inline
978 {
979  if (!CanGetDiscard()) {
980  ThrowUnassigned(5);
981  }
982  return m_Discard;
983 }
984 
985 inline
987 {
988  m_Discard = value;
989  m_set_State[0] |= 0xc00;
990 }
991 
992 inline
994 {
995 #ifdef _DEBUG
996  if (!IsSetDiscard()) {
997  memset(&m_Discard,UnassignedByte(),sizeof(m_Discard));
998  }
999 #endif
1000  m_set_State[0] |= 0x400;
1001  return m_Discard;
1002 }
1003 
1004 ///////////////////////////////////////////////////////////
1005 ////////////////// end of inline methods //////////////////
1006 ///////////////////////////////////////////////////////////
1007 
1008 
1009 
1010 
1011 
1012 END_objects_SCOPE // namespace ncbi::objects::
1013 
1015 
1016 
1017 #endif // OBJECTS_ID2_ID2_REPLY_BASE_HPP
CID2S_Reply_Get_Chunk –.
CID2S_Reply_Get_Split_Info –.
CID2_Error –.
Definition: ID2_Error.hpp:66
CID2_Params –.
Definition: ID2_Params.hpp:66
reply data moved at the end to make it easier to construct the reply data manually from precalculated...
Definition: ID2_Reply_.hpp:108
********************************************************************* reply types *******************...
Definition: ID2_Reply_.hpp:89
CID2_Reply_Get_Blob_Id –.
CID2_Reply_Get_Blob_Seq_ids –.
CID2_Reply_Get_Blob –.
CID2_Reply_Get_Package –.
CID2_Reply_Get_Seq_id –.
CID2_Reply_ReGet_Blob –.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
EResetVariant
Definition: serialbase.hpp:76
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
@ eDoResetVariant
Definition: serialbase.hpp:77
@ eDoNotResetVariant
Definition: serialbase.hpp:78
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
virtual void SetParams()
Called at the beginning of Run, before creating thread pool.
#define NCBI_ID2_EXPORT
Definition: ncbi_export.h:552
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
void ResetSerial_number(void)
Reset Serial_number data member.
Definition: ID2_Reply_.hpp:823
bool IsReget_blob(void) const
Check if variant Reget_blob is selected.
Definition: ID2_Reply_.hpp:793
CID2_Reply_Get_Blob_Seq_ids TGet_blob_seq_ids
Definition: ID2_Reply_.hpp:190
bool IsGet_chunk(void) const
Check if variant Get_chunk is selected.
Definition: ID2_Reply_.hpp:805
void ResetEnd_of_reply(void)
Reset End_of_reply data member.
Definition: ID2_Reply_.hpp:916
E_Choice Which(void) const
Which variant is currently selected.
Definition: ID2_Reply_.hpp:710
const TError & GetError(void) const
Get the Error member data.
Definition: ID2_Reply_.hpp:891
CID2_Reply_Base(const CID2_Reply_Base &)
EDiscard TDiscard
Definition: ID2_Reply_.hpp:463
void SetInit(void)
Select the variant.
Definition: ID2_Reply_.hpp:745
bool CanGetEnd_of_reply(void) const
Check if value of End_of_reply member is getatable.
Definition: ID2_Reply_.hpp:910
C_Reply(const C_Reply &)
E_Choice
Choice variants.
Definition: ID2_Reply_.hpp:121
bool IsGet_split_info(void) const
Check if variant Get_split_info is selected.
Definition: ID2_Reply_.hpp:799
CID2_Reply_Get_Blob TGet_blob
Definition: ID2_Reply_.hpp:191
bool IsSetReply(void) const
Check if a value has been assigned to Reply data member.
Definition: ID2_Reply_.hpp:928
bool IsGet_seq_id(void) const
Check if variant Get_seq_id is selected.
Definition: ID2_Reply_.hpp:769
TError & SetError(void)
Assign a value to Error data member.
Definition: ID2_Reply_.hpp:897
list< CRef< CID2_Error > > TError
Definition: ID2_Reply_.hpp:461
bool IsGet_blob_seq_ids(void) const
Check if variant Get_blob_seq_ids is selected.
Definition: ID2_Reply_.hpp:781
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
Definition: ID2_Reply_.hpp:135
bool IsSetDiscard(void) const
Check if a value has been assigned to Discard data member.
Definition: ID2_Reply_.hpp:958
bool IsEmpty(void) const
Check if variant Empty is selected.
Definition: ID2_Reply_.hpp:751
TDiscard & SetDiscard(void)
Assign a value to Discard data member.
Definition: ID2_Reply_.hpp:993
EDiscard m_Discard
Definition: ID2_Reply_.hpp:697
bool IsGet_blob(void) const
Check if variant Get_blob is selected.
Definition: ID2_Reply_.hpp:787
void ResetReply(void)
Reset Reply data member.
Definition: ID2_Reply_.cpp:386
bool IsSetParams(void) const
Check if a value has been assigned to Params data member.
Definition: ID2_Reply_.hpp:858
bool CanGetError(void) const
Check if it is safe to call GetError method.
Definition: ID2_Reply_.hpp:885
const TParams & GetParams(void) const
Get the Params member data.
Definition: ID2_Reply_.hpp:870
C_Reply & operator=(const C_Reply &)
EDiscard
additional error flag if the reply is broken in the middle of transfer.
Definition: ID2_Reply_.hpp:449
TDiscard GetDiscard(void) const
Get the Discard member data.
Definition: ID2_Reply_.hpp:977
CID2_Reply_Get_Blob_Id TGet_blob_id
Definition: ID2_Reply_.hpp:189
TReply & SetReply(void)
Assign a value to Reply data member.
Definition: ID2_Reply_.hpp:949
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
Definition: ID2_Reply_.hpp:716
list< CRef< CID2_Error > > m_Error
Definition: ID2_Reply_.hpp:695
const TReply & GetReply(void) const
Get the Reply member data.
Definition: ID2_Reply_.hpp:940
CID2S_Reply_Get_Chunk TGet_chunk
Definition: ID2_Reply_.hpp:194
CID2_Reply_Get_Seq_id TGet_seq_id
Definition: ID2_Reply_.hpp:188
CID2_Reply_Base & operator=(const CID2_Reply_Base &)
CID2_Params TParams
Definition: ID2_Reply_.hpp:460
bool IsInit(void) const
Check if variant Init is selected.
Definition: ID2_Reply_.hpp:739
TSerial_number GetSerial_number(void) const
Get the Serial_number member data.
Definition: ID2_Reply_.hpp:830
void SetEnd_of_reply(void)
Set NULL data member (assign 'NULL' value to End_of_reply data member).
Definition: ID2_Reply_.hpp:922
CID2_Reply_ReGet_Blob TReget_blob
Definition: ID2_Reply_.hpp:192
NCBI_NS_NCBI::CSerialObject * m_object
Definition: ID2_Reply_.hpp:442
bool CanGetReply(void) const
Check if it is safe to call GetReply method.
Definition: ID2_Reply_.hpp:934
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
bool IsSetSerial_number(void) const
request's serial number, copy from request Check if a value has been assigned to Serial_number data m...
Definition: ID2_Reply_.hpp:811
CID2_Reply_Get_Package TGet_package
Definition: ID2_Reply_.hpp:187
void ResetDiscard(void)
Reset Discard data member.
Definition: ID2_Reply_.hpp:970
bool CanGetSerial_number(void) const
Check if it is safe to call GetSerial_number method.
Definition: ID2_Reply_.hpp:817
Tparent::CMemberIndex< E_memberIndex, 7 > TmemberIndex
Definition: ID2_Reply_.hpp:475
bool IsSetError(void) const
Check if a value has been assigned to Error data member.
Definition: ID2_Reply_.hpp:879
void SetEmpty(void)
Select the variant.
Definition: ID2_Reply_.hpp:757
CRef< TReply > m_Reply
Definition: ID2_Reply_.hpp:696
bool IsGet_blob_id(void) const
Check if variant Get_blob_id is selected.
Definition: ID2_Reply_.hpp:775
bool CanGetParams(void) const
Check if it is safe to call GetParams method.
Definition: ID2_Reply_.hpp:864
bool IsSetEnd_of_reply(void) const
true if this reply is the last one for the request false if more replies will follow Check if a value...
Definition: ID2_Reply_.hpp:904
bool CanGetDiscard(void) const
Check if it is safe to call GetDiscard method.
Definition: ID2_Reply_.hpp:964
CSerialObject Tparent
Definition: ID2_Reply_.hpp:90
TSerial_number & SetSerial_number(void)
Assign a value to Serial_number data member.
Definition: ID2_Reply_.hpp:846
CID2S_Reply_Get_Split_Info TGet_split_info
Definition: ID2_Reply_.hpp:193
Uint4 m_set_State[1]
Definition: ID2_Reply_.hpp:692
bool IsGet_package(void) const
Check if variant Get_package is selected.
Definition: ID2_Reply_.hpp:763
CRef< TParams > m_Params
Definition: ID2_Reply_.hpp:694
@ e_not_set
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
static CRef< CUser_object > GetParams()
Modified on Sun May 19 04:39:37 2024 by modify_doxy.py rev. 669887