NCBI C++ ToolKit
Biostruc_residue_graph_set_.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 Biostruc_residue_graph_set_.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/mmdb1/mmdb1.asn">mmdb1.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mmdb1/mmdb1.def">mmdb1.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_MMDB1_BIOSTRUC_RESIDUE_GRAPH_SET_BASE_HPP
42 #define OBJECTS_MMDB1_BIOSTRUC_RESIDUE_GRAPH_SET_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 CBiomol_descr;
61 class CBiostruc_id;
62 class CResidue_graph;
63 
64 
65 // generated classes
66 
67 
68 /** @addtogroup dataspec_MMDB
69  *
70  * @{
71  */
72 
73 /////////////////////////////////////////////////////////////////////////////
74 /// A biostruc residue graph set is a collection of residue graphs. The object
75 /// type is intended as a means to record dictionaries containing the chemical
76 /// subgraphs of "standard" residue types, which are used as a means to
77 /// simplify discription of the covalent structure of a biomolecular assembly.
78 /// The standard residue graph dictionary supplied with the MMDB database
79 /// contains 20 standard L amino acids and 8 standard ribonucleotide groups.
80 /// These graphs are complete, including explicit hydrogen atoms and separate
81 /// instances for the terminal polypeptide and polynucleotide residues.
82 ///
83 /// CBiostruc_residue_graph_set_Base --
84 ///
85 
87 {
89 public:
90  // constructor
92  // destructor
93  virtual ~CBiostruc_residue_graph_set_Base(void);
94 
95  // type info
97 
98  // types
99  typedef list< CRef< CBiostruc_id > > TId;
100  typedef list< CRef< CBiomol_descr > > TDescr;
101  typedef list< CRef< CResidue_graph > > TResidue_graphs;
102 
103  // member index
104  enum class E_memberIndex {
105  e__allMandatory = 0,
106  e_id,
107  e_descr,
108  e_residue_graphs
109  };
111 
112  // getters
113  // setters
114 
115  /// Check if a value has been assigned to Id data member.
116  ///
117  /// Data member Id is optional;
118  /// its type is defined as 'typedef list< CRef< CBiostruc_id > > TId'
119  /// @return
120  /// - true, if a value has been assigned.
121  /// - false, otherwise.
122  bool IsSetId(void) const;
123 
124  /// Check if it is safe to call GetId method.
125  ///
126  /// @return
127  /// - true, if the data member is getatable.
128  /// - false, otherwise.
129  bool CanGetId(void) const;
130 
131  /// Reset Id data member.
132  void ResetId(void);
133 
134  /// Get the Id member data.
135  ///
136  /// @return
137  /// Reference to the member data.
138  const TId& GetId(void) const;
139 
140  /// Assign a value to Id data member.
141  ///
142  /// @return
143  /// Reference to the data value.
144  TId& SetId(void);
145 
146  /// Check if a value has been assigned to Descr data member.
147  ///
148  /// Data member Descr is optional;
149  /// its type is defined as 'typedef list< CRef< CBiomol_descr > > TDescr'
150  /// @return
151  /// - true, if a value has been assigned.
152  /// - false, otherwise.
153  bool IsSetDescr(void) const;
154 
155  /// Check if it is safe to call GetDescr method.
156  ///
157  /// @return
158  /// - true, if the data member is getatable.
159  /// - false, otherwise.
160  bool CanGetDescr(void) const;
161 
162  /// Reset Descr data member.
163  void ResetDescr(void);
164 
165  /// Get the Descr member data.
166  ///
167  /// @return
168  /// Reference to the member data.
169  const TDescr& GetDescr(void) const;
170 
171  /// Assign a value to Descr data member.
172  ///
173  /// @return
174  /// Reference to the data value.
175  TDescr& SetDescr(void);
176 
177  /// Check if a value has been assigned to Residue_graphs data member.
178  ///
179  /// Data member Residue_graphs is mandatory;
180  /// its type is defined as 'typedef list< CRef< CResidue_graph > > TResidue_graphs'
181  /// @return
182  /// - true, if a value has been assigned.
183  /// - false, otherwise.
184  bool IsSetResidue_graphs(void) const;
185 
186  /// Check if it is safe to call GetResidue_graphs method.
187  ///
188  /// @return
189  /// - true, if the data member is getatable.
190  /// - false, otherwise.
191  bool CanGetResidue_graphs(void) const;
192 
193  /// Reset Residue_graphs data member.
194  void ResetResidue_graphs(void);
195 
196  /// Get the Residue_graphs member data.
197  ///
198  /// @return
199  /// Reference to the member data.
200  const TResidue_graphs& GetResidue_graphs(void) const;
201 
202  /// Assign a value to Residue_graphs data member.
203  ///
204  /// @return
205  /// Reference to the data value.
206  TResidue_graphs& SetResidue_graphs(void);
207 
208  /// Reset the whole object
209  virtual void Reset(void);
210 
211 
212 private:
213  // Prohibit copy constructor and assignment operator
216 
217  // data
218  Uint4 m_set_State[1];
219  list< CRef< CBiostruc_id > > m_Id;
220  list< CRef< CBiomol_descr > > m_Descr;
221  list< CRef< CResidue_graph > > m_Residue_graphs;
222 };
223 
224 /* @} */
225 
226 
227 
228 
229 
230 ///////////////////////////////////////////////////////////
231 ///////////////////// inline methods //////////////////////
232 ///////////////////////////////////////////////////////////
233 inline
235 {
236  return ((m_set_State[0] & 0x3) != 0);
237 }
238 
239 inline
241 {
242  return true;
243 }
244 
245 inline
247 {
248  return m_Id;
249 }
250 
251 inline
253 {
254  m_set_State[0] |= 0x1;
255  return m_Id;
256 }
257 
258 inline
260 {
261  return ((m_set_State[0] & 0xc) != 0);
262 }
263 
264 inline
266 {
267  return true;
268 }
269 
270 inline
272 {
273  return m_Descr;
274 }
275 
276 inline
278 {
279  m_set_State[0] |= 0x4;
280  return m_Descr;
281 }
282 
283 inline
285 {
286  return ((m_set_State[0] & 0x30) != 0);
287 }
288 
289 inline
291 {
292  return true;
293 }
294 
295 inline
297 {
298  return m_Residue_graphs;
299 }
300 
301 inline
303 {
304  m_set_State[0] |= 0x10;
305  return m_Residue_graphs;
306 }
307 
308 ///////////////////////////////////////////////////////////
309 ////////////////// end of inline methods //////////////////
310 ///////////////////////////////////////////////////////////
311 
312 
313 
314 
315 
316 END_objects_SCOPE // namespace ncbi::objects::
317 
319 
320 
321 #endif // OBJECTS_MMDB1_BIOSTRUC_RESIDUE_GRAPH_SET_BASE_HPP
CBiomol_descr –.
CBiostruc_id –.
Definition: Biostruc_id.hpp:66
A biostruc residue graph set is a collection of residue graphs.
CResidue_graph –.
Base class for all serializable objects.
Definition: serialbase.hpp:150
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_MMDB1_EXPORT
Definition: ncbi_export.h:624
bool CanGetDescr(void) const
Check if it is safe to call GetDescr method.
const TResidue_graphs & GetResidue_graphs(void) const
Get the Residue_graphs member data.
const TId & GetId(void) const
Get the Id member data.
bool CanGetResidue_graphs(void) const
Check if it is safe to call GetResidue_graphs method.
bool IsSetResidue_graphs(void) const
Check if a value has been assigned to Residue_graphs data member.
TResidue_graphs & SetResidue_graphs(void)
Assign a value to Residue_graphs data member.
TDescr & SetDescr(void)
Assign a value to Descr data member.
CBiostruc_residue_graph_set_Base(const CBiostruc_residue_graph_set_Base &)
Tparent::CMemberIndex< E_memberIndex, 4 > TmemberIndex
bool IsSetDescr(void) const
Check if a value has been assigned to Descr data member.
CBiostruc_residue_graph_set_Base & operator=(const CBiostruc_residue_graph_set_Base &)
TId & SetId(void)
Assign a value to Id data member.
list< CRef< CResidue_graph > > TResidue_graphs
list< CRef< CResidue_graph > > m_Residue_graphs
const TDescr & GetDescr(void) const
Get the Descr 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.
Modified on Mon Jun 17 05:05:25 2024 by modify_doxy.py rev. 669887