NCBI C++ ToolKit
ID1SeqEntry_info_.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 ID1SeqEntry_info_.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/id1/id1.asn">id1.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/id1/id1.def">id1.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_ID1_ID1SEQENTRY_INFO_BASE_HPP
42 #define OBJECTS_ID1_ID1SEQENTRY_INFO_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
47 
48 #ifndef BEGIN_objects_SCOPE
49 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
50 # define END_objects_SCOPE END_SCOPE(objects)
51 #endif
52 BEGIN_objects_SCOPE // namespace ncbi::objects::
53 
54 
55 // forward declarations
56 class CID1blob_info;
57 class CSeq_entry;
58 
59 
60 // generated classes
61 
62 
63 /** @addtogroup dataspec_NCBI_ID1Access
64  *
65  * @{
66  */
67 
68 /////////////////////////////////////////////////////////////////////////////
69 ///
70 /// CID1SeqEntry_info_Base --
71 ///
72 
74 {
76 public:
77  // constructor
79  // destructor
80  virtual ~CID1SeqEntry_info_Base(void);
81 
82  // type info
84 
85  // types
87  typedef CSeq_entry TBlob;
88 
89  // member index
90  enum class E_memberIndex {
91  e__allMandatory = 0,
92  e_blob_info,
93  e_blob
94  };
96 
97  // getters
98  // setters
99 
100  /// Check if a value has been assigned to Blob_info data member.
101  ///
102  /// Data member Blob_info is mandatory;
103  /// its type is defined as 'typedef CID1blob_info TBlob_info'
104  /// @return
105  /// - true, if a value has been assigned.
106  /// - false, otherwise.
107  bool IsSetBlob_info(void) const;
108 
109  /// Check if it is safe to call GetBlob_info method.
110  ///
111  /// @return
112  /// - true, if the data member is getatable.
113  /// - false, otherwise.
114  bool CanGetBlob_info(void) const;
115 
116  /// Reset Blob_info data member.
117  void ResetBlob_info(void);
118 
119  /// Get the Blob_info member data.
120  ///
121  /// @return
122  /// Reference to the member data.
123  const TBlob_info& GetBlob_info(void) const;
124 
125  /// Assign a value to Blob_info data member.
126  ///
127  /// @param value
128  /// Reference to value.
129  void SetBlob_info(TBlob_info& value);
130 
131  /// Assign a value to Blob_info data member.
132  ///
133  /// @return
134  /// Reference to the data value.
135  TBlob_info& SetBlob_info(void);
136 
137  /// Check if a value has been assigned to Blob data member.
138  ///
139  /// Data member Blob is optional;
140  /// its type is defined as 'typedef CSeq_entry TBlob'
141  /// @return
142  /// - true, if a value has been assigned.
143  /// - false, otherwise.
144  bool IsSetBlob(void) const;
145 
146  /// Check if it is safe to call GetBlob method.
147  ///
148  /// @return
149  /// - true, if the data member is getatable.
150  /// - false, otherwise.
151  bool CanGetBlob(void) const;
152 
153  /// Reset Blob data member.
154  void ResetBlob(void);
155 
156  /// Get the Blob member data.
157  ///
158  /// @return
159  /// Reference to the member data.
160  const TBlob& GetBlob(void) const;
161 
162  /// Assign a value to Blob data member.
163  ///
164  /// @param value
165  /// Reference to value.
166  void SetBlob(TBlob& value);
167 
168  /// Assign a value to Blob data member.
169  ///
170  /// @return
171  /// Reference to the data value.
172  TBlob& SetBlob(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_Blob_info.NotEmpty();
202 }
203 
204 inline
206 {
207  return true;
208 }
209 
210 inline
212 {
213  if ( !m_Blob_info ) {
214  const_cast<CID1SeqEntry_info_Base*>(this)->ResetBlob_info();
215  }
216  return (*m_Blob_info);
217 }
218 
219 inline
221 {
222  if ( !m_Blob_info ) {
223  ResetBlob_info();
224  }
225  return (*m_Blob_info);
226 }
227 
228 inline
230 {
231  return m_Blob.NotEmpty();
232 }
233 
234 inline
236 {
237  return IsSetBlob();
238 }
239 
240 inline
242 {
243  if (!CanGetBlob()) {
244  ThrowUnassigned(1);
245  }
246  return (*m_Blob);
247 }
248 
249 ///////////////////////////////////////////////////////////
250 ////////////////// end of inline methods //////////////////
251 ///////////////////////////////////////////////////////////
252 
253 
254 
255 
256 
257 END_objects_SCOPE // namespace ncbi::objects::
258 
260 
261 
262 #endif // OBJECTS_ID1_ID1SEQENTRY_INFO_BASE_HPP
CID1SeqEntry_info_Base –.
CID1blob_info –.
CRef –.
Definition: ncbiobj.hpp:618
Definition: Seq_entry.hpp:56
Base class for all serializable objects.
Definition: serialbase.hpp:150
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
#define NCBI_ID1_EXPORT
Definition: ncbi_export.h:544
const TBlob & GetBlob(void) const
Get the Blob member data.
CRef< TBlob_info > m_Blob_info
bool CanGetBlob(void) const
Check if it is safe to call GetBlob method.
TBlob_info & SetBlob_info(void)
Assign a value to Blob_info data member.
CID1SeqEntry_info_Base(const CID1SeqEntry_info_Base &)
bool IsSetBlob_info(void) const
Check if a value has been assigned to Blob_info data member.
void ResetBlob_info(void)
Reset Blob_info data member.
bool CanGetBlob_info(void) const
Check if it is safe to call GetBlob_info method.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
CID1SeqEntry_info_Base & operator=(const CID1SeqEntry_info_Base &)
const TBlob_info & GetBlob_info(void) const
Get the Blob_info member data.
bool IsSetBlob(void) const
Check if a value has been assigned to Blob data member.
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Sun Jul 14 04:54:23 2024 by modify_doxy.py rev. 669887