NCBI C++ ToolKit
TrackConfigSet_.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 TrackConfigSet_.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/gui/objects/gui_objects.asn">gui_objects.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.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 GUI_OBJECTS_TRACKCONFIGSET_BASE_HPP
42 #define GUI_OBJECTS_TRACKCONFIGSET_BASE_HPP
43 
44 // extra headers
45 #include <gui/gui_export.h>
46 
47 // standard includes
48 #include <serial/serialbase.hpp>
49 
50 // generated includes
51 #include <list>
52 
54 
55 #ifndef BEGIN_objects_SCOPE
56 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
57 # define END_objects_SCOPE END_SCOPE(objects)
58 #endif
59 BEGIN_objects_SCOPE // namespace ncbi::objects::
60 
61 
62 // forward declarations
63 class CTrackConfig;
64 
65 
66 // generated classes
67 
68 
69 /** @addtogroup dataspec_NCBI_SeqGraphical
70  *
71  * @{
72  */
73 
74 /////////////////////////////////////////////////////////////////////////////
75 ///
76 /// CTrackConfigSet_Base --
77 ///
78 
80 {
82 public:
83  // constructor
85  // destructor
86  virtual ~CTrackConfigSet_Base(void);
87 
88  // type info
90 
91  // types
92  typedef list< CRef< CTrackConfig > > Tdata;
93 
94  // getters
95  // setters
96 
97  /// Check if a value has been assigned to data member.
98  ///
99  /// Data member is mandatory;
100  /// its type is defined as 'typedef list< CRef< CTrackConfig > > Tdata'
101  /// @return
102  /// - true, if a value has been assigned.
103  /// - false, otherwise.
104  bool IsSet(void) const;
105 
106  /// Check if it is safe to call Get method.
107  ///
108  /// @return
109  /// - true, if the data member is getatable.
110  /// - false, otherwise.
111  bool CanGet(void) const;
112 
113  /// Reset data member.
114  void Reset(void);
115 
116  /// Get the member data.
117  ///
118  /// @return
119  /// Reference to the member data.
120  const Tdata& Get(void) const;
121 
122  /// Assign a value to data member.
123  ///
124  /// @return
125  /// Reference to the data value.
126  Tdata& Set(void);
127 
128  /// Conversion operator to 'const Tdata' type.
129  operator const Tdata& (void) const;
130  /// Conversion operator to 'Tdata' type.
131  operator Tdata& (void);
132 
133 
134 
135 private:
136  // Prohibit copy constructor and assignment operator
139 
140  // data
141  Uint4 m_set_State[1];
142  list< CRef< CTrackConfig > > m_data;
143 };
144 
145 /* @} */
146 
147 
148 
149 
150 
151 ///////////////////////////////////////////////////////////
152 ///////////////////// inline methods //////////////////////
153 ///////////////////////////////////////////////////////////
154 inline
156 {
157  return ((m_set_State[0] & 0x3) != 0);
158 }
159 
160 inline
162 {
163  return true;
164 }
165 
166 inline
168 {
169  return m_data;
170 }
171 
172 inline
174 {
175  m_set_State[0] |= 0x1;
176  return m_data;
177 }
178 
179 inline
180 CTrackConfigSet_Base::operator const CTrackConfigSet_Base::Tdata& (void) const
181 {
182  return m_data;
183 }
184 
185 inline
186 CTrackConfigSet_Base::operator CTrackConfigSet_Base::Tdata& (void)
187 {
188  m_set_State[0] |= 0x1;
189  return m_data;
190 }
191 
192 ///////////////////////////////////////////////////////////
193 ////////////////// end of inline methods //////////////////
194 ///////////////////////////////////////////////////////////
195 
196 
197 
198 
199 
200 END_objects_SCOPE // namespace ncbi::objects::
201 
203 
204 
205 #endif // GUI_OBJECTS_TRACKCONFIGSET_BASE_HPP
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTrackConfigSet_Base –.
CTrackConfig –.
Definition: TrackConfig.hpp:66
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_GUIOBJECTS_EXPORT
Definition: gui_export.h:511
list< CRef< CTrackConfig > > m_data
const Tdata & Get(void) const
Get the member data.
CTrackConfigSet_Base(const CTrackConfigSet_Base &)
CTrackConfigSet_Base & operator=(const CTrackConfigSet_Base &)
Tdata & Set(void)
Assign a value to data member.
list< CRef< CTrackConfig > > Tdata
bool IsSet(void) const
Check if a value has been assigned to data member.
bool CanGet(void) const
Check if it is safe to call Get method.
Defines to provide correct exporting from DLLs in Windows.
const TYPE & Get(const CNamedParameterList *param)
Modified on Thu Feb 22 17:06:54 2024 by modify_doxy.py rev. 669887