NCBI C++ ToolKit
ID2S_Chunk_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 ID2S_Chunk_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/seqsplit/seqsplit.asn">seqsplit.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqsplit/seqsplit.def">seqsplit.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_SEQSPLIT_ID2S_CHUNK_INFO_BASE_HPP
42 #define OBJECTS_SEQSPLIT_ID2S_CHUNK_INFO_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
50 
52 
53 #ifndef BEGIN_objects_SCOPE
54 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
55 # define END_objects_SCOPE END_SCOPE(objects)
56 #endif
57 BEGIN_objects_SCOPE // namespace ncbi::objects::
58 
59 
60 // forward declarations
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_Seq_split
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 ///
74 /// CID2S_Chunk_Info_Base --
75 ///
76 
78 {
80 public:
81  // constructor
83  // destructor
84  virtual ~CID2S_Chunk_Info_Base(void);
85 
86  // type info
88 
89  // types
91  typedef list< CRef< CID2S_Chunk_Content > > TContent;
92 
93  // member index
94  enum class E_memberIndex {
95  e__allMandatory = 0,
96  e_id,
97  e_content
98  };
100 
101  // getters
102  // setters
103 
104  /// Check if a value has been assigned to Id data member.
105  ///
106  /// Data member Id is mandatory;
107  /// its type is defined as 'typedef CID2S_Chunk_Id TId'
108  /// @return
109  /// - true, if a value has been assigned.
110  /// - false, otherwise.
111  bool IsSetId(void) const;
112 
113  /// Check if it is safe to call GetId method.
114  ///
115  /// @return
116  /// - true, if the data member is getatable.
117  /// - false, otherwise.
118  bool CanGetId(void) const;
119 
120  /// Reset Id data member.
121  void ResetId(void);
122 
123  /// Get the Id member data.
124  ///
125  /// @return
126  /// Reference to the member data.
127  const TId& GetId(void) const;
128 
129  /// Assign a value to Id data member.
130  ///
131  /// @param value
132  /// Value to assign
133  void SetId(const TId& value);
134 
135  /// Assign a value to Id data member.
136  ///
137  /// @return
138  /// Reference to the data value.
139  TId& SetId(void);
140 
141  /// Check if a value has been assigned to Content data member.
142  ///
143  /// Data member Content is mandatory;
144  /// its type is defined as 'typedef list< CRef< CID2S_Chunk_Content > > TContent'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetContent(void) const;
149 
150  /// Check if it is safe to call GetContent method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetContent(void) const;
156 
157  /// Reset Content data member.
158  void ResetContent(void);
159 
160  /// Get the Content member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TContent& GetContent(void) const;
165 
166  /// Assign a value to Content data member.
167  ///
168  /// @return
169  /// Reference to the data value.
170  TContent& SetContent(void);
171 
172  /// Reset the whole object
173  virtual void Reset(void);
174 
175 
176 private:
177  // Prohibit copy constructor and assignment operator
180 
181  // data
182  Uint4 m_set_State[1];
184  list< CRef< CID2S_Chunk_Content > > m_Content;
185 };
186 
187 /* @} */
188 
189 
190 
191 
192 
193 ///////////////////////////////////////////////////////////
194 ///////////////////// inline methods //////////////////////
195 ///////////////////////////////////////////////////////////
196 inline
198 {
199  return ((m_set_State[0] & 0x3) != 0);
200 }
201 
202 inline
204 {
205  return IsSetId();
206 }
207 
208 inline
210 {
211  m_Id = CID2S_Chunk_Id(0);
212  m_set_State[0] &= ~0x3;
213 }
214 
215 inline
217 {
218  if (!CanGetId()) {
219  ThrowUnassigned(0);
220  }
221  return m_Id;
222 }
223 
224 inline
226 {
227  m_Id = value;
228  m_set_State[0] |= 0x3;
229 }
230 
231 inline
233 {
234  m_set_State[0] |= 0x1;
235  return m_Id;
236 }
237 
238 inline
240 {
241  return ((m_set_State[0] & 0xc) != 0);
242 }
243 
244 inline
246 {
247  return true;
248 }
249 
250 inline
252 {
253  return m_Content;
254 }
255 
256 inline
258 {
259  m_set_State[0] |= 0x4;
260  return m_Content;
261 }
262 
263 ///////////////////////////////////////////////////////////
264 ////////////////// end of inline methods //////////////////
265 ///////////////////////////////////////////////////////////
266 
267 
268 
269 
270 
271 END_objects_SCOPE // namespace ncbi::objects::
272 
274 
275 
276 #endif // OBJECTS_SEQSPLIT_ID2S_CHUNK_INFO_BASE_HPP
User-defined methods of the data storage class.
CID2S_Chunk_Content –.
CID2S_Chunk_Id –.
CID2S_Chunk_Info_Base –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
void ThrowUnassigned(TMemberIndex index) const
const CSeq_id & GetId(const CSeq_loc &loc, CScope *scope)
If all CSeq_ids embedded in CSeq_loc refer to the same CBioseq, returns the first CSeq_id found,...
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_ID2_EXPORT
Definition: ncbi_export.h:552
const TId & GetId(void) const
Get the Id member data.
bool IsSetId(void) const
Check if a value has been assigned to Id data member.
bool CanGetId(void) const
Check if it is safe to call GetId method.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
bool IsSetContent(void) const
Check if a value has been assigned to Content data member.
void ResetId(void)
Reset Id data member.
CID2S_Chunk_Info_Base(const CID2S_Chunk_Info_Base &)
TId & SetId(void)
Assign a value to Id data member.
TContent & SetContent(void)
Assign a value to Content data member.
list< CRef< CID2S_Chunk_Content > > m_Content
const TContent & GetContent(void) const
Get the Content member data.
CID2S_Chunk_Info_Base & operator=(const CID2S_Chunk_Info_Base &)
bool CanGetContent(void) const
Check if it is safe to call GetContent method.
list< CRef< CID2S_Chunk_Content > > TContent
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed May 29 18:41:07 2024 by modify_doxy.py rev. 669887