NCBI C++ ToolKit
String_constraint_.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 String_constraint_.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/macro/macro.asn">macro.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/macro/macro.def">macro.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_MACRO_STRING_CONSTRAINT_BASE_HPP
42 #define OBJECTS_MACRO_STRING_CONSTRAINT_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 
60 // forward declarations
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_Macro
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 ///
74 /// CString_constraint_Base --
75 ///
76 
78 {
80 public:
81  // constructor
83  // destructor
84  virtual ~CString_constraint_Base(void);
85 
86  // type info
88 
89  // types
90  typedef string TMatch_text;
92  typedef bool TCase_sensitive;
93  typedef bool TIgnore_space;
94  typedef bool TIgnore_punct;
96  typedef bool TWhole_word;
97  typedef bool TNot_present;
98  typedef bool TIs_all_caps;
99  typedef bool TIs_all_lower;
100  typedef bool TIs_all_punct;
101  typedef bool TIgnore_weasel;
102  typedef bool TIs_first_cap;
103  typedef bool TIs_first_each_cap;
104 
105  // member index
106  enum class E_memberIndex {
107  e__allMandatory = 0,
108  e_match_text,
114  e_whole_word,
122  };
124 
125  // getters
126  // setters
127 
128  /// Check if a value has been assigned to Match_text data member.
129  ///
130  /// Data member Match_text is optional;
131  /// its type is defined as 'typedef string TMatch_text'
132  /// @return
133  /// - true, if a value has been assigned.
134  /// - false, otherwise.
135  bool IsSetMatch_text(void) const;
136 
137  /// Check if it is safe to call GetMatch_text method.
138  ///
139  /// @return
140  /// - true, if the data member is getatable.
141  /// - false, otherwise.
142  bool CanGetMatch_text(void) const;
143 
144  /// Reset Match_text data member.
145  void ResetMatch_text(void);
146 
147  /// Get the Match_text member data.
148  ///
149  /// @return
150  /// Reference to the member data.
151  const TMatch_text& GetMatch_text(void) const;
152 
153  /// Assign a value to Match_text data member.
154  ///
155  /// @param value
156  /// Value to assign
157  void SetMatch_text(const TMatch_text& value);
159 
160  /// Assign a value to Match_text data member.
161  ///
162  /// @return
163  /// Reference to the data value.
164  TMatch_text& SetMatch_text(void);
165 
166  /// Check if a value has been assigned to Match_location data member.
167  ///
168  /// Data member Match_location is optional with default eString_location_contains;
169  /// its type is defined as 'typedef EString_location TMatch_location'
170  /// @return
171  /// - true, if a value has been assigned.
172  /// - false, otherwise.
173  bool IsSetMatch_location(void) const;
174 
175  /// Check if it is safe to call GetMatch_location method.
176  ///
177  /// @return
178  /// - true, if the data member is getatable.
179  /// - false, otherwise.
180  bool CanGetMatch_location(void) const;
181 
182  /// Reset Match_location data member.
183  void ResetMatch_location(void);
184 
185  /// Assign default value to Match_location data member.
186  void SetDefaultMatch_location(void);
187 
188  /// Get the Match_location member data.
189  ///
190  /// @return
191  /// Copy of the member data.
193 
194  /// Assign a value to Match_location data member.
195  ///
196  /// @param value
197  /// Value to assign
199 
200  /// Assign a value to Match_location data member.
201  ///
202  /// @return
203  /// Reference to the data value.
205 
206  /// Check if a value has been assigned to Case_sensitive data member.
207  ///
208  /// Data member Case_sensitive is optional with default false;
209  /// its type is defined as 'typedef bool TCase_sensitive'
210  /// @return
211  /// - true, if a value has been assigned.
212  /// - false, otherwise.
213  bool IsSetCase_sensitive(void) const;
214 
215  /// Check if it is safe to call GetCase_sensitive method.
216  ///
217  /// @return
218  /// - true, if the data member is getatable.
219  /// - false, otherwise.
220  bool CanGetCase_sensitive(void) const;
221 
222  /// Reset Case_sensitive data member.
223  void ResetCase_sensitive(void);
224 
225  /// Assign default value to Case_sensitive data member.
226  void SetDefaultCase_sensitive(void);
227 
228  /// Get the Case_sensitive member data.
229  ///
230  /// @return
231  /// Copy of the member data.
233 
234  /// Assign a value to Case_sensitive data member.
235  ///
236  /// @param value
237  /// Value to assign
239 
240  /// Assign a value to Case_sensitive data member.
241  ///
242  /// @return
243  /// Reference to the data value.
245 
246  /// Check if a value has been assigned to Ignore_space data member.
247  ///
248  /// Data member Ignore_space is optional with default false;
249  /// its type is defined as 'typedef bool TIgnore_space'
250  /// @return
251  /// - true, if a value has been assigned.
252  /// - false, otherwise.
253  bool IsSetIgnore_space(void) const;
254 
255  /// Check if it is safe to call GetIgnore_space method.
256  ///
257  /// @return
258  /// - true, if the data member is getatable.
259  /// - false, otherwise.
260  bool CanGetIgnore_space(void) const;
261 
262  /// Reset Ignore_space data member.
263  void ResetIgnore_space(void);
264 
265  /// Assign default value to Ignore_space data member.
266  void SetDefaultIgnore_space(void);
267 
268  /// Get the Ignore_space member data.
269  ///
270  /// @return
271  /// Copy of the member data.
272  TIgnore_space GetIgnore_space(void) const;
273 
274  /// Assign a value to Ignore_space data member.
275  ///
276  /// @param value
277  /// Value to assign
279 
280  /// Assign a value to Ignore_space data member.
281  ///
282  /// @return
283  /// Reference to the data value.
285 
286  /// Check if a value has been assigned to Ignore_punct data member.
287  ///
288  /// Data member Ignore_punct is optional with default false;
289  /// its type is defined as 'typedef bool TIgnore_punct'
290  /// @return
291  /// - true, if a value has been assigned.
292  /// - false, otherwise.
293  bool IsSetIgnore_punct(void) const;
294 
295  /// Check if it is safe to call GetIgnore_punct method.
296  ///
297  /// @return
298  /// - true, if the data member is getatable.
299  /// - false, otherwise.
300  bool CanGetIgnore_punct(void) const;
301 
302  /// Reset Ignore_punct data member.
303  void ResetIgnore_punct(void);
304 
305  /// Assign default value to Ignore_punct data member.
306  void SetDefaultIgnore_punct(void);
307 
308  /// Get the Ignore_punct member data.
309  ///
310  /// @return
311  /// Copy of the member data.
312  TIgnore_punct GetIgnore_punct(void) const;
313 
314  /// Assign a value to Ignore_punct data member.
315  ///
316  /// @param value
317  /// Value to assign
319 
320  /// Assign a value to Ignore_punct data member.
321  ///
322  /// @return
323  /// Reference to the data value.
325 
326  /// Check if a value has been assigned to Ignore_words data member.
327  ///
328  /// Data member Ignore_words is optional;
329  /// its type is defined as 'typedef CWord_substitution_set TIgnore_words'
330  /// @return
331  /// - true, if a value has been assigned.
332  /// - false, otherwise.
333  bool IsSetIgnore_words(void) const;
334 
335  /// Check if it is safe to call GetIgnore_words method.
336  ///
337  /// @return
338  /// - true, if the data member is getatable.
339  /// - false, otherwise.
340  bool CanGetIgnore_words(void) const;
341 
342  /// Reset Ignore_words data member.
343  void ResetIgnore_words(void);
344 
345  /// Get the Ignore_words member data.
346  ///
347  /// @return
348  /// Reference to the member data.
349  const TIgnore_words& GetIgnore_words(void) const;
350 
351  /// Assign a value to Ignore_words data member.
352  ///
353  /// @param value
354  /// Reference to value.
356 
357  /// Assign a value to Ignore_words data member.
358  ///
359  /// @return
360  /// Reference to the data value.
362 
363  /// Check if a value has been assigned to Whole_word data member.
364  ///
365  /// Data member Whole_word is optional with default false;
366  /// its type is defined as 'typedef bool TWhole_word'
367  /// @return
368  /// - true, if a value has been assigned.
369  /// - false, otherwise.
370  bool IsSetWhole_word(void) const;
371 
372  /// Check if it is safe to call GetWhole_word method.
373  ///
374  /// @return
375  /// - true, if the data member is getatable.
376  /// - false, otherwise.
377  bool CanGetWhole_word(void) const;
378 
379  /// Reset Whole_word data member.
380  void ResetWhole_word(void);
381 
382  /// Assign default value to Whole_word data member.
383  void SetDefaultWhole_word(void);
384 
385  /// Get the Whole_word member data.
386  ///
387  /// @return
388  /// Copy of the member data.
389  TWhole_word GetWhole_word(void) const;
390 
391  /// Assign a value to Whole_word data member.
392  ///
393  /// @param value
394  /// Value to assign
396 
397  /// Assign a value to Whole_word data member.
398  ///
399  /// @return
400  /// Reference to the data value.
401  TWhole_word& SetWhole_word(void);
402 
403  /// Check if a value has been assigned to Not_present data member.
404  ///
405  /// Data member Not_present is optional with default false;
406  /// its type is defined as 'typedef bool TNot_present'
407  /// @return
408  /// - true, if a value has been assigned.
409  /// - false, otherwise.
410  bool IsSetNot_present(void) const;
411 
412  /// Check if it is safe to call GetNot_present method.
413  ///
414  /// @return
415  /// - true, if the data member is getatable.
416  /// - false, otherwise.
417  bool CanGetNot_present(void) const;
418 
419  /// Reset Not_present data member.
420  void ResetNot_present(void);
421 
422  /// Assign default value to Not_present data member.
423  void SetDefaultNot_present(void);
424 
425  /// Get the Not_present member data.
426  ///
427  /// @return
428  /// Copy of the member data.
429  TNot_present GetNot_present(void) const;
430 
431  /// Assign a value to Not_present data member.
432  ///
433  /// @param value
434  /// Value to assign
436 
437  /// Assign a value to Not_present data member.
438  ///
439  /// @return
440  /// Reference to the data value.
442 
443  /// Check if a value has been assigned to Is_all_caps data member.
444  ///
445  /// Data member Is_all_caps is optional with default false;
446  /// its type is defined as 'typedef bool TIs_all_caps'
447  /// @return
448  /// - true, if a value has been assigned.
449  /// - false, otherwise.
450  bool IsSetIs_all_caps(void) const;
451 
452  /// Check if it is safe to call GetIs_all_caps method.
453  ///
454  /// @return
455  /// - true, if the data member is getatable.
456  /// - false, otherwise.
457  bool CanGetIs_all_caps(void) const;
458 
459  /// Reset Is_all_caps data member.
460  void ResetIs_all_caps(void);
461 
462  /// Assign default value to Is_all_caps data member.
463  void SetDefaultIs_all_caps(void);
464 
465  /// Get the Is_all_caps member data.
466  ///
467  /// @return
468  /// Copy of the member data.
469  TIs_all_caps GetIs_all_caps(void) const;
470 
471  /// Assign a value to Is_all_caps data member.
472  ///
473  /// @param value
474  /// Value to assign
476 
477  /// Assign a value to Is_all_caps data member.
478  ///
479  /// @return
480  /// Reference to the data value.
482 
483  /// Check if a value has been assigned to Is_all_lower data member.
484  ///
485  /// Data member Is_all_lower is optional with default false;
486  /// its type is defined as 'typedef bool TIs_all_lower'
487  /// @return
488  /// - true, if a value has been assigned.
489  /// - false, otherwise.
490  bool IsSetIs_all_lower(void) const;
491 
492  /// Check if it is safe to call GetIs_all_lower method.
493  ///
494  /// @return
495  /// - true, if the data member is getatable.
496  /// - false, otherwise.
497  bool CanGetIs_all_lower(void) const;
498 
499  /// Reset Is_all_lower data member.
500  void ResetIs_all_lower(void);
501 
502  /// Assign default value to Is_all_lower data member.
503  void SetDefaultIs_all_lower(void);
504 
505  /// Get the Is_all_lower member data.
506  ///
507  /// @return
508  /// Copy of the member data.
509  TIs_all_lower GetIs_all_lower(void) const;
510 
511  /// Assign a value to Is_all_lower data member.
512  ///
513  /// @param value
514  /// Value to assign
516 
517  /// Assign a value to Is_all_lower data member.
518  ///
519  /// @return
520  /// Reference to the data value.
522 
523  /// Check if a value has been assigned to Is_all_punct data member.
524  ///
525  /// Data member Is_all_punct is optional with default false;
526  /// its type is defined as 'typedef bool TIs_all_punct'
527  /// @return
528  /// - true, if a value has been assigned.
529  /// - false, otherwise.
530  bool IsSetIs_all_punct(void) const;
531 
532  /// Check if it is safe to call GetIs_all_punct method.
533  ///
534  /// @return
535  /// - true, if the data member is getatable.
536  /// - false, otherwise.
537  bool CanGetIs_all_punct(void) const;
538 
539  /// Reset Is_all_punct data member.
540  void ResetIs_all_punct(void);
541 
542  /// Assign default value to Is_all_punct data member.
543  void SetDefaultIs_all_punct(void);
544 
545  /// Get the Is_all_punct member data.
546  ///
547  /// @return
548  /// Copy of the member data.
549  TIs_all_punct GetIs_all_punct(void) const;
550 
551  /// Assign a value to Is_all_punct data member.
552  ///
553  /// @param value
554  /// Value to assign
556 
557  /// Assign a value to Is_all_punct data member.
558  ///
559  /// @return
560  /// Reference to the data value.
562 
563  /// Check if a value has been assigned to Ignore_weasel data member.
564  ///
565  /// Data member Ignore_weasel is optional with default false;
566  /// its type is defined as 'typedef bool TIgnore_weasel'
567  /// @return
568  /// - true, if a value has been assigned.
569  /// - false, otherwise.
570  bool IsSetIgnore_weasel(void) const;
571 
572  /// Check if it is safe to call GetIgnore_weasel method.
573  ///
574  /// @return
575  /// - true, if the data member is getatable.
576  /// - false, otherwise.
577  bool CanGetIgnore_weasel(void) const;
578 
579  /// Reset Ignore_weasel data member.
580  void ResetIgnore_weasel(void);
581 
582  /// Assign default value to Ignore_weasel data member.
583  void SetDefaultIgnore_weasel(void);
584 
585  /// Get the Ignore_weasel member data.
586  ///
587  /// @return
588  /// Copy of the member data.
589  TIgnore_weasel GetIgnore_weasel(void) const;
590 
591  /// Assign a value to Ignore_weasel data member.
592  ///
593  /// @param value
594  /// Value to assign
596 
597  /// Assign a value to Ignore_weasel data member.
598  ///
599  /// @return
600  /// Reference to the data value.
602 
603  /// Check if a value has been assigned to Is_first_cap data member.
604  ///
605  /// Data member Is_first_cap is optional with default false;
606  /// its type is defined as 'typedef bool TIs_first_cap'
607  /// @return
608  /// - true, if a value has been assigned.
609  /// - false, otherwise.
610  bool IsSetIs_first_cap(void) const;
611 
612  /// Check if it is safe to call GetIs_first_cap method.
613  ///
614  /// @return
615  /// - true, if the data member is getatable.
616  /// - false, otherwise.
617  bool CanGetIs_first_cap(void) const;
618 
619  /// Reset Is_first_cap data member.
620  void ResetIs_first_cap(void);
621 
622  /// Assign default value to Is_first_cap data member.
623  void SetDefaultIs_first_cap(void);
624 
625  /// Get the Is_first_cap member data.
626  ///
627  /// @return
628  /// Copy of the member data.
629  TIs_first_cap GetIs_first_cap(void) const;
630 
631  /// Assign a value to Is_first_cap data member.
632  ///
633  /// @param value
634  /// Value to assign
636 
637  /// Assign a value to Is_first_cap data member.
638  ///
639  /// @return
640  /// Reference to the data value.
642 
643  /// Check if a value has been assigned to Is_first_each_cap data member.
644  ///
645  /// Data member Is_first_each_cap is optional with default false;
646  /// its type is defined as 'typedef bool TIs_first_each_cap'
647  /// @return
648  /// - true, if a value has been assigned.
649  /// - false, otherwise.
650  bool IsSetIs_first_each_cap(void) const;
651 
652  /// Check if it is safe to call GetIs_first_each_cap method.
653  ///
654  /// @return
655  /// - true, if the data member is getatable.
656  /// - false, otherwise.
657  bool CanGetIs_first_each_cap(void) const;
658 
659  /// Reset Is_first_each_cap data member.
660  void ResetIs_first_each_cap(void);
661 
662  /// Assign default value to Is_first_each_cap data member.
663  void SetDefaultIs_first_each_cap(void);
664 
665  /// Get the Is_first_each_cap member data.
666  ///
667  /// @return
668  /// Copy of the member data.
670 
671  /// Assign a value to Is_first_each_cap data member.
672  ///
673  /// @param value
674  /// Value to assign
676 
677  /// Assign a value to Is_first_each_cap data member.
678  ///
679  /// @return
680  /// Reference to the data value.
682 
683  /// Reset the whole object
684  virtual void Reset(void);
685 
686 
687 private:
688  // Prohibit copy constructor and assignment operator
691 
692  // data
694  string m_Match_text;
708 };
709 
710 /* @} */
711 
712 
713 
714 
715 
716 ///////////////////////////////////////////////////////////
717 ///////////////////// inline methods //////////////////////
718 ///////////////////////////////////////////////////////////
719 inline
721 {
722  return ((m_set_State[0] & 0x3) != 0);
723 }
724 
725 inline
727 {
728  return IsSetMatch_text();
729 }
730 
731 inline
733 {
734  if (!CanGetMatch_text()) {
735  ThrowUnassigned(0);
736  }
737  return m_Match_text;
738 }
739 
740 inline
742 {
744  m_set_State[0] |= 0x3;
745 }
746 
747 inline
749 {
750  m_Match_text = std::forward<CString_constraint_Base::TMatch_text>(value);
751  m_set_State[0] |= 0x3;
752 }
753 
754 inline
756 {
757 #ifdef _DEBUG
758  if (!IsSetMatch_text()) {
760  }
761 #endif
762  m_set_State[0] |= 0x1;
763  return m_Match_text;
764 }
765 
766 inline
768 {
769  return ((m_set_State[0] & 0xc) != 0);
770 }
771 
772 inline
774 {
775  return true;
776 }
777 
778 inline
780 {
782  m_set_State[0] &= ~0xc;
783 }
784 
785 inline
787 {
789 }
790 
791 inline
793 {
794  return m_Match_location;
795 }
796 
797 inline
799 {
801  m_set_State[0] |= 0xc;
802 }
803 
804 inline
806 {
807 #ifdef _DEBUG
808  if (!IsSetMatch_location()) {
810  }
811 #endif
812  m_set_State[0] |= 0x4;
813  return m_Match_location;
814 }
815 
816 inline
818 {
819  return ((m_set_State[0] & 0x30) != 0);
820 }
821 
822 inline
824 {
825  return true;
826 }
827 
828 inline
830 {
831  m_Case_sensitive = false;
832  m_set_State[0] &= ~0x30;
833 }
834 
835 inline
837 {
839 }
840 
841 inline
843 {
844  return m_Case_sensitive;
845 }
846 
847 inline
849 {
851  m_set_State[0] |= 0x30;
852 }
853 
854 inline
856 {
857 #ifdef _DEBUG
858  if (!IsSetCase_sensitive()) {
860  }
861 #endif
862  m_set_State[0] |= 0x10;
863  return m_Case_sensitive;
864 }
865 
866 inline
868 {
869  return ((m_set_State[0] & 0xc0) != 0);
870 }
871 
872 inline
874 {
875  return true;
876 }
877 
878 inline
880 {
881  m_Ignore_space = false;
882  m_set_State[0] &= ~0xc0;
883 }
884 
885 inline
887 {
889 }
890 
891 inline
893 {
894  return m_Ignore_space;
895 }
896 
897 inline
899 {
901  m_set_State[0] |= 0xc0;
902 }
903 
904 inline
906 {
907 #ifdef _DEBUG
908  if (!IsSetIgnore_space()) {
909  memset(&m_Ignore_space,UnassignedByte(),sizeof(m_Ignore_space));
910  }
911 #endif
912  m_set_State[0] |= 0x40;
913  return m_Ignore_space;
914 }
915 
916 inline
918 {
919  return ((m_set_State[0] & 0x300) != 0);
920 }
921 
922 inline
924 {
925  return true;
926 }
927 
928 inline
930 {
931  m_Ignore_punct = false;
932  m_set_State[0] &= ~0x300;
933 }
934 
935 inline
937 {
939 }
940 
941 inline
943 {
944  return m_Ignore_punct;
945 }
946 
947 inline
949 {
951  m_set_State[0] |= 0x300;
952 }
953 
954 inline
956 {
957 #ifdef _DEBUG
958  if (!IsSetIgnore_punct()) {
959  memset(&m_Ignore_punct,UnassignedByte(),sizeof(m_Ignore_punct));
960  }
961 #endif
962  m_set_State[0] |= 0x100;
963  return m_Ignore_punct;
964 }
965 
966 inline
968 {
969  return m_Ignore_words.NotEmpty();
970 }
971 
972 inline
974 {
975  return IsSetIgnore_words();
976 }
977 
978 inline
980 {
981  if (!CanGetIgnore_words()) {
982  ThrowUnassigned(5);
983  }
984  return (*m_Ignore_words);
985 }
986 
987 inline
989 {
990  return ((m_set_State[0] & 0x3000) != 0);
991 }
992 
993 inline
995 {
996  return true;
997 }
998 
999 inline
1001 {
1002  m_Whole_word = false;
1003  m_set_State[0] &= ~0x3000;
1004 }
1005 
1006 inline
1008 {
1009  ResetWhole_word();
1010 }
1011 
1012 inline
1014 {
1015  return m_Whole_word;
1016 }
1017 
1018 inline
1020 {
1021  m_Whole_word = value;
1022  m_set_State[0] |= 0x3000;
1023 }
1024 
1025 inline
1027 {
1028 #ifdef _DEBUG
1029  if (!IsSetWhole_word()) {
1030  memset(&m_Whole_word,UnassignedByte(),sizeof(m_Whole_word));
1031  }
1032 #endif
1033  m_set_State[0] |= 0x1000;
1034  return m_Whole_word;
1035 }
1036 
1037 inline
1039 {
1040  return ((m_set_State[0] & 0xc000) != 0);
1041 }
1042 
1043 inline
1045 {
1046  return true;
1047 }
1048 
1049 inline
1051 {
1052  m_Not_present = false;
1053  m_set_State[0] &= ~0xc000;
1054 }
1055 
1056 inline
1058 {
1059  ResetNot_present();
1060 }
1061 
1062 inline
1064 {
1065  return m_Not_present;
1066 }
1067 
1068 inline
1070 {
1071  m_Not_present = value;
1072  m_set_State[0] |= 0xc000;
1073 }
1074 
1075 inline
1077 {
1078 #ifdef _DEBUG
1079  if (!IsSetNot_present()) {
1080  memset(&m_Not_present,UnassignedByte(),sizeof(m_Not_present));
1081  }
1082 #endif
1083  m_set_State[0] |= 0x4000;
1084  return m_Not_present;
1085 }
1086 
1087 inline
1089 {
1090  return ((m_set_State[0] & 0x30000) != 0);
1091 }
1092 
1093 inline
1095 {
1096  return true;
1097 }
1098 
1099 inline
1101 {
1102  m_Is_all_caps = false;
1103  m_set_State[0] &= ~0x30000;
1104 }
1105 
1106 inline
1108 {
1109  ResetIs_all_caps();
1110 }
1111 
1112 inline
1114 {
1115  return m_Is_all_caps;
1116 }
1117 
1118 inline
1120 {
1121  m_Is_all_caps = value;
1122  m_set_State[0] |= 0x30000;
1123 }
1124 
1125 inline
1127 {
1128 #ifdef _DEBUG
1129  if (!IsSetIs_all_caps()) {
1130  memset(&m_Is_all_caps,UnassignedByte(),sizeof(m_Is_all_caps));
1131  }
1132 #endif
1133  m_set_State[0] |= 0x10000;
1134  return m_Is_all_caps;
1135 }
1136 
1137 inline
1139 {
1140  return ((m_set_State[0] & 0xc0000) != 0);
1141 }
1142 
1143 inline
1145 {
1146  return true;
1147 }
1148 
1149 inline
1151 {
1152  m_Is_all_lower = false;
1153  m_set_State[0] &= ~0xc0000;
1154 }
1155 
1156 inline
1158 {
1160 }
1161 
1162 inline
1164 {
1165  return m_Is_all_lower;
1166 }
1167 
1168 inline
1170 {
1172  m_set_State[0] |= 0xc0000;
1173 }
1174 
1175 inline
1177 {
1178 #ifdef _DEBUG
1179  if (!IsSetIs_all_lower()) {
1180  memset(&m_Is_all_lower,UnassignedByte(),sizeof(m_Is_all_lower));
1181  }
1182 #endif
1183  m_set_State[0] |= 0x40000;
1184  return m_Is_all_lower;
1185 }
1186 
1187 inline
1189 {
1190  return ((m_set_State[0] & 0x300000) != 0);
1191 }
1192 
1193 inline
1195 {
1196  return true;
1197 }
1198 
1199 inline
1201 {
1202  m_Is_all_punct = false;
1203  m_set_State[0] &= ~0x300000;
1204 }
1205 
1206 inline
1208 {
1210 }
1211 
1212 inline
1214 {
1215  return m_Is_all_punct;
1216 }
1217 
1218 inline
1220 {
1222  m_set_State[0] |= 0x300000;
1223 }
1224 
1225 inline
1227 {
1228 #ifdef _DEBUG
1229  if (!IsSetIs_all_punct()) {
1230  memset(&m_Is_all_punct,UnassignedByte(),sizeof(m_Is_all_punct));
1231  }
1232 #endif
1233  m_set_State[0] |= 0x100000;
1234  return m_Is_all_punct;
1235 }
1236 
1237 inline
1239 {
1240  return ((m_set_State[0] & 0xc00000) != 0);
1241 }
1242 
1243 inline
1245 {
1246  return true;
1247 }
1248 
1249 inline
1251 {
1252  m_Ignore_weasel = false;
1253  m_set_State[0] &= ~0xc00000;
1254 }
1255 
1256 inline
1258 {
1260 }
1261 
1262 inline
1264 {
1265  return m_Ignore_weasel;
1266 }
1267 
1268 inline
1270 {
1272  m_set_State[0] |= 0xc00000;
1273 }
1274 
1275 inline
1277 {
1278 #ifdef _DEBUG
1279  if (!IsSetIgnore_weasel()) {
1280  memset(&m_Ignore_weasel,UnassignedByte(),sizeof(m_Ignore_weasel));
1281  }
1282 #endif
1283  m_set_State[0] |= 0x400000;
1284  return m_Ignore_weasel;
1285 }
1286 
1287 inline
1289 {
1290  return ((m_set_State[0] & 0x3000000) != 0);
1291 }
1292 
1293 inline
1295 {
1296  return true;
1297 }
1298 
1299 inline
1301 {
1302  m_Is_first_cap = false;
1303  m_set_State[0] &= ~0x3000000;
1304 }
1305 
1306 inline
1308 {
1310 }
1311 
1312 inline
1314 {
1315  return m_Is_first_cap;
1316 }
1317 
1318 inline
1320 {
1322  m_set_State[0] |= 0x3000000;
1323 }
1324 
1325 inline
1327 {
1328 #ifdef _DEBUG
1329  if (!IsSetIs_first_cap()) {
1330  memset(&m_Is_first_cap,UnassignedByte(),sizeof(m_Is_first_cap));
1331  }
1332 #endif
1333  m_set_State[0] |= 0x1000000;
1334  return m_Is_first_cap;
1335 }
1336 
1337 inline
1339 {
1340  return ((m_set_State[0] & 0xc000000) != 0);
1341 }
1342 
1343 inline
1345 {
1346  return true;
1347 }
1348 
1349 inline
1351 {
1352  m_Is_first_each_cap = false;
1353  m_set_State[0] &= ~0xc000000;
1354 }
1355 
1356 inline
1358 {
1360 }
1361 
1362 inline
1364 {
1365  return m_Is_first_each_cap;
1366 }
1367 
1368 inline
1370 {
1372  m_set_State[0] |= 0xc000000;
1373 }
1374 
1375 inline
1377 {
1378 #ifdef _DEBUG
1379  if (!IsSetIs_first_each_cap()) {
1381  }
1382 #endif
1383  m_set_State[0] |= 0x4000000;
1384  return m_Is_first_each_cap;
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_MACRO_STRING_CONSTRAINT_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
CString_constraint_Base –.
CWord_substitution_set –.
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
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
TCase_sensitive GetCase_sensitive(void) const
Get the Case_sensitive member data.
bool IsSetIgnore_weasel(void) const
Check if a value has been assigned to Ignore_weasel data member.
bool IsSetIs_all_lower(void) const
Check if a value has been assigned to Is_all_lower data member.
bool CanGetIs_all_punct(void) const
Check if it is safe to call GetIs_all_punct method.
TIgnore_weasel & SetIgnore_weasel(void)
Assign a value to Ignore_weasel data member.
bool IsSetIs_all_punct(void) const
Check if a value has been assigned to Is_all_punct data member.
const TIgnore_words & GetIgnore_words(void) const
Get the Ignore_words member data.
bool IsSetMatch_location(void) const
Check if a value has been assigned to Match_location data member.
void ResetMatch_text(void)
Reset Match_text data member.
TIs_first_each_cap GetIs_first_each_cap(void) const
Get the Is_first_each_cap member data.
bool CanGetIgnore_space(void) const
Check if it is safe to call GetIgnore_space method.
CString_constraint_Base(const CString_constraint_Base &)
TIgnore_space GetIgnore_space(void) const
Get the Ignore_space member data.
void SetDefaultIgnore_space(void)
Assign default value to Ignore_space data member.
TMatch_location & SetMatch_location(void)
Assign a value to Match_location data member.
TIgnore_space & SetIgnore_space(void)
Assign a value to Ignore_space data member.
TIs_all_lower & SetIs_all_lower(void)
Assign a value to Is_all_lower data member.
void SetDefaultMatch_location(void)
Assign default value to Match_location data member.
Tparent::CMemberIndex< E_memberIndex, 15 > TmemberIndex
CString_constraint_Base & operator=(const CString_constraint_Base &)
CRef< TIgnore_words > m_Ignore_words
TIs_first_each_cap & SetIs_first_each_cap(void)
Assign a value to Is_first_each_cap data member.
TMatch_location GetMatch_location(void) const
Get the Match_location member data.
bool IsSetIs_first_cap(void) const
Check if a value has been assigned to Is_first_cap data member.
bool CanGetIgnore_weasel(void) const
Check if it is safe to call GetIgnore_weasel method.
bool IsSetCase_sensitive(void) const
Check if a value has been assigned to Case_sensitive data member.
TIs_all_caps GetIs_all_caps(void) const
Get the Is_all_caps member data.
bool IsSetIgnore_punct(void) const
Check if a value has been assigned to Ignore_punct data member.
bool CanGetIs_all_lower(void) const
Check if it is safe to call GetIs_all_lower method.
CWord_substitution_set TIgnore_words
EString_location TMatch_location
TIs_first_cap GetIs_first_cap(void) const
Get the Is_first_cap member data.
bool IsSetNot_present(void) const
Check if a value has been assigned to Not_present data member.
TWhole_word GetWhole_word(void) const
Get the Whole_word member data.
bool IsSetIs_first_each_cap(void) const
Check if a value has been assigned to Is_first_each_cap data member.
void ResetCase_sensitive(void)
Reset Case_sensitive data member.
bool CanGetNot_present(void) const
Check if it is safe to call GetNot_present method.
TIgnore_weasel GetIgnore_weasel(void) const
Get the Ignore_weasel member data.
void SetDefaultIs_all_punct(void)
Assign default value to Is_all_punct data member.
void ResetIs_first_each_cap(void)
Reset Is_first_each_cap data member.
bool IsSetWhole_word(void) const
Check if a value has been assigned to Whole_word data member.
TIgnore_punct & SetIgnore_punct(void)
Assign a value to Ignore_punct data member.
TIs_all_punct & SetIs_all_punct(void)
Assign a value to Is_all_punct data member.
TCase_sensitive & SetCase_sensitive(void)
Assign a value to Case_sensitive data member.
TMatch_text & SetMatch_text(void)
Assign a value to Match_text data member.
TNot_present & SetNot_present(void)
Assign a value to Not_present data member.
bool CanGetIgnore_punct(void) const
Check if it is safe to call GetIgnore_punct method.
void ResetNot_present(void)
Reset Not_present data member.
void ResetIgnore_space(void)
Reset Ignore_space data member.
void SetDefaultIs_all_lower(void)
Assign default value to Is_all_lower data member.
void SetDefaultIgnore_weasel(void)
Assign default value to Ignore_weasel data member.
TIgnore_punct GetIgnore_punct(void) const
Get the Ignore_punct member data.
TWhole_word & SetWhole_word(void)
Assign a value to Whole_word data member.
void SetDefaultIs_first_cap(void)
Assign default value to Is_first_cap data member.
bool CanGetIs_all_caps(void) const
Check if it is safe to call GetIs_all_caps method.
EString_location
simple constraints
void ResetIgnore_weasel(void)
Reset Ignore_weasel data member.
void SetDefaultIs_first_each_cap(void)
Assign default value to Is_first_each_cap data member.
const TMatch_text & GetMatch_text(void) const
Get the Match_text member data.
void SetDefaultCase_sensitive(void)
Assign default value to Case_sensitive data member.
TNot_present GetNot_present(void) const
Get the Not_present member data.
void ResetIs_all_lower(void)
Reset Is_all_lower data member.
void SetDefaultNot_present(void)
Assign default value to Not_present data member.
TIs_all_punct GetIs_all_punct(void) const
Get the Is_all_punct member data.
TIgnore_words & SetIgnore_words(void)
Assign a value to Ignore_words data member.
void SetDefaultIgnore_punct(void)
Assign default value to Ignore_punct data member.
bool CanGetCase_sensitive(void) const
Check if it is safe to call GetCase_sensitive method.
void SetDefaultIs_all_caps(void)
Assign default value to Is_all_caps data member.
virtual ~CString_constraint_Base(void)
TIs_all_lower GetIs_all_lower(void) const
Get the Is_all_lower member data.
bool CanGetIs_first_cap(void) const
Check if it is safe to call GetIs_first_cap method.
EString_location m_Match_location
void ResetWhole_word(void)
Reset Whole_word data member.
bool IsSetIgnore_space(void) const
Check if a value has been assigned to Ignore_space data member.
TIs_first_cap & SetIs_first_cap(void)
Assign a value to Is_first_cap data member.
void ResetIs_all_caps(void)
Reset Is_all_caps data member.
bool IsSetIs_all_caps(void) const
Check if a value has been assigned to Is_all_caps data member.
virtual void Reset(void)
Reset the whole object.
void SetDefaultWhole_word(void)
Assign default value to Whole_word data member.
void ResetIs_first_cap(void)
Reset Is_first_cap data member.
bool CanGetMatch_location(void) const
Check if it is safe to call GetMatch_location method.
void ResetMatch_location(void)
Reset Match_location data member.
bool IsSetMatch_text(void) const
Check if a value has been assigned to Match_text data member.
void ResetIgnore_words(void)
Reset Ignore_words data member.
void ResetIgnore_punct(void)
Reset Ignore_punct data member.
bool CanGetMatch_text(void) const
Check if it is safe to call GetMatch_text method.
bool CanGetIgnore_words(void) const
Check if it is safe to call GetIgnore_words method.
void ResetIs_all_punct(void)
Reset Is_all_punct data member.
TIs_all_caps & SetIs_all_caps(void)
Assign a value to Is_all_caps data member.
bool IsSetIgnore_words(void) const
Check if a value has been assigned to Ignore_words data member.
bool CanGetIs_first_each_cap(void) const
Check if it is safe to call GetIs_first_each_cap method.
bool CanGetWhole_word(void) const
Check if it is safe to call GetWhole_word method.
@ eString_location_contains
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Apr 17 13:10:39 2024 by modify_doxy.py rev. 669887