NCBI C++ ToolKit
Autofix_action_.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 Autofix_action_.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_AUTOFIX_ACTION_BASE_HPP
42 #define OBJECTS_MACRO_AUTOFIX_ACTION_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
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 // generated classes
60 
61 
62 /** @addtogroup dataspec_NCBI_Macro
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///
69 /// CAutofix_action_Base --
70 ///
71 
73 {
75 public:
76  // constructor
78  // destructor
79  virtual ~CAutofix_action_Base(void);
80 
81  // type info
83 
84  // types
85  typedef string TTest_name;
86 
87  // member index
88  enum class E_memberIndex {
89  e__allMandatory = 0,
91  };
93 
94  // getters
95  // setters
96 
97  /// Check if a value has been assigned to Test_name data member.
98  ///
99  /// Data member Test_name is mandatory;
100  /// its type is defined as 'typedef string TTest_name'
101  /// @return
102  /// - true, if a value has been assigned.
103  /// - false, otherwise.
104  bool IsSetTest_name(void) const;
105 
106  /// Check if it is safe to call GetTest_name method.
107  ///
108  /// @return
109  /// - true, if the data member is getatable.
110  /// - false, otherwise.
111  bool CanGetTest_name(void) const;
112 
113  /// Reset Test_name data member.
114  void ResetTest_name(void);
115 
116  /// Get the Test_name member data.
117  ///
118  /// @return
119  /// Reference to the member data.
120  const TTest_name& GetTest_name(void) const;
121 
122  /// Assign a value to Test_name data member.
123  ///
124  /// @param value
125  /// Value to assign
126  void SetTest_name(const TTest_name& value);
127  void SetTest_name(TTest_name&& value);
128 
129  /// Assign a value to Test_name data member.
130  ///
131  /// @return
132  /// Reference to the data value.
133  TTest_name& SetTest_name(void);
134 
135  /// Reset the whole object
136  virtual void Reset(void);
137 
138 
139 private:
140  // Prohibit copy constructor and assignment operator
143 
144  // data
146  string m_Test_name;
147 };
148 
149 /* @} */
150 
151 
152 
153 
154 
155 ///////////////////////////////////////////////////////////
156 ///////////////////// inline methods //////////////////////
157 ///////////////////////////////////////////////////////////
158 inline
160 {
161  return ((m_set_State[0] & 0x3) != 0);
162 }
163 
164 inline
166 {
167  return IsSetTest_name();
168 }
169 
170 inline
172 {
173  if (!CanGetTest_name()) {
174  ThrowUnassigned(0);
175  }
176  return m_Test_name;
177 }
178 
179 inline
181 {
182  m_Test_name = value;
183  m_set_State[0] |= 0x3;
184 }
185 
186 inline
188 {
189  m_Test_name = std::forward<CAutofix_action_Base::TTest_name>(value);
190  m_set_State[0] |= 0x3;
191 }
192 
193 inline
195 {
196 #ifdef _DEBUG
197  if (!IsSetTest_name()) {
199  }
200 #endif
201  m_set_State[0] |= 0x1;
202  return m_Test_name;
203 }
204 
205 ///////////////////////////////////////////////////////////
206 ////////////////// end of inline methods //////////////////
207 ///////////////////////////////////////////////////////////
208 
209 
210 
211 
212 
213 END_objects_SCOPE // namespace ncbi::objects::
214 
216 
217 
218 #endif // OBJECTS_MACRO_AUTOFIX_ACTION_BASE_HPP
CAutofix_action_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
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
const TTest_name & GetTest_name(void) const
Get the Test_name member data.
CAutofix_action_Base & operator=(const CAutofix_action_Base &)
CAutofix_action_Base(const CAutofix_action_Base &)
virtual void Reset(void)
Reset the whole object.
TTest_name & SetTest_name(void)
Assign a value to Test_name data member.
bool CanGetTest_name(void) const
Check if it is safe to call GetTest_name method.
Tparent::CMemberIndex< E_memberIndex, 2 > TmemberIndex
bool IsSetTest_name(void) const
Check if a value has been assigned to Test_name data member.
void ResetTest_name(void)
Reset Test_name data member.
virtual ~CAutofix_action_Base(void)
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Tue May 28 05:54:27 2024 by modify_doxy.py rev. 669887