NCBI C++ ToolKit
MSScoreSet_.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 MSScoreSet_.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/omssa/omssa.asn">omssa.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/omssa/omssa.def">omssa.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_OMSSA_MSSCORESET_BASE_HPP
42 #define OBJECTS_OMSSA_MSSCORESET_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_OMSSA
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 /// sets of scores
69 ///
70 /// CMSScoreSet_Base --
71 ///
72 
74 {
76 public:
77  // constructor
78  CMSScoreSet_Base(void);
79  // destructor
80  virtual ~CMSScoreSet_Base(void);
81 
82  // type info
84 
85  // types
86  typedef string TName;
87  typedef double TValue;
88 
89  // member index
90  enum class E_memberIndex {
91  e__allMandatory = 0,
92  e_name,
93  e_value
94  };
96 
97  // getters
98  // setters
99 
100  /// Check if a value has been assigned to Name data member.
101  ///
102  /// Data member Name is mandatory;
103  /// its type is defined as 'typedef string TName'
104  /// @return
105  /// - true, if a value has been assigned.
106  /// - false, otherwise.
107  bool IsSetName(void) const;
108 
109  /// Check if it is safe to call GetName method.
110  ///
111  /// @return
112  /// - true, if the data member is getatable.
113  /// - false, otherwise.
114  bool CanGetName(void) const;
115 
116  /// Reset Name data member.
117  void ResetName(void);
118 
119  /// Get the Name member data.
120  ///
121  /// @return
122  /// Reference to the member data.
123  const TName& GetName(void) const;
124 
125  /// Assign a value to Name data member.
126  ///
127  /// @param value
128  /// Value to assign
129  void SetName(const TName& value);
130  void SetName(TName&& value);
131 
132  /// Assign a value to Name data member.
133  ///
134  /// @return
135  /// Reference to the data value.
136  TName& SetName(void);
137 
138  /// Check if a value has been assigned to Value data member.
139  ///
140  /// Data member Value is mandatory;
141  /// its type is defined as 'typedef double TValue'
142  /// @return
143  /// - true, if a value has been assigned.
144  /// - false, otherwise.
145  bool IsSetValue(void) const;
146 
147  /// Check if it is safe to call GetValue method.
148  ///
149  /// @return
150  /// - true, if the data member is getatable.
151  /// - false, otherwise.
152  bool CanGetValue(void) const;
153 
154  /// Reset Value data member.
155  void ResetValue(void);
156 
157  /// Get the Value member data.
158  ///
159  /// @return
160  /// Copy of the member data.
161  TValue GetValue(void) const;
162 
163  /// Assign a value to Value data member.
164  ///
165  /// @param value
166  /// Value to assign
167  void SetValue(TValue value);
168 
169  /// Assign a value to Value data member.
170  ///
171  /// @return
172  /// Reference to the data value.
173  TValue& SetValue(void);
174 
175  /// Reset the whole object
176  virtual void Reset(void);
177 
178 
179 private:
180  // Prohibit copy constructor and assignment operator
183 
184  // data
185  Uint4 m_set_State[1];
186  string m_Name;
187  double m_Value;
188 };
189 
190 /* @} */
191 
192 
193 
194 
195 
196 ///////////////////////////////////////////////////////////
197 ///////////////////// inline methods //////////////////////
198 ///////////////////////////////////////////////////////////
199 inline
201 {
202  return ((m_set_State[0] & 0x3) != 0);
203 }
204 
205 inline
207 {
208  return IsSetName();
209 }
210 
211 inline
213 {
214  if (!CanGetName()) {
215  ThrowUnassigned(0);
216  }
217  return m_Name;
218 }
219 
220 inline
222 {
223  m_Name = value;
224  m_set_State[0] |= 0x3;
225 }
226 
227 inline
229 {
230  m_Name = std::forward<CMSScoreSet_Base::TName>(value);
231  m_set_State[0] |= 0x3;
232 }
233 
234 inline
236 {
237 #ifdef _DEBUG
238  if (!IsSetName()) {
240  }
241 #endif
242  m_set_State[0] |= 0x1;
243  return m_Name;
244 }
245 
246 inline
248 {
249  return ((m_set_State[0] & 0xc) != 0);
250 }
251 
252 inline
254 {
255  return IsSetValue();
256 }
257 
258 inline
260 {
261  m_Value = 0;
262  m_set_State[0] &= ~0xc;
263 }
264 
265 inline
267 {
268  if (!CanGetValue()) {
269  ThrowUnassigned(1);
270  }
271  return m_Value;
272 }
273 
274 inline
276 {
277  m_Value = value;
278  m_set_State[0] |= 0xc;
279 }
280 
281 inline
283 {
284 #ifdef _DEBUG
285  if (!IsSetValue()) {
286  memset(&m_Value,UnassignedByte(),sizeof(m_Value));
287  }
288 #endif
289  m_set_State[0] |= 0x4;
290  return m_Value;
291 }
292 
293 ///////////////////////////////////////////////////////////
294 ////////////////// end of inline methods //////////////////
295 ///////////////////////////////////////////////////////////
296 
297 
298 
299 
300 
301 END_objects_SCOPE // namespace ncbi::objects::
302 
304 
305 
306 #endif // OBJECTS_OMSSA_MSSCORESET_BASE_HPP
sets of scores
Definition: MSScoreSet_.hpp:74
Base class for all serializable objects.
Definition: serialbase.hpp:150
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
#define NCBI_OMSSA_EXPORT
Definition: ncbi_export.h:672
CMSScoreSet_Base(const CMSScoreSet_Base &)
CMSScoreSet_Base & operator=(const CMSScoreSet_Base &)
TValue & SetValue(void)
Assign a value to Value data member.
TName & SetName(void)
Assign a value to Name data member.
TValue GetValue(void) const
Get the Value member data.
Uint4 m_set_State[1]
bool IsSetName(void) const
Check if a value has been assigned to Name data member.
bool CanGetName(void) const
Check if it is safe to call GetName method.
CSerialObject Tparent
Definition: MSScoreSet_.hpp:75
const TName & GetName(void) const
Get the Name member data.
bool IsSetValue(void) const
Check if a value has been assigned to Value data member.
void ResetValue(void)
Reset Value data member.
bool CanGetValue(void) const
Check if it is safe to call GetValue method.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
Definition: MSScoreSet_.hpp:95
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sun Apr 14 05:27:21 2024 by modify_doxy.py rev. 669887