NCBI C++ ToolKit
Rna_qual_.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 Rna_qual_.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_RNA_QUAL_BASE_HPP
42 #define OBJECTS_MACRO_RNA_QUAL_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
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 // forward declarations
60 class CRna_feat_type;
61 
62 
63 // generated classes
64 
65 
66 /** @addtogroup dataspec_NCBI_Macro
67  *
68  * @{
69  */
70 
71 /////////////////////////////////////////////////////////////////////////////
72 ///
73 /// CRna_qual_Base --
74 ///
75 
77 {
79 public:
80  // constructor
81  CRna_qual_Base(void);
82  // destructor
83  virtual ~CRna_qual_Base(void);
84 
85  // type info
87 
88  // types
90  typedef ERna_field TField;
91 
92  // member index
93  enum class E_memberIndex {
94  e__allMandatory = 0,
95  e_type,
96  e_field
97  };
99 
100  // getters
101  // setters
102 
103  /// Check if a value has been assigned to Type data member.
104  ///
105  /// Data member Type is mandatory;
106  /// its type is defined as 'typedef CRna_feat_type TType'
107  /// @return
108  /// - true, if a value has been assigned.
109  /// - false, otherwise.
110  bool IsSetType(void) const;
111 
112  /// Check if it is safe to call GetType method.
113  ///
114  /// @return
115  /// - true, if the data member is getatable.
116  /// - false, otherwise.
117  bool CanGetType(void) const;
118 
119  /// Reset Type data member.
120  void ResetType(void);
121 
122  /// Get the Type member data.
123  ///
124  /// @return
125  /// Reference to the member data.
126  const TType& GetType(void) const;
127 
128  /// Assign a value to Type data member.
129  ///
130  /// @param value
131  /// Reference to value.
132  void SetType(TType& value);
133 
134  /// Assign a value to Type data member.
135  ///
136  /// @return
137  /// Reference to the data value.
138  TType& SetType(void);
139 
140  /// Check if a value has been assigned to Field data member.
141  ///
142  /// Data member Field is mandatory;
143  /// its type is defined as 'typedef ERna_field TField'
144  /// @return
145  /// - true, if a value has been assigned.
146  /// - false, otherwise.
147  bool IsSetField(void) const;
148 
149  /// Check if it is safe to call GetField method.
150  ///
151  /// @return
152  /// - true, if the data member is getatable.
153  /// - false, otherwise.
154  bool CanGetField(void) const;
155 
156  /// Reset Field data member.
157  void ResetField(void);
158 
159  /// Get the Field member data.
160  ///
161  /// @return
162  /// Copy of the member data.
163  TField GetField(void) const;
164 
165  /// Assign a value to Field data member.
166  ///
167  /// @param value
168  /// Value to assign
169  void SetField(TField value);
170 
171  /// Assign a value to Field data member.
172  ///
173  /// @return
174  /// Reference to the data value.
175  TField& SetField(void);
176 
177  /// Reset the whole object
178  virtual void Reset(void);
179 
180 
181 private:
182  // Prohibit copy constructor and assignment operator
185 
186  // data
190 };
191 
192 /* @} */
193 
194 
195 
196 
197 
198 ///////////////////////////////////////////////////////////
199 ///////////////////// inline methods //////////////////////
200 ///////////////////////////////////////////////////////////
201 inline
203 {
204  return m_Type.NotEmpty();
205 }
206 
207 inline
209 {
210  return true;
211 }
212 
213 inline
215 {
216  if ( !m_Type ) {
217  const_cast<CRna_qual_Base*>(this)->ResetType();
218  }
219  return (*m_Type);
220 }
221 
222 inline
224 {
225  if ( !m_Type ) {
226  ResetType();
227  }
228  return (*m_Type);
229 }
230 
231 inline
233 {
234  return ((m_set_State[0] & 0xc) != 0);
235 }
236 
237 inline
239 {
240  return IsSetField();
241 }
242 
243 inline
245 {
247  m_set_State[0] &= ~0xc;
248 }
249 
250 inline
252 {
253  if (!CanGetField()) {
254  ThrowUnassigned(1);
255  }
256  return m_Field;
257 }
258 
259 inline
261 {
262  m_Field = value;
263  m_set_State[0] |= 0xc;
264 }
265 
266 inline
268 {
269 #ifdef _DEBUG
270  if (!IsSetField()) {
271  memset(&m_Field,UnassignedByte(),sizeof(m_Field));
272  }
273 #endif
274  m_set_State[0] |= 0x4;
275  return m_Field;
276 }
277 
278 ///////////////////////////////////////////////////////////
279 ////////////////// end of inline methods //////////////////
280 ///////////////////////////////////////////////////////////
281 
282 
283 
284 
285 
286 END_objects_SCOPE // namespace ncbi::objects::
287 
289 
290 
291 #endif // OBJECTS_MACRO_RNA_QUAL_BASE_HPP
User-defined methods of the data storage class.
CRef –.
Definition: ncbiobj.hpp:618
CRna_qual_Base –.
Definition: Rna_qual_.hpp:77
Base class for all serializable objects.
Definition: serialbase.hpp:150
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
ERna_field
Access to ERna_field's attributes (values, names) as defined in spec.
Definition: Rna_field_.hpp:63
bool CanGetField(void) const
Check if it is safe to call GetField method.
Definition: Rna_qual_.hpp:238
bool CanGetType(void) const
Check if it is safe to call GetType method.
Definition: Rna_qual_.hpp:208
CRna_feat_type TType
Definition: Rna_qual_.hpp:89
ERna_field m_Field
Definition: Rna_qual_.hpp:189
virtual void Reset(void)
Reset the whole object.
Definition: Rna_qual_.cpp:65
bool IsSetField(void) const
Check if a value has been assigned to Field data member.
Definition: Rna_qual_.hpp:232
TField GetField(void) const
Get the Field member data.
Definition: Rna_qual_.hpp:251
CRef< TType > m_Type
Definition: Rna_qual_.hpp:188
bool IsSetType(void) const
Check if a value has been assigned to Type data member.
Definition: Rna_qual_.hpp:202
virtual ~CRna_qual_Base(void)
Definition: Rna_qual_.cpp:93
CRna_qual_Base & operator=(const CRna_qual_Base &)
DECLARE_INTERNAL_TYPE_INFO()
ERna_field TField
Definition: Rna_qual_.hpp:90
CRna_qual_Base(void)
Definition: Rna_qual_.cpp:83
void ResetType(void)
Reset Type data member.
Definition: Rna_qual_.cpp:51
const TType & GetType(void) const
Get the Type member data.
Definition: Rna_qual_.hpp:214
TField & SetField(void)
Assign a value to Field data member.
Definition: Rna_qual_.hpp:267
void ResetField(void)
Reset Field data member.
Definition: Rna_qual_.hpp:244
CSerialObject Tparent
Definition: Rna_qual_.hpp:78
TType & SetType(void)
Assign a value to Type data member.
Definition: Rna_qual_.hpp:223
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Definition: Rna_qual_.hpp:98
CRna_qual_Base(const CRna_qual_Base &)
Uint4 m_set_State[1]
Definition: Rna_qual_.hpp:187
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Jun 12 11:18:06 2024 by modify_doxy.py rev. 669887