NCBI C++ ToolKit
GC_Assemblies_.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 GC_Assemblies_.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/genomecoll/genome_collection.asn">genome_collection.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/genomecoll/genome_collection.def">genome_collection.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_GENOMECOLL_GC_ASSEMBLIES_BASE_HPP
42 #define OBJECTS_GENOMECOLL_GC_ASSEMBLIES_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <list>
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 CGC_Assembly;
61 class CGC_Query;
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_GenomeCollection
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 ///
74 /// CGC_Assemblies_Base --
75 ///
76 
78 {
80 public:
81  // constructor
82  CGC_Assemblies_Base(void);
83  // destructor
84  virtual ~CGC_Assemblies_Base(void);
85 
86  // type info
88 
89  // types
90  typedef list< CRef< CGC_Query > > TQuery;
91  typedef list< CRef< CGC_Assembly > > TAssemblies;
92 
93  // member index
94  enum class E_memberIndex {
95  e__allMandatory = 0,
96  e_query,
97  e_assemblies
98  };
100 
101  // getters
102  // setters
103 
104  /// Check if a value has been assigned to Query data member.
105  ///
106  /// Data member Query is optional;
107  /// its type is defined as 'typedef list< CRef< CGC_Query > > TQuery'
108  /// @return
109  /// - true, if a value has been assigned.
110  /// - false, otherwise.
111  bool IsSetQuery(void) const;
112 
113  /// Check if it is safe to call GetQuery method.
114  ///
115  /// @return
116  /// - true, if the data member is getatable.
117  /// - false, otherwise.
118  bool CanGetQuery(void) const;
119 
120  /// Reset Query data member.
121  void ResetQuery(void);
122 
123  /// Get the Query member data.
124  ///
125  /// @return
126  /// Reference to the member data.
127  const TQuery& GetQuery(void) const;
128 
129  /// Assign a value to Query data member.
130  ///
131  /// @return
132  /// Reference to the data value.
133  TQuery& SetQuery(void);
134 
135  /// Check if a value has been assigned to Assemblies data member.
136  ///
137  /// Data member Assemblies is mandatory;
138  /// its type is defined as 'typedef list< CRef< CGC_Assembly > > TAssemblies'
139  /// @return
140  /// - true, if a value has been assigned.
141  /// - false, otherwise.
142  bool IsSetAssemblies(void) const;
143 
144  /// Check if it is safe to call GetAssemblies method.
145  ///
146  /// @return
147  /// - true, if the data member is getatable.
148  /// - false, otherwise.
149  bool CanGetAssemblies(void) const;
150 
151  /// Reset Assemblies data member.
152  void ResetAssemblies(void);
153 
154  /// Get the Assemblies member data.
155  ///
156  /// @return
157  /// Reference to the member data.
158  const TAssemblies& GetAssemblies(void) const;
159 
160  /// Assign a value to Assemblies data member.
161  ///
162  /// @return
163  /// Reference to the data value.
164  TAssemblies& SetAssemblies(void);
165 
166  /// Reset the whole object
167  virtual void Reset(void);
168 
169 
170 private:
171  // Prohibit copy constructor and assignment operator
174 
175  // data
176  Uint4 m_set_State[1];
177  list< CRef< CGC_Query > > m_Query;
178  list< CRef< CGC_Assembly > > m_Assemblies;
179 };
180 
181 /* @} */
182 
183 
184 
185 
186 
187 ///////////////////////////////////////////////////////////
188 ///////////////////// inline methods //////////////////////
189 ///////////////////////////////////////////////////////////
190 inline
192 {
193  return ((m_set_State[0] & 0x3) != 0);
194 }
195 
196 inline
198 {
199  return true;
200 }
201 
202 inline
204 {
205  return m_Query;
206 }
207 
208 inline
210 {
211  m_set_State[0] |= 0x1;
212  return m_Query;
213 }
214 
215 inline
217 {
218  return ((m_set_State[0] & 0xc) != 0);
219 }
220 
221 inline
223 {
224  return true;
225 }
226 
227 inline
229 {
230  return m_Assemblies;
231 }
232 
233 inline
235 {
236  m_set_State[0] |= 0x4;
237  return m_Assemblies;
238 }
239 
240 ///////////////////////////////////////////////////////////
241 ////////////////// end of inline methods //////////////////
242 ///////////////////////////////////////////////////////////
243 
244 
245 
246 
247 
248 END_objects_SCOPE // namespace ncbi::objects::
249 
251 
252 
253 #endif // OBJECTS_GENOMECOLL_GC_ASSEMBLIES_BASE_HPP
CGC_Assemblies_Base –.
CGC_Query –.
Definition: GC_Query.hpp:66
Base class for all serializable objects.
Definition: serialbase.hpp:150
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_GENOME_COLLECTION_EXPORT
Definition: ncbi_export.h:528
bool IsSetAssemblies(void) const
Check if a value has been assigned to Assemblies data member.
CGC_Assemblies_Base & operator=(const CGC_Assemblies_Base &)
list< CRef< CGC_Query > > TQuery
TQuery & SetQuery(void)
Assign a value to Query data member.
const TQuery & GetQuery(void) const
Get the Query member data.
const TAssemblies & GetAssemblies(void) const
Get the Assemblies member data.
list< CRef< CGC_Query > > m_Query
CGC_Assemblies_Base(const CGC_Assemblies_Base &)
list< CRef< CGC_Assembly > > m_Assemblies
bool CanGetAssemblies(void) const
Check if it is safe to call GetAssemblies method.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
bool CanGetQuery(void) const
Check if it is safe to call GetQuery method.
bool IsSetQuery(void) const
Check if a value has been assigned to Query data member.
list< CRef< CGC_Assembly > > TAssemblies
TAssemblies & SetAssemblies(void)
Assign a value to Assemblies data member.
CSerialObject Tparent
Modified on Fri Jul 19 17:15:02 2024 by modify_doxy.py rev. 669887