NCBI C++ ToolKit
Cn3d_user_annotations_.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 Cn3d_user_annotations_.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/cn3d/cn3d.asn">cn3d.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cn3d/cn3d.def">cn3d.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_CN3D_CN3D_USER_ANNOTATIONS_BASE_HPP
42 #define OBJECTS_CN3D_CN3D_USER_ANNOTATIONS_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
62 
63 
64 // generated classes
65 
66 
67 /** @addtogroup dataspec_NCBI_Cn3d
68  *
69  * @{
70  */
71 
72 /////////////////////////////////////////////////////////////////////////////
73 /// The list of annotations for a given CDD/mime. If residue regions overlap
74 /// between annotations that are turned on, the last annotation in this list
75 /// that contains these residues will be used as the display style for these
76 /// residues.
77 /// Also contains the current viewpoint, so that user's camera angle
78 /// can be stored and reproduced, for illustrations, on-line figures, etc.
79 ///
80 /// CCn3d_user_annotations_Base --
81 ///
82 
84 {
86 public:
87  // constructor
89  // destructor
90  virtual ~CCn3d_user_annotations_Base(void);
91 
92  // type info
94 
95  // types
96  typedef list< CRef< CCn3d_user_annotation > > TAnnotations;
98 
99  // member index
100  enum class E_memberIndex {
101  e__allMandatory = 0,
102  e_annotations,
103  e_view
104  };
106 
107  // getters
108  // setters
109 
110  /// Check if a value has been assigned to Annotations data member.
111  ///
112  /// Data member Annotations is optional;
113  /// its type is defined as 'typedef list< CRef< CCn3d_user_annotation > > TAnnotations'
114  /// @return
115  /// - true, if a value has been assigned.
116  /// - false, otherwise.
117  bool IsSetAnnotations(void) const;
118 
119  /// Check if it is safe to call GetAnnotations method.
120  ///
121  /// @return
122  /// - true, if the data member is getatable.
123  /// - false, otherwise.
124  bool CanGetAnnotations(void) const;
125 
126  /// Reset Annotations data member.
127  void ResetAnnotations(void);
128 
129  /// Get the Annotations member data.
130  ///
131  /// @return
132  /// Reference to the member data.
133  const TAnnotations& GetAnnotations(void) const;
134 
135  /// Assign a value to Annotations data member.
136  ///
137  /// @return
138  /// Reference to the data value.
139  TAnnotations& SetAnnotations(void);
140 
141  /// Check if a value has been assigned to View data member.
142  ///
143  /// Data member View is optional;
144  /// its type is defined as 'typedef CCn3d_view_settings TView'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetView(void) const;
149 
150  /// Check if it is safe to call GetView method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetView(void) const;
156 
157  /// Reset View data member.
158  void ResetView(void);
159 
160  /// Get the View member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TView& GetView(void) const;
165 
166  /// Assign a value to View data member.
167  ///
168  /// @param value
169  /// Reference to value.
170  void SetView(TView& value);
171 
172  /// Assign a value to View data member.
173  ///
174  /// @return
175  /// Reference to the data value.
176  TView& SetView(void);
177 
178  /// Reset the whole object
179  virtual void Reset(void);
180 
181 
182 private:
183  // Prohibit copy constructor and assignment operator
186 
187  // data
188  Uint4 m_set_State[1];
189  list< CRef< CCn3d_user_annotation > > m_Annotations;
191 };
192 
193 /* @} */
194 
195 
196 
197 
198 
199 ///////////////////////////////////////////////////////////
200 ///////////////////// inline methods //////////////////////
201 ///////////////////////////////////////////////////////////
202 inline
204 {
205  return ((m_set_State[0] & 0x3) != 0);
206 }
207 
208 inline
210 {
211  return true;
212 }
213 
214 inline
216 {
217  return m_Annotations;
218 }
219 
220 inline
222 {
223  m_set_State[0] |= 0x1;
224  return m_Annotations;
225 }
226 
227 inline
229 {
230  return m_View.NotEmpty();
231 }
232 
233 inline
235 {
236  return IsSetView();
237 }
238 
239 inline
241 {
242  if (!CanGetView()) {
243  ThrowUnassigned(1);
244  }
245  return (*m_View);
246 }
247 
248 ///////////////////////////////////////////////////////////
249 ////////////////// end of inline methods //////////////////
250 ///////////////////////////////////////////////////////////
251 
252 
253 
254 
255 
256 END_objects_SCOPE // namespace ncbi::objects::
257 
259 
260 
261 #endif // OBJECTS_CN3D_CN3D_USER_ANNOTATIONS_BASE_HPP
CCn3d_user_annotation –.
The list of annotations for a given CDD/mime.
CCn3d_view_settings –.
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
char value[7]
Definition: config.c:431
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_CN3D_EXPORT
Definition: ncbi_export.h:384
const TView & GetView(void) const
Get the View member data.
bool CanGetAnnotations(void) const
Check if it is safe to call GetAnnotations method.
const TAnnotations & GetAnnotations(void) const
Get the Annotations member data.
CCn3d_user_annotations_Base(const CCn3d_user_annotations_Base &)
TAnnotations & SetAnnotations(void)
Assign a value to Annotations data member.
list< CRef< CCn3d_user_annotation > > TAnnotations
CCn3d_user_annotations_Base & operator=(const CCn3d_user_annotations_Base &)
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
list< CRef< CCn3d_user_annotation > > m_Annotations
bool IsSetView(void) const
Check if a value has been assigned to View data member.
bool IsSetAnnotations(void) const
Check if a value has been assigned to Annotations data member.
bool CanGetView(void) const
Check if it is safe to call GetView method.
Modified on Sat Mar 02 10:54:20 2024 by modify_doxy.py rev. 669887