NCBI C++ ToolKit
PluginArg_.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 PluginArg_.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/gui/objects/gui_objects.asn">gui_objects.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.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 GUI_OBJECTS_PLUGINARG_BASE_HPP
42 #define GUI_OBJECTS_PLUGINARG_BASE_HPP
43 
44 // extra headers
45 #include <gui/gui_export.h>
46 
47 // standard includes
48 #include <serial/serialbase.hpp>
49 
50 // generated includes
51 #include <list>
52 #include <string>
53 
55 
56 #ifndef BEGIN_objects_SCOPE
57 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
58 # define END_objects_SCOPE END_SCOPE(objects)
59 #endif
60 BEGIN_objects_SCOPE // namespace ncbi::objects::
61 
62 
63 // forward declarations
64 class CPluginValue;
66 
67 
68 // generated classes
69 
70 
71 /** @addtogroup dataspec_NCBI_Plugin
72  *
73  * @{
74  */
75 
76 /////////////////////////////////////////////////////////////////////////////
77 ///-
78 ///- PluginArg defines the properties of a given argument
79 ///-
80 ///
81 /// CPluginArg_Base --
82 ///
83 
85 {
87 public:
88  // constructor
89  CPluginArg_Base(void);
90  // destructor
91  virtual ~CPluginArg_Base(void);
92 
93  // type info
95 
96  /////////////////////////////////////////////////////////////////////////////
97  ///
98  /// C_Data --
99  ///
100 
102  {
104  public:
105  // constructor
106  C_Data(void);
107  // destructor
108  ~C_Data(void);
109 
110  // type info
112 
113 
114  /// Choice variants.
115  enum E_Choice {
116  e_not_set = 0, ///< No variant selected
118  e_Array
119  };
120  /// Maximum+1 value of the choice variant enumerator.
122  e_MaxChoice = 3 ///< == e_Array+1
123  };
124 
125  /// Reset the whole object
126  void Reset(void);
127 
128  /// Reset the selection (set it to e_not_set).
129  void ResetSelection(void);
130 
131  /// Which variant is currently selected.
132  ///
133  /// @return
134  /// Choice state enumerator.
135  E_Choice Which(void) const;
136 
137  /// Verify selection, throw exception if it differs from the expected.
138  ///
139  /// @param index
140  /// Expected selection.
141  void CheckSelected(E_Choice index) const;
142 
143  /// Throw 'InvalidSelection' exception.
144  ///
145  /// @param index
146  /// Expected selection.
147  NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
148 
149  /// Retrieve selection name (for diagnostic purposes).
150  ///
151  /// @param index
152  /// One of possible selection states.
153  /// @return
154  /// Name string.
155  static string SelectionName(E_Choice index);
156 
157  /// Select the requested variant if needed.
158  ///
159  /// @param index
160  /// New selection state.
161  /// @param reset
162  /// Flag that defines the resetting of the variant data. The data will
163  /// be reset if either the current selection differs from the new one,
164  /// or the flag is set to eDoResetVariant.
166  /// Select the requested variant if needed,
167  /// allocating CObject variants from memory pool.
168  void Select(E_Choice index,
169  EResetVariant reset,
170  CObjectMemoryPool* pool);
171 
172  // types
174  typedef list< CRef< CPluginValue > > TArray;
175 
176  // getters
177  // setters
178 
179 
180  /// Check if variant Single is selected.
181  ///
182  /// Single type is defined as 'typedef CPluginValue TSingle'.
183  /// @return
184  /// - true, if the variant is selected.
185  /// - false, otherwise.
186  bool IsSingle(void) const;
187 
188  /// Get the variant data.
189  ///
190  /// @return
191  /// Reference to the data.
192  const TSingle& GetSingle(void) const;
193 
194  /// Select the variant.
195  ///
196  /// @return
197  /// Reference to the variant data.
198  TSingle& SetSingle(void);
199  /// Select the variant and set its data.
200  ///
201  /// @param value
202  /// Reference to the data.
203  void SetSingle(TSingle& value);
204 
205 
206  /// Check if variant Array is selected.
207  ///
208  /// Array type is defined as 'typedef list< CRef< CPluginValue > > TArray'.
209  /// @return
210  /// - true, if the variant is selected.
211  /// - false, otherwise.
212  bool IsArray(void) const;
213 
214  /// Get the variant data.
215  ///
216  /// @return
217  /// Reference to the data.
218  const TArray& GetArray(void) const;
219 
220  /// Select the variant.
221  ///
222  /// @return
223  /// Reference to the variant data.
224  TArray& SetArray(void);
225 
226 
227  private:
228  // copy constructor and assignment operator
229  C_Data(const C_Data& );
231  // choice state
233  // helper methods
234  void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
235 
236  static const char* const sm_SelectionNames[];
237  // data
238  union {
239  NCBI_NS_NCBI::CUnionBuffer<TArray> m_Array;
240  NCBI_NS_NCBI::CSerialObject *m_object;
241  };
242  };
243  // types
244  typedef string TName;
245  typedef string TDesc;
246  typedef string TLong_desc;
247  typedef bool TOptional;
248  typedef bool TDefault;
249  typedef bool THidden;
250  typedef C_Data TData;
251  typedef list< CRef< CPluginValueConstraint > > TConstraint;
252 
253  // member index
254  enum class E_memberIndex {
255  e__allMandatory = 0,
256  e_name,
257  e_desc,
258  e_long_desc,
259  e_optional,
260  e_default,
261  e_hidden,
262  e_data,
263  e_constraint
264  };
266 
267  // getters
268  // setters
269 
270  /// Check if a value has been assigned to Name data member.
271  ///
272  /// Data member Name is mandatory;
273  /// its type is defined as 'typedef string TName'
274  /// @return
275  /// - true, if a value has been assigned.
276  /// - false, otherwise.
277  bool IsSetName(void) const;
278 
279  /// Check if it is safe to call GetName method.
280  ///
281  /// @return
282  /// - true, if the data member is getatable.
283  /// - false, otherwise.
284  bool CanGetName(void) const;
285 
286  /// Reset Name data member.
287  void ResetName(void);
288 
289  /// Get the Name member data.
290  ///
291  /// @return
292  /// Reference to the member data.
293  const TName& GetName(void) const;
294 
295  /// Assign a value to Name data member.
296  ///
297  /// @param value
298  /// Value to assign
299  void SetName(const TName& value);
300  void SetName(TName&& value);
301 
302  /// Assign a value to Name data member.
303  ///
304  /// @return
305  /// Reference to the data value.
306  TName& SetName(void);
307 
308  /// Check if a value has been assigned to Desc data member.
309  ///
310  /// Data member Desc is optional;
311  /// its type is defined as 'typedef string TDesc'
312  /// @return
313  /// - true, if a value has been assigned.
314  /// - false, otherwise.
315  bool IsSetDesc(void) const;
316 
317  /// Check if it is safe to call GetDesc method.
318  ///
319  /// @return
320  /// - true, if the data member is getatable.
321  /// - false, otherwise.
322  bool CanGetDesc(void) const;
323 
324  /// Reset Desc data member.
325  void ResetDesc(void);
326 
327  /// Get the Desc member data.
328  ///
329  /// @return
330  /// Reference to the member data.
331  const TDesc& GetDesc(void) const;
332 
333  /// Assign a value to Desc data member.
334  ///
335  /// @param value
336  /// Value to assign
337  void SetDesc(const TDesc& value);
338  void SetDesc(TDesc&& value);
339 
340  /// Assign a value to Desc data member.
341  ///
342  /// @return
343  /// Reference to the data value.
344  TDesc& SetDesc(void);
345 
346  /// Check if a value has been assigned to Long_desc data member.
347  ///
348  /// Data member Long_desc is optional;
349  /// its type is defined as 'typedef string TLong_desc'
350  /// @return
351  /// - true, if a value has been assigned.
352  /// - false, otherwise.
353  bool IsSetLong_desc(void) const;
354 
355  /// Check if it is safe to call GetLong_desc method.
356  ///
357  /// @return
358  /// - true, if the data member is getatable.
359  /// - false, otherwise.
360  bool CanGetLong_desc(void) const;
361 
362  /// Reset Long_desc data member.
363  void ResetLong_desc(void);
364 
365  /// Get the Long_desc member data.
366  ///
367  /// @return
368  /// Reference to the member data.
369  const TLong_desc& GetLong_desc(void) const;
370 
371  /// Assign a value to Long_desc data member.
372  ///
373  /// @param value
374  /// Value to assign
375  void SetLong_desc(const TLong_desc& value);
376  void SetLong_desc(TLong_desc&& value);
377 
378  /// Assign a value to Long_desc data member.
379  ///
380  /// @return
381  /// Reference to the data value.
382  TLong_desc& SetLong_desc(void);
383 
384  /// Check if a value has been assigned to Optional data member.
385  ///
386  /// Data member Optional is optional with default false;
387  /// its type is defined as 'typedef bool TOptional'
388  /// @return
389  /// - true, if a value has been assigned.
390  /// - false, otherwise.
391  bool IsSetOptional(void) const;
392 
393  /// Check if it is safe to call GetOptional method.
394  ///
395  /// @return
396  /// - true, if the data member is getatable.
397  /// - false, otherwise.
398  bool CanGetOptional(void) const;
399 
400  /// Reset Optional data member.
401  void ResetOptional(void);
402 
403  /// Assign default value to Optional data member.
404  void SetDefaultOptional(void);
405 
406  /// Get the Optional member data.
407  ///
408  /// @return
409  /// Copy of the member data.
410  TOptional GetOptional(void) const;
411 
412  /// Assign a value to Optional data member.
413  ///
414  /// @param value
415  /// Value to assign
416  void SetOptional(TOptional value);
417 
418  /// Assign a value to Optional data member.
419  ///
420  /// @return
421  /// Reference to the data value.
422  TOptional& SetOptional(void);
423 
424  /// Check if a value has been assigned to Default data member.
425  ///
426  /// Data member Default is optional with default false;
427  /// its type is defined as 'typedef bool TDefault'
428  /// @return
429  /// - true, if a value has been assigned.
430  /// - false, otherwise.
431  bool IsSetDefault(void) const;
432 
433  /// Check if it is safe to call GetDefault method.
434  ///
435  /// @return
436  /// - true, if the data member is getatable.
437  /// - false, otherwise.
438  bool CanGetDefault(void) const;
439 
440  /// Reset Default data member.
441  void ResetDefault(void);
442 
443  /// Assign default value to Default data member.
444  void SetDefaultDefault(void);
445 
446  /// Get the Default member data.
447  ///
448  /// @return
449  /// Copy of the member data.
450  TDefault GetDefault(void) const;
451 
452  /// Assign a value to Default data member.
453  ///
454  /// @param value
455  /// Value to assign
456  void SetDefault(TDefault value);
457 
458  /// Assign a value to Default data member.
459  ///
460  /// @return
461  /// Reference to the data value.
462  TDefault& SetDefault(void);
463 
464  /// Check if a value has been assigned to Hidden data member.
465  ///
466  /// Data member Hidden is optional with default false;
467  /// its type is defined as 'typedef bool THidden'
468  /// @return
469  /// - true, if a value has been assigned.
470  /// - false, otherwise.
471  bool IsSetHidden(void) const;
472 
473  /// Check if it is safe to call GetHidden method.
474  ///
475  /// @return
476  /// - true, if the data member is getatable.
477  /// - false, otherwise.
478  bool CanGetHidden(void) const;
479 
480  /// Reset Hidden data member.
481  void ResetHidden(void);
482 
483  /// Assign default value to Hidden data member.
484  void SetDefaultHidden(void);
485 
486  /// Get the Hidden member data.
487  ///
488  /// @return
489  /// Copy of the member data.
490  THidden GetHidden(void) const;
491 
492  /// Assign a value to Hidden data member.
493  ///
494  /// @param value
495  /// Value to assign
496  void SetHidden(THidden value);
497 
498  /// Assign a value to Hidden data member.
499  ///
500  /// @return
501  /// Reference to the data value.
502  THidden& SetHidden(void);
503 
504  /// Check if a value has been assigned to Data data member.
505  ///
506  /// Data member Data is mandatory;
507  /// its type is defined as 'typedef C_Data TData'
508  /// @return
509  /// - true, if a value has been assigned.
510  /// - false, otherwise.
511  bool IsSetData(void) const;
512 
513  /// Check if it is safe to call GetData method.
514  ///
515  /// @return
516  /// - true, if the data member is getatable.
517  /// - false, otherwise.
518  bool CanGetData(void) const;
519 
520  /// Reset Data data member.
521  void ResetData(void);
522 
523  /// Get the Data member data.
524  ///
525  /// @return
526  /// Reference to the member data.
527  const TData& GetData(void) const;
528 
529  /// Assign a value to Data data member.
530  ///
531  /// @param value
532  /// Reference to value.
533  void SetData(TData& value);
534 
535  /// Assign a value to Data data member.
536  ///
537  /// @return
538  /// Reference to the data value.
539  TData& SetData(void);
540 
541  /// Check if a value has been assigned to Constraint data member.
542  ///
543  /// Data member Constraint is optional;
544  /// its type is defined as 'typedef list< CRef< CPluginValueConstraint > > TConstraint'
545  /// @return
546  /// - true, if a value has been assigned.
547  /// - false, otherwise.
548  bool IsSetConstraint(void) const;
549 
550  /// Check if it is safe to call GetConstraint method.
551  ///
552  /// @return
553  /// - true, if the data member is getatable.
554  /// - false, otherwise.
555  bool CanGetConstraint(void) const;
556 
557  /// Reset Constraint data member.
558  void ResetConstraint(void);
559 
560  /// Get the Constraint member data.
561  ///
562  /// @return
563  /// Reference to the member data.
564  const TConstraint& GetConstraint(void) const;
565 
566  /// Assign a value to Constraint data member.
567  ///
568  /// @return
569  /// Reference to the data value.
570  TConstraint& SetConstraint(void);
571 
572  /// Reset the whole object
573  virtual void Reset(void);
574 
575 
576 private:
577  // Prohibit copy constructor and assignment operator
580 
581  // data
582  Uint4 m_set_State[1];
583  string m_Name;
584  string m_Desc;
585  string m_Long_desc;
587  bool m_Default;
588  bool m_Hidden;
590  list< CRef< CPluginValueConstraint > > m_Constraint;
591 };
592 
593 /* @} */
594 
595 
596 
597 
598 
599 ///////////////////////////////////////////////////////////
600 ///////////////////// inline methods //////////////////////
601 ///////////////////////////////////////////////////////////
602 inline
604 {
605  return m_choice;
606 }
607 
608 inline
610 {
611  if ( m_choice != index )
612  ThrowInvalidSelection(index);
613 }
614 
615 inline
616 void CPluginArg_Base::C_Data::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
617 {
618  if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
619  if ( m_choice != e_not_set )
620  ResetSelection();
621  DoSelect(index, pool);
622  }
623 }
624 
625 inline
627 {
628  Select(index, reset, 0);
629 }
630 
631 inline
633 {
634  return m_choice == e_Single;
635 }
636 
637 inline
639 {
640  return m_choice == e_Array;
641 }
642 
643 inline
645 {
646  CheckSelected(e_Array);
647  return *m_Array;
648 }
649 
650 inline
652 {
653  Select(e_Array, NCBI_NS_NCBI::eDoNotResetVariant);
654  return *m_Array;
655 }
656 
657 inline
659 {
660  return ((m_set_State[0] & 0x3) != 0);
661 }
662 
663 inline
665 {
666  return IsSetName();
667 }
668 
669 inline
671 {
672  if (!CanGetName()) {
673  ThrowUnassigned(0);
674  }
675  return m_Name;
676 }
677 
678 inline
680 {
681  m_Name = value;
682  m_set_State[0] |= 0x3;
683 }
684 
685 inline
687 {
688  m_Name = std::forward<CPluginArg_Base::TName>(value);
689  m_set_State[0] |= 0x3;
690 }
691 
692 inline
694 {
695 #ifdef _DEBUG
696  if (!IsSetName()) {
698  }
699 #endif
700  m_set_State[0] |= 0x1;
701  return m_Name;
702 }
703 
704 inline
706 {
707  return ((m_set_State[0] & 0xc) != 0);
708 }
709 
710 inline
712 {
713  return IsSetDesc();
714 }
715 
716 inline
718 {
719  if (!CanGetDesc()) {
720  ThrowUnassigned(1);
721  }
722  return m_Desc;
723 }
724 
725 inline
727 {
728  m_Desc = value;
729  m_set_State[0] |= 0xc;
730 }
731 
732 inline
734 {
735  m_Desc = std::forward<CPluginArg_Base::TDesc>(value);
736  m_set_State[0] |= 0xc;
737 }
738 
739 inline
741 {
742 #ifdef _DEBUG
743  if (!IsSetDesc()) {
745  }
746 #endif
747  m_set_State[0] |= 0x4;
748  return m_Desc;
749 }
750 
751 inline
753 {
754  return ((m_set_State[0] & 0x30) != 0);
755 }
756 
757 inline
759 {
760  return IsSetLong_desc();
761 }
762 
763 inline
765 {
766  if (!CanGetLong_desc()) {
767  ThrowUnassigned(2);
768  }
769  return m_Long_desc;
770 }
771 
772 inline
774 {
775  m_Long_desc = value;
776  m_set_State[0] |= 0x30;
777 }
778 
779 inline
781 {
782  m_Long_desc = std::forward<CPluginArg_Base::TLong_desc>(value);
783  m_set_State[0] |= 0x30;
784 }
785 
786 inline
788 {
789 #ifdef _DEBUG
790  if (!IsSetLong_desc()) {
792  }
793 #endif
794  m_set_State[0] |= 0x10;
795  return m_Long_desc;
796 }
797 
798 inline
800 {
801  return ((m_set_State[0] & 0xc0) != 0);
802 }
803 
804 inline
806 {
807  return true;
808 }
809 
810 inline
812 {
813  m_Optional = false;
814  m_set_State[0] &= ~0xc0;
815 }
816 
817 inline
819 {
820  ResetOptional();
821 }
822 
823 inline
825 {
826  return m_Optional;
827 }
828 
829 inline
831 {
832  m_Optional = value;
833  m_set_State[0] |= 0xc0;
834 }
835 
836 inline
838 {
839 #ifdef _DEBUG
840  if (!IsSetOptional()) {
841  memset(&m_Optional,UnassignedByte(),sizeof(m_Optional));
842  }
843 #endif
844  m_set_State[0] |= 0x40;
845  return m_Optional;
846 }
847 
848 inline
850 {
851  return ((m_set_State[0] & 0x300) != 0);
852 }
853 
854 inline
856 {
857  return true;
858 }
859 
860 inline
862 {
863  m_Default = false;
864  m_set_State[0] &= ~0x300;
865 }
866 
867 inline
869 {
870  ResetDefault();
871 }
872 
873 inline
875 {
876  return m_Default;
877 }
878 
879 inline
881 {
882  m_Default = value;
883  m_set_State[0] |= 0x300;
884 }
885 
886 inline
888 {
889 #ifdef _DEBUG
890  if (!IsSetDefault()) {
891  memset(&m_Default,UnassignedByte(),sizeof(m_Default));
892  }
893 #endif
894  m_set_State[0] |= 0x100;
895  return m_Default;
896 }
897 
898 inline
900 {
901  return ((m_set_State[0] & 0xc00) != 0);
902 }
903 
904 inline
906 {
907  return true;
908 }
909 
910 inline
912 {
913  m_Hidden = false;
914  m_set_State[0] &= ~0xc00;
915 }
916 
917 inline
919 {
920  ResetHidden();
921 }
922 
923 inline
925 {
926  return m_Hidden;
927 }
928 
929 inline
931 {
932  m_Hidden = value;
933  m_set_State[0] |= 0xc00;
934 }
935 
936 inline
938 {
939 #ifdef _DEBUG
940  if (!IsSetHidden()) {
941  memset(&m_Hidden,UnassignedByte(),sizeof(m_Hidden));
942  }
943 #endif
944  m_set_State[0] |= 0x400;
945  return m_Hidden;
946 }
947 
948 inline
950 {
951  return m_Data.NotEmpty();
952 }
953 
954 inline
956 {
957  return true;
958 }
959 
960 inline
962 {
963  if ( !m_Data ) {
964  const_cast<CPluginArg_Base*>(this)->ResetData();
965  }
966  return (*m_Data);
967 }
968 
969 inline
971 {
972  if ( !m_Data ) {
973  ResetData();
974  }
975  return (*m_Data);
976 }
977 
978 inline
980 {
981  return ((m_set_State[0] & 0xc000) != 0);
982 }
983 
984 inline
986 {
987  return true;
988 }
989 
990 inline
992 {
993  return m_Constraint;
994 }
995 
996 inline
998 {
999  m_set_State[0] |= 0x4000;
1000  return m_Constraint;
1001 }
1002 
1003 ///////////////////////////////////////////////////////////
1004 ////////////////// end of inline methods //////////////////
1005 ///////////////////////////////////////////////////////////
1006 
1007 
1008 
1009 
1010 
1011 END_objects_SCOPE // namespace ncbi::objects::
1012 
1014 
1015 
1016 #endif // GUI_OBJECTS_PLUGINARG_BASE_HPP
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
static string UnassignedString(void)
Definition: serialbase.hpp:175
@ eDoResetVariant
Definition: serialbase.hpp:77
@ eDoNotResetVariant
Definition: serialbase.hpp:78
bool NotEmpty(void) const THROWS_NONE
Check if CRef is not empty – pointing to an object and has a non-null value.
Definition: ncbiobj.hpp:726
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
#define NCBI_GUIOBJECTS_EXPORT
Definition: gui_export.h:511
bool IsSetHidden(void) const
Check if a value has been assigned to Hidden data member.
Definition: PluginArg_.hpp:899
CRef< TData > m_Data
Definition: PluginArg_.hpp:589
bool CanGetDesc(void) const
Check if it is safe to call GetDesc method.
Definition: PluginArg_.hpp:711
bool IsSetOptional(void) const
Check if a value has been assigned to Optional data member.
Definition: PluginArg_.hpp:799
bool CanGetDefault(void) const
Check if it is safe to call GetDefault method.
Definition: PluginArg_.hpp:855
bool IsSetDesc(void) const
Check if a value has been assigned to Desc data member.
Definition: PluginArg_.hpp:705
E_ChoiceStopper
Maximum+1 value of the choice variant enumerator.
Definition: PluginArg_.hpp:121
const TName & GetName(void) const
Get the Name member data.
Definition: PluginArg_.hpp:670
TDefault GetDefault(void) const
Get the Default member data.
Definition: PluginArg_.hpp:874
bool CanGetHidden(void) const
Check if it is safe to call GetHidden method.
Definition: PluginArg_.hpp:905
TDesc & SetDesc(void)
Assign a value to Desc data member.
Definition: PluginArg_.hpp:740
CSerialObject Tparent
Definition: PluginArg_.hpp:86
TLong_desc & SetLong_desc(void)
Assign a value to Long_desc data member.
Definition: PluginArg_.hpp:787
bool CanGetName(void) const
Check if it is safe to call GetName method.
Definition: PluginArg_.hpp:664
bool IsArray(void) const
Check if variant Array is selected.
Definition: PluginArg_.hpp:638
bool CanGetData(void) const
Check if it is safe to call GetData method.
Definition: PluginArg_.hpp:955
TConstraint & SetConstraint(void)
Assign a value to Constraint data member.
Definition: PluginArg_.hpp:997
void ResetOptional(void)
Reset Optional data member.
Definition: PluginArg_.hpp:811
void ResetHidden(void)
Reset Hidden data member.
Definition: PluginArg_.hpp:911
const TConstraint & GetConstraint(void) const
Get the Constraint member data.
Definition: PluginArg_.hpp:991
void CheckSelected(E_Choice index) const
Verify selection, throw exception if it differs from the expected.
Definition: PluginArg_.hpp:609
const TLong_desc & GetLong_desc(void) const
Get the Long_desc member data.
Definition: PluginArg_.hpp:764
list< CRef< CPluginValueConstraint > > TConstraint
Definition: PluginArg_.hpp:251
TDefault & SetDefault(void)
Assign a value to Default data member.
Definition: PluginArg_.hpp:887
list< CRef< CPluginValueConstraint > > m_Constraint
Definition: PluginArg_.hpp:590
const TArray & GetArray(void) const
Get the variant data.
Definition: PluginArg_.hpp:644
CPluginArg_Base(const CPluginArg_Base &)
CPluginArg_Base & operator=(const CPluginArg_Base &)
Tparent::CMemberIndex< E_memberIndex, 9 > TmemberIndex
Definition: PluginArg_.hpp:265
Uint4 m_set_State[1]
Definition: PluginArg_.hpp:582
C_Data & operator=(const C_Data &)
void SetDefaultDefault(void)
Assign default value to Default data member.
Definition: PluginArg_.hpp:868
void SetDefaultOptional(void)
Assign default value to Optional data member.
Definition: PluginArg_.hpp:818
void ResetData(void)
Reset Data data member.
Definition: PluginArg_.cpp:171
void ResetDefault(void)
Reset Default data member.
Definition: PluginArg_.hpp:861
TData & SetData(void)
Assign a value to Data data member.
Definition: PluginArg_.hpp:970
void SetDefaultHidden(void)
Assign default value to Hidden data member.
Definition: PluginArg_.hpp:918
bool IsSetConstraint(void) const
Check if a value has been assigned to Constraint data member.
Definition: PluginArg_.hpp:979
TName & SetName(void)
Assign a value to Name data member.
Definition: PluginArg_.hpp:693
void Select(E_Choice index, EResetVariant reset=eDoResetVariant)
Select the requested variant if needed.
NCBI_NS_NCBI::CUnionBuffer< TArray > m_Array
Definition: PluginArg_.hpp:239
bool IsSetData(void) const
Check if a value has been assigned to Data data member.
Definition: PluginArg_.hpp:949
THidden & SetHidden(void)
Assign a value to Hidden data member.
Definition: PluginArg_.hpp:937
TArray & SetArray(void)
Select the variant.
Definition: PluginArg_.hpp:651
E_Choice
Choice variants.
Definition: PluginArg_.hpp:115
void Select(E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
Select the requested variant if needed, allocating CObject variants from memory pool.
bool IsSetDefault(void) const
Check if a value has been assigned to Default data member.
Definition: PluginArg_.hpp:849
C_Data(const C_Data &)
bool IsSetLong_desc(void) const
Check if a value has been assigned to Long_desc data member.
Definition: PluginArg_.hpp:752
bool IsSetName(void) const
Check if a value has been assigned to Name data member.
Definition: PluginArg_.hpp:658
bool CanGetConstraint(void) const
Check if it is safe to call GetConstraint method.
Definition: PluginArg_.hpp:985
TOptional & SetOptional(void)
Assign a value to Optional data member.
Definition: PluginArg_.hpp:837
bool CanGetLong_desc(void) const
Check if it is safe to call GetLong_desc method.
Definition: PluginArg_.hpp:758
THidden GetHidden(void) const
Get the Hidden member data.
Definition: PluginArg_.hpp:924
bool CanGetOptional(void) const
Check if it is safe to call GetOptional method.
Definition: PluginArg_.hpp:805
const TDesc & GetDesc(void) const
Get the Desc member data.
Definition: PluginArg_.hpp:717
E_Choice Which(void) const
Which variant is currently selected.
Definition: PluginArg_.hpp:603
NCBI_NS_NCBI::CSerialObject * m_object
Definition: PluginArg_.hpp:240
TOptional GetOptional(void) const
Get the Optional member data.
Definition: PluginArg_.hpp:824
const TData & GetData(void) const
Get the Data member data.
Definition: PluginArg_.hpp:961
bool IsSingle(void) const
Check if variant Single is selected.
Definition: PluginArg_.hpp:632
list< CRef< CPluginValue > > TArray
Definition: PluginArg_.hpp:174
Defines to provide correct exporting from DLLs in Windows.
@ e_not_set
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sat Jul 20 11:13:22 2024 by modify_doxy.py rev. 669887