NCBI C++ ToolKit
ProjectConfiguration_.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 ProjectConfiguration_.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/build-system/project_tree_builder/msbuild/msbuild_dataobj.xsd">msbuild_dataobj.xsd</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/msbuild/msbuild_dataobj.def">msbuild_dataobj.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 msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROJECTCONFIGURATION_BASE_HPP
42 #define msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROJECTCONFIGURATION_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
49 
50 #ifndef BEGIN_msbuild_SCOPE
51 # define BEGIN_msbuild_SCOPE BEGIN_SCOPE(msbuild)
52 # define END_msbuild_SCOPE END_SCOPE(msbuild)
53 #endif
54 BEGIN_msbuild_SCOPE // namespace msbuild::
55 
56 
57 // generated classes
58 
59 
60 /** @addtogroup dataspec_msbuild_dataobj
61  *
62  * @{
63  */
64 
65 /////////////////////////////////////////////////////////////////////////////
66 ///
67 /// CProjectConfiguration_Base --
68 ///
69 
70 class CProjectConfiguration_Base : public NCBI_NS_NCBI::CSerialObject
71 {
72  typedef NCBI_NS_NCBI::CSerialObject Tparent;
73 public:
74  // constructor
76  // destructor
77  virtual ~CProjectConfiguration_Base(void);
78 
79  // type info
81 
82  /////////////////////////////////////////////////////////////////////////////
83  ///
84  /// C_Attlist --
85  ///
86 
87  class C_Attlist : public NCBI_NS_NCBI::CSerialObject
88  {
89  typedef NCBI_NS_NCBI::CSerialObject Tparent;
90  public:
91  // constructor
92  C_Attlist(void);
93  // destructor
94  ~C_Attlist(void);
95 
96  // type info
98 
99  // types
105 
106  // member index
107  enum class E_memberIndex {
108  e__allMandatory = 0,
109  e_Condition,
110  e_Include,
111  e_Exclude,
112  e_Remove,
113  e_Label
114  };
115  typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
116 
117  // getters
118  // setters
119 
120  ///Optional expression evaluated to determine whether the items should be evaluated
121  /// Check if a value has been assigned to Condition data member.
122  ///
123  /// Data member Condition is optional;
124  /// its type is defined as 'typedef NCBI_NS_STD::string TCondition'
125  /// @return
126  /// - true, if a value has been assigned.
127  /// - false, otherwise.
128  bool IsSetCondition(void) const;
129 
130  /// Check if it is safe to call GetCondition method.
131  ///
132  /// @return
133  /// - true, if the data member is getatable.
134  /// - false, otherwise.
135  bool CanGetCondition(void) const;
136 
137  /// Reset Condition data member.
138  void ResetCondition(void);
139 
140  /// Get the Condition member data.
141  ///
142  /// @return
143  /// Reference to the member data.
144  const TCondition& GetCondition(void) const;
145 
146  /// Assign a value to Condition data member.
147  ///
148  /// @param value
149  /// Value to assign
150  void SetCondition(const TCondition& value);
151  void SetCondition(TCondition&& value);
152 
153  /// Assign a value to Condition data member.
154  ///
155  /// @return
156  /// Reference to the data value.
157  TCondition& SetCondition(void);
158 
159  ///Semi-colon separated list of files (wildcards are allowed) or other item names to include in this item list
160  /// Check if a value has been assigned to Include data member.
161  ///
162  /// Data member Include is optional;
163  /// its type is defined as 'typedef NCBI_NS_STD::string TInclude'
164  /// @return
165  /// - true, if a value has been assigned.
166  /// - false, otherwise.
167  bool IsSetInclude(void) const;
168 
169  /// Check if it is safe to call GetInclude method.
170  ///
171  /// @return
172  /// - true, if the data member is getatable.
173  /// - false, otherwise.
174  bool CanGetInclude(void) const;
175 
176  /// Reset Include data member.
177  void ResetInclude(void);
178 
179  /// Get the Include member data.
180  ///
181  /// @return
182  /// Reference to the member data.
183  const TInclude& GetInclude(void) const;
184 
185  /// Assign a value to Include data member.
186  ///
187  /// @param value
188  /// Value to assign
189  void SetInclude(const TInclude& value);
190  void SetInclude(TInclude&& value);
191 
192  /// Assign a value to Include data member.
193  ///
194  /// @return
195  /// Reference to the data value.
196  TInclude& SetInclude(void);
197 
198  ///Semi-colon separated list of files (wildcards are allowed) or other item names to exclude from the Include list
199  /// Check if a value has been assigned to Exclude data member.
200  ///
201  /// Data member Exclude is optional;
202  /// its type is defined as 'typedef NCBI_NS_STD::string TExclude'
203  /// @return
204  /// - true, if a value has been assigned.
205  /// - false, otherwise.
206  bool IsSetExclude(void) const;
207 
208  /// Check if it is safe to call GetExclude method.
209  ///
210  /// @return
211  /// - true, if the data member is getatable.
212  /// - false, otherwise.
213  bool CanGetExclude(void) const;
214 
215  /// Reset Exclude data member.
216  void ResetExclude(void);
217 
218  /// Get the Exclude member data.
219  ///
220  /// @return
221  /// Reference to the member data.
222  const TExclude& GetExclude(void) const;
223 
224  /// Assign a value to Exclude data member.
225  ///
226  /// @param value
227  /// Value to assign
228  void SetExclude(const TExclude& value);
229  void SetExclude(TExclude&& value);
230 
231  /// Assign a value to Exclude data member.
232  ///
233  /// @return
234  /// Reference to the data value.
235  TExclude& SetExclude(void);
236 
237  ///Semi-colon separated list of files (wildcards are allowed) or other item names to remove from the existing list contents
238  /// Check if a value has been assigned to Remove data member.
239  ///
240  /// Data member Remove is optional;
241  /// its type is defined as 'typedef NCBI_NS_STD::string TRemove'
242  /// @return
243  /// - true, if a value has been assigned.
244  /// - false, otherwise.
245  bool IsSetRemove(void) const;
246 
247  /// Check if it is safe to call GetRemove method.
248  ///
249  /// @return
250  /// - true, if the data member is getatable.
251  /// - false, otherwise.
252  bool CanGetRemove(void) const;
253 
254  /// Reset Remove data member.
255  void ResetRemove(void);
256 
257  /// Get the Remove member data.
258  ///
259  /// @return
260  /// Reference to the member data.
261  const TRemove& GetRemove(void) const;
262 
263  /// Assign a value to Remove data member.
264  ///
265  /// @param value
266  /// Value to assign
267  void SetRemove(const TRemove& value);
268  void SetRemove(TRemove&& value);
269 
270  /// Assign a value to Remove data member.
271  ///
272  /// @return
273  /// Reference to the data value.
274  TRemove& SetRemove(void);
275 
276  /// Optional expression. Used to identify or order system and user elements
277  /// Check if a value has been assigned to Label data member.
278  ///
279  /// Data member Label is optional;
280  /// its type is defined as 'typedef NCBI_NS_STD::string TLabel'
281  /// @return
282  /// - true, if a value has been assigned.
283  /// - false, otherwise.
284  bool IsSetLabel(void) const;
285 
286  /// Check if it is safe to call GetLabel method.
287  ///
288  /// @return
289  /// - true, if the data member is getatable.
290  /// - false, otherwise.
291  bool CanGetLabel(void) const;
292 
293  /// Reset Label data member.
294  void ResetLabel(void);
295 
296  /// Get the Label member data.
297  ///
298  /// @return
299  /// Reference to the member data.
300  const TLabel& GetLabel(void) const;
301 
302  /// Assign a value to Label data member.
303  ///
304  /// @param value
305  /// Value to assign
306  void SetLabel(const TLabel& value);
307  void SetLabel(TLabel&& value);
308 
309  /// Assign a value to Label data member.
310  ///
311  /// @return
312  /// Reference to the data value.
313  TLabel& SetLabel(void);
314 
315  /// Reset the whole object
316  void Reset(void);
317 
318 
319  private:
320  // Prohibit copy constructor and assignment operator
323 
324  // data
331  };
332  // types
336 
337  // member index
338  enum class E_memberIndex {
339  e__allMandatory = 0,
340  e_Attlist,
342  e_Platform
343  };
344  typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
345 
346  // getters
347  // setters
348 
349  /// Check if a value has been assigned to Attlist data member.
350  ///
351  /// Data member Attlist is mandatory;
352  /// its type is defined as 'typedef C_Attlist TAttlist'
353  /// @return
354  /// - true, if a value has been assigned.
355  /// - false, otherwise.
356  bool IsSetAttlist(void) const;
357 
358  /// Check if it is safe to call GetAttlist method.
359  ///
360  /// @return
361  /// - true, if the data member is getatable.
362  /// - false, otherwise.
363  bool CanGetAttlist(void) const;
364 
365  /// Reset Attlist data member.
366  void ResetAttlist(void);
367 
368  /// Get the Attlist member data.
369  ///
370  /// @return
371  /// Reference to the member data.
372  const TAttlist& GetAttlist(void) const;
373 
374  /// Assign a value to Attlist data member.
375  ///
376  /// @param value
377  /// Reference to value.
378  void SetAttlist(TAttlist& value);
379 
380  /// Assign a value to Attlist data member.
381  ///
382  /// @return
383  /// Reference to the data value.
384  TAttlist& SetAttlist(void);
385 
386  /// Check if a value has been assigned to Configuration data member.
387  ///
388  /// Data member Configuration is mandatory;
389  /// its type is defined as 'typedef NCBI_NS_STD::string TConfiguration'
390  /// @return
391  /// - true, if a value has been assigned.
392  /// - false, otherwise.
393  bool IsSetConfiguration(void) const;
394 
395  /// Check if it is safe to call GetConfiguration method.
396  ///
397  /// @return
398  /// - true, if the data member is getatable.
399  /// - false, otherwise.
400  bool CanGetConfiguration(void) const;
401 
402  /// Reset Configuration data member.
403  void ResetConfiguration(void);
404 
405  /// Get the Configuration member data.
406  ///
407  /// @return
408  /// Reference to the member data.
409  const TConfiguration& GetConfiguration(void) const;
410 
411  /// Assign a value to Configuration data member.
412  ///
413  /// @param value
414  /// Value to assign
417 
418  /// Assign a value to Configuration data member.
419  ///
420  /// @return
421  /// Reference to the data value.
423 
424  /// Check if a value has been assigned to Platform data member.
425  ///
426  /// Data member Platform is mandatory;
427  /// its type is defined as 'typedef NCBI_NS_STD::string TPlatform'
428  /// @return
429  /// - true, if a value has been assigned.
430  /// - false, otherwise.
431  bool IsSetPlatform(void) const;
432 
433  /// Check if it is safe to call GetPlatform method.
434  ///
435  /// @return
436  /// - true, if the data member is getatable.
437  /// - false, otherwise.
438  bool CanGetPlatform(void) const;
439 
440  /// Reset Platform data member.
441  void ResetPlatform(void);
442 
443  /// Get the Platform member data.
444  ///
445  /// @return
446  /// Reference to the member data.
447  const TPlatform& GetPlatform(void) const;
448 
449  /// Assign a value to Platform data member.
450  ///
451  /// @param value
452  /// Value to assign
453  void SetPlatform(const TPlatform& value);
454  void SetPlatform(TPlatform&& value);
455 
456  /// Assign a value to Platform data member.
457  ///
458  /// @return
459  /// Reference to the data value.
460  TPlatform& SetPlatform(void);
461 
462  /// Reset the whole object
463  virtual void Reset(void);
464 
465 
466 private:
467  // Prohibit copy constructor and assignment operator
470 
471  // data
473  NCBI_NS_NCBI::CRef< TAttlist > m_Attlist;
476 };
477 
478 /* @} */
479 
480 
481 
482 
483 
484 ///////////////////////////////////////////////////////////
485 ///////////////////// inline methods //////////////////////
486 ///////////////////////////////////////////////////////////
487 inline
489 {
490  return ((m_set_State[0] & 0x3) != 0);
491 }
492 
493 inline
495 {
496  return IsSetCondition();
497 }
498 
499 inline
501 {
502  if (!CanGetCondition()) {
503  ThrowUnassigned(0);
504  }
505  return m_Condition;
506 }
507 
508 inline
510 {
511  m_Condition = value;
512  m_set_State[0] |= 0x3;
513 }
514 
515 inline
517 {
518  m_Condition = std::forward<CProjectConfiguration_Base::C_Attlist::TCondition>(value);
519  m_set_State[0] |= 0x3;
520 }
521 
522 inline
524 {
525 #ifdef _DEBUG
526  if (!IsSetCondition()) {
527  m_Condition = UnassignedString();
528  }
529 #endif
530  m_set_State[0] |= 0x1;
531  return m_Condition;
532 }
533 
534 inline
536 {
537  return ((m_set_State[0] & 0xc) != 0);
538 }
539 
540 inline
542 {
543  return IsSetInclude();
544 }
545 
546 inline
548 {
549  if (!CanGetInclude()) {
550  ThrowUnassigned(1);
551  }
552  return m_Include;
553 }
554 
555 inline
557 {
558  m_Include = value;
559  m_set_State[0] |= 0xc;
560 }
561 
562 inline
564 {
565  m_Include = std::forward<CProjectConfiguration_Base::C_Attlist::TInclude>(value);
566  m_set_State[0] |= 0xc;
567 }
568 
569 inline
571 {
572 #ifdef _DEBUG
573  if (!IsSetInclude()) {
574  m_Include = UnassignedString();
575  }
576 #endif
577  m_set_State[0] |= 0x4;
578  return m_Include;
579 }
580 
581 inline
583 {
584  return ((m_set_State[0] & 0x30) != 0);
585 }
586 
587 inline
589 {
590  return IsSetExclude();
591 }
592 
593 inline
595 {
596  if (!CanGetExclude()) {
597  ThrowUnassigned(2);
598  }
599  return m_Exclude;
600 }
601 
602 inline
604 {
605  m_Exclude = value;
606  m_set_State[0] |= 0x30;
607 }
608 
609 inline
611 {
612  m_Exclude = std::forward<CProjectConfiguration_Base::C_Attlist::TExclude>(value);
613  m_set_State[0] |= 0x30;
614 }
615 
616 inline
618 {
619 #ifdef _DEBUG
620  if (!IsSetExclude()) {
621  m_Exclude = UnassignedString();
622  }
623 #endif
624  m_set_State[0] |= 0x10;
625  return m_Exclude;
626 }
627 
628 inline
630 {
631  return ((m_set_State[0] & 0xc0) != 0);
632 }
633 
634 inline
636 {
637  return IsSetRemove();
638 }
639 
640 inline
642 {
643  if (!CanGetRemove()) {
644  ThrowUnassigned(3);
645  }
646  return m_Remove;
647 }
648 
649 inline
651 {
652  m_Remove = value;
653  m_set_State[0] |= 0xc0;
654 }
655 
656 inline
658 {
659  m_Remove = std::forward<CProjectConfiguration_Base::C_Attlist::TRemove>(value);
660  m_set_State[0] |= 0xc0;
661 }
662 
663 inline
665 {
666 #ifdef _DEBUG
667  if (!IsSetRemove()) {
668  m_Remove = UnassignedString();
669  }
670 #endif
671  m_set_State[0] |= 0x40;
672  return m_Remove;
673 }
674 
675 inline
677 {
678  return ((m_set_State[0] & 0x300) != 0);
679 }
680 
681 inline
683 {
684  return IsSetLabel();
685 }
686 
687 inline
689 {
690  if (!CanGetLabel()) {
691  ThrowUnassigned(4);
692  }
693  return m_Label;
694 }
695 
696 inline
698 {
699  m_Label = value;
700  m_set_State[0] |= 0x300;
701 }
702 
703 inline
705 {
706  m_Label = std::forward<CProjectConfiguration_Base::C_Attlist::TLabel>(value);
707  m_set_State[0] |= 0x300;
708 }
709 
710 inline
712 {
713 #ifdef _DEBUG
714  if (!IsSetLabel()) {
715  m_Label = UnassignedString();
716  }
717 #endif
718  m_set_State[0] |= 0x100;
719  return m_Label;
720 }
721 
722 inline
724 {
725  return m_Attlist.NotEmpty();
726 }
727 
728 inline
730 {
731  return true;
732 }
733 
734 inline
736 {
737  if ( !m_Attlist ) {
738  const_cast<CProjectConfiguration_Base*>(this)->ResetAttlist();
739  }
740  return (*m_Attlist);
741 }
742 
743 inline
745 {
746  if ( !m_Attlist ) {
747  ResetAttlist();
748  }
749  return (*m_Attlist);
750 }
751 
752 inline
754 {
755  return ((m_set_State[0] & 0xc) != 0);
756 }
757 
758 inline
760 {
761  return IsSetConfiguration();
762 }
763 
764 inline
766 {
767  if (!CanGetConfiguration()) {
768  ThrowUnassigned(1);
769  }
770  return m_Configuration;
771 }
772 
773 inline
775 {
777  m_set_State[0] |= 0xc;
778 }
779 
780 inline
782 {
783  m_Configuration = std::forward<CProjectConfiguration_Base::TConfiguration>(value);
784  m_set_State[0] |= 0xc;
785 }
786 
787 inline
789 {
790 #ifdef _DEBUG
791  if (!IsSetConfiguration()) {
792  m_Configuration = UnassignedString();
793  }
794 #endif
795  m_set_State[0] |= 0x4;
796  return m_Configuration;
797 }
798 
799 inline
801 {
802  return ((m_set_State[0] & 0x30) != 0);
803 }
804 
805 inline
807 {
808  return IsSetPlatform();
809 }
810 
811 inline
813 {
814  if (!CanGetPlatform()) {
815  ThrowUnassigned(2);
816  }
817  return m_Platform;
818 }
819 
820 inline
822 {
823  m_Platform = value;
824  m_set_State[0] |= 0x30;
825 }
826 
827 inline
829 {
830  m_Platform = std::forward<CProjectConfiguration_Base::TPlatform>(value);
831  m_set_State[0] |= 0x30;
832 }
833 
834 inline
836 {
837 #ifdef _DEBUG
838  if (!IsSetPlatform()) {
839  m_Platform = UnassignedString();
840  }
841 #endif
842  m_set_State[0] |= 0x10;
843  return m_Platform;
844 }
845 
846 ///////////////////////////////////////////////////////////
847 ////////////////// end of inline methods //////////////////
848 ///////////////////////////////////////////////////////////
849 
850 
851 
852 
853 
854 END_msbuild_SCOPE // namespace msbuild::
855 
856 
857 #endif // msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROJECTCONFIGURATION_BASE_HPP
#define END_msbuild_SCOPE
#define BEGIN_msbuild_SCOPE
CProjectConfiguration_Base –.
string
Definition: cgiapp.hpp:687
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
bool IsSetAttlist(void) const
Check if a value has been assigned to Attlist data member.
const TRemove & GetRemove(void) const
Get the Remove member data.
void ResetInclude(void)
Reset Include data member.
bool CanGetExclude(void) const
Check if it is safe to call GetExclude method.
void ResetLabel(void)
Reset Label data member.
const TPlatform & GetPlatform(void) const
Get the Platform member data.
const TAttlist & GetAttlist(void) const
Get the Attlist member data.
const TExclude & GetExclude(void) const
Get the Exclude member data.
void ResetPlatform(void)
Reset Platform data member.
Tparent::CMemberIndex< E_memberIndex, 6 > TmemberIndex
bool CanGetInclude(void) const
Check if it is safe to call GetInclude method.
const TConfiguration & GetConfiguration(void) const
Get the Configuration member data.
bool CanGetCondition(void) const
Check if it is safe to call GetCondition method.
TRemove & SetRemove(void)
Assign a value to Remove data member.
TAttlist & SetAttlist(void)
Assign a value to Attlist data member.
TConfiguration & SetConfiguration(void)
Assign a value to Configuration data member.
const TInclude & GetInclude(void) const
Get the Include member data.
const TCondition & GetCondition(void) const
Get the Condition member data.
bool CanGetAttlist(void) const
Check if it is safe to call GetAttlist method.
bool CanGetPlatform(void) const
Check if it is safe to call GetPlatform method.
void Reset(void)
Reset the whole object.
TPlatform & SetPlatform(void)
Assign a value to Platform data member.
bool CanGetRemove(void) const
Check if it is safe to call GetRemove method.
NCBI_NS_NCBI::CSerialObject Tparent
void ResetConfiguration(void)
Reset Configuration data member.
Tparent::CMemberIndex< E_memberIndex, 4 > TmemberIndex
const TLabel & GetLabel(void) const
Get the Label member data.
CProjectConfiguration_Base & operator=(const CProjectConfiguration_Base &)
virtual void Reset(void)
Reset the whole object.
TExclude & SetExclude(void)
Assign a value to Exclude data member.
bool IsSetConfiguration(void) const
Check if a value has been assigned to Configuration data member.
void ResetRemove(void)
Reset Remove data member.
void ResetCondition(void)
Reset Condition data member.
TInclude & SetInclude(void)
Assign a value to Include data member.
bool IsSetPlatform(void) const
Check if a value has been assigned to Platform data member.
bool CanGetLabel(void) const
Check if it is safe to call GetLabel method.
bool IsSetRemove(void) const
Semi-colon separated list of files (wildcards are allowed) or other item names to remove from the exi...
bool IsSetExclude(void) const
Semi-colon separated list of files (wildcards are allowed) or other item names to exclude from the In...
void ResetExclude(void)
Reset Exclude data member.
bool CanGetConfiguration(void) const
Check if it is safe to call GetConfiguration method.
TCondition & SetCondition(void)
Assign a value to Condition data member.
C_Attlist & operator=(const C_Attlist &)
CProjectConfiguration_Base(const CProjectConfiguration_Base &)
bool IsSetLabel(void) const
Optional expression.
bool IsSetInclude(void) const
Semi-colon separated list of files (wildcards are allowed) or other item names to include in this ite...
TLabel & SetLabel(void)
Assign a value to Label data member.
NCBI_NS_NCBI::CRef< TAttlist > m_Attlist
void ResetAttlist(void)
Reset Attlist data member.
bool IsSetCondition(void) const
Optional expression evaluated to determine whether the items should be evaluated Check if a value has...
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Mon May 06 04:49:08 2024 by modify_doxy.py rev. 669887