NCBI C++ ToolKit
NodeFeature_.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 NodeFeature_.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/biotree/biotree.asn">biotree.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/biotree/biotree.def">biotree.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_BIOTREE_NODEFEATURE_BASE_HPP
42 #define OBJECTS_BIOTREE_NODEFEATURE_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_BioTree
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 ///
69 /// CNodeFeature_Base --
70 ///
71 
73 {
75 public:
76  // constructor
77  CNodeFeature_Base(void);
78  // destructor
79  virtual ~CNodeFeature_Base(void);
80 
81  // type info
83 
84  // types
85  typedef int TFeatureid;
87 
88  // member index
89  enum class E_memberIndex {
90  e__allMandatory = 0,
91  e_featureid,
92  e_value
93  };
95 
96  // getters
97  // setters
98 
99  /// Check if a value has been assigned to Featureid data member.
100  ///
101  /// Data member Featureid is mandatory;
102  /// its type is defined as 'typedef int TFeatureid'
103  /// @return
104  /// - true, if a value has been assigned.
105  /// - false, otherwise.
106  bool IsSetFeatureid(void) const;
107 
108  /// Check if it is safe to call GetFeatureid method.
109  ///
110  /// @return
111  /// - true, if the data member is getatable.
112  /// - false, otherwise.
113  bool CanGetFeatureid(void) const;
114 
115  /// Reset Featureid data member.
116  void ResetFeatureid(void);
117 
118  /// Get the Featureid member data.
119  ///
120  /// @return
121  /// Copy of the member data.
122  TFeatureid GetFeatureid(void) const;
123 
124  /// Assign a value to Featureid data member.
125  ///
126  /// @param value
127  /// Value to assign
128  void SetFeatureid(TFeatureid value);
129 
130  /// Assign a value to Featureid data member.
131  ///
132  /// @return
133  /// Reference to the data value.
134  TFeatureid& SetFeatureid(void);
135 
136  /// Check if a value has been assigned to Value data member.
137  ///
138  /// Data member Value is mandatory;
139  /// its type is defined as 'typedef CStringUTF8 TValue'
140  /// @return
141  /// - true, if a value has been assigned.
142  /// - false, otherwise.
143  bool IsSetValue(void) const;
144 
145  /// Check if it is safe to call GetValue method.
146  ///
147  /// @return
148  /// - true, if the data member is getatable.
149  /// - false, otherwise.
150  bool CanGetValue(void) const;
151 
152  /// Reset Value data member.
153  void ResetValue(void);
154 
155  /// Get the Value member data.
156  ///
157  /// @return
158  /// Reference to the member data.
159  const TValue& GetValue(void) const;
160 
161  /// Assign a value to Value data member.
162  ///
163  /// @param value
164  /// Value to assign
165  void SetValue(const TValue& value);
166  void SetValue(TValue&& value);
167 
168  /// Assign a value to Value data member.
169  ///
170  /// @return
171  /// Reference to the data value.
172  TValue& SetValue(void);
173 
174  /// Reset the whole object
175  virtual void Reset(void);
176 
177 
178 private:
179  // Prohibit copy constructor and assignment operator
182 
183  // data
184  Uint4 m_set_State[1];
187 };
188 
189 /* @} */
190 
191 
192 
193 
194 
195 ///////////////////////////////////////////////////////////
196 ///////////////////// inline methods //////////////////////
197 ///////////////////////////////////////////////////////////
198 inline
200 {
201  return ((m_set_State[0] & 0x3) != 0);
202 }
203 
204 inline
206 {
207  return IsSetFeatureid();
208 }
209 
210 inline
212 {
213  m_Featureid = 0;
214  m_set_State[0] &= ~0x3;
215 }
216 
217 inline
219 {
220  if (!CanGetFeatureid()) {
221  ThrowUnassigned(0);
222  }
223  return m_Featureid;
224 }
225 
226 inline
228 {
229  m_Featureid = value;
230  m_set_State[0] |= 0x3;
231 }
232 
233 inline
235 {
236 #ifdef _DEBUG
237  if (!IsSetFeatureid()) {
238  memset(&m_Featureid,UnassignedByte(),sizeof(m_Featureid));
239  }
240 #endif
241  m_set_State[0] |= 0x1;
242  return m_Featureid;
243 }
244 
245 inline
247 {
248  return ((m_set_State[0] & 0xc) != 0);
249 }
250 
251 inline
253 {
254  return IsSetValue();
255 }
256 
257 inline
259 {
260  if (!CanGetValue()) {
261  ThrowUnassigned(1);
262  }
263  return m_Value;
264 }
265 
266 inline
268 {
269  m_Value = value;
270  m_set_State[0] |= 0xc;
271 }
272 
273 inline
275 {
276  m_Value = std::forward<CNodeFeature_Base::TValue>(value);
277  m_set_State[0] |= 0xc;
278 }
279 
280 inline
282 {
283 #ifdef _DEBUG
284  if (!IsSetValue()) {
286  }
287 #endif
288  m_set_State[0] |= 0x4;
289  return m_Value;
290 }
291 
292 ///////////////////////////////////////////////////////////
293 ////////////////// end of inline methods //////////////////
294 ///////////////////////////////////////////////////////////
295 
296 
297 
298 
299 
300 END_objects_SCOPE // namespace ncbi::objects::
301 
303 
304 
305 #endif // OBJECTS_BIOTREE_NODEFEATURE_BASE_HPP
CNodeFeature_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
static CStringUTF8 UnassignedStringUTF8(void)
Definition: serialbase.hpp:178
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
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
std::string CStringUTF8
Definition: ncbistl.hpp:254
#define NCBI_BIOTREE_EXPORT
Definition: ncbi_export.h:320
TValue & SetValue(void)
Assign a value to Value data member.
const TValue & GetValue(void) const
Get the Value member data.
bool CanGetFeatureid(void) const
Check if it is safe to call GetFeatureid method.
TFeatureid & SetFeatureid(void)
Assign a value to Featureid data member.
CStringUTF8 m_Value
TFeatureid GetFeatureid(void) const
Get the Featureid member data.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
bool CanGetValue(void) const
Check if it is safe to call GetValue method.
CStringUTF8 TValue
CSerialObject Tparent
void ResetFeatureid(void)
Reset Featureid data member.
bool IsSetValue(void) const
Check if a value has been assigned to Value data member.
bool IsSetFeatureid(void) const
Check if a value has been assigned to Featureid data member.
CNodeFeature_Base(const CNodeFeature_Base &)
CNodeFeature_Base & operator=(const CNodeFeature_Base &)
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Jul 17 13:18:58 2024 by modify_doxy.py rev. 669887