NCBI C++ ToolKit
TMgr_CreateRemoteTrackRepl_.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 TMgr_CreateRemoteTrackRepl_.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/trackmgr/trackmgr.asn">trackmgr.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/trackmgr/trackmgr.def">trackmgr.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_TRACKMGR_TMGR_CREATEREMOTETRACKREPL_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_CREATEREMOTETRACKREPL_BASE_HPP
43 
44 // extra headers
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 CTMgr_DisplayTrack;
64 class CTMgr_Message;
65 
66 
67 // generated classes
68 
69 
70 /** @addtogroup dataspec_NCBI_TrackManager
71  *
72  * @{
73  */
74 
75 /////////////////////////////////////////////////////////////////////////////
76 ///-
77 ///- Used to return created hubs, remote tracks, and tracks in hubs
78 ///-
79 ///
80 /// CTMgr_CreateRemoteTrackReply_Base --
81 ///
82 
84 {
86 public:
87  // constructor
89  // destructor
90  virtual ~CTMgr_CreateRemoteTrackReply_Base(void);
91 
92  // type info
94 
95  // types
96  typedef list< CRef< CTMgr_Message > > TMessages;
97  typedef list< CRef< CTMgr_DisplayTrack > > TDisplay_tracks;
98 
99  // member index
100  enum class E_memberIndex {
101  e__allMandatory = 0,
102  e_messages,
103  e_display_tracks
104  };
106 
107  // getters
108  // setters
109 
110  /// Check if a value has been assigned to Messages data member.
111  ///
112  /// Data member Messages is optional;
113  /// its type is defined as 'typedef list< CRef< CTMgr_Message > > TMessages'
114  /// @return
115  /// - true, if a value has been assigned.
116  /// - false, otherwise.
117  bool IsSetMessages(void) const;
118 
119  /// Check if it is safe to call GetMessages method.
120  ///
121  /// @return
122  /// - true, if the data member is getatable.
123  /// - false, otherwise.
124  bool CanGetMessages(void) const;
125 
126  /// Reset Messages data member.
127  void ResetMessages(void);
128 
129  /// Get the Messages member data.
130  ///
131  /// @return
132  /// Reference to the member data.
133  const TMessages& GetMessages(void) const;
134 
135  /// Assign a value to Messages data member.
136  ///
137  /// @return
138  /// Reference to the data value.
139  TMessages& SetMessages(void);
140 
141  /// Check if a value has been assigned to Display_tracks data member.
142  ///
143  /// Data member Display_tracks is optional;
144  /// its type is defined as 'typedef list< CRef< CTMgr_DisplayTrack > > TDisplay_tracks'
145  /// @return
146  /// - true, if a value has been assigned.
147  /// - false, otherwise.
148  bool IsSetDisplay_tracks(void) const;
149 
150  /// Check if it is safe to call GetDisplay_tracks method.
151  ///
152  /// @return
153  /// - true, if the data member is getatable.
154  /// - false, otherwise.
155  bool CanGetDisplay_tracks(void) const;
156 
157  /// Reset Display_tracks data member.
158  void ResetDisplay_tracks(void);
159 
160  /// Get the Display_tracks member data.
161  ///
162  /// @return
163  /// Reference to the member data.
164  const TDisplay_tracks& GetDisplay_tracks(void) const;
165 
166  /// Assign a value to Display_tracks data member.
167  ///
168  /// @return
169  /// Reference to the data value.
170  TDisplay_tracks& SetDisplay_tracks(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];
183  list< CRef< CTMgr_Message > > m_Messages;
184  list< CRef< CTMgr_DisplayTrack > > m_Display_tracks;
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 true;
206 }
207 
208 inline
210 {
211  return m_Messages;
212 }
213 
214 inline
216 {
217  m_set_State[0] |= 0x1;
218  return m_Messages;
219 }
220 
221 inline
223 {
224  return ((m_set_State[0] & 0xc) != 0);
225 }
226 
227 inline
229 {
230  return true;
231 }
232 
233 inline
235 {
236  return m_Display_tracks;
237 }
238 
239 inline
241 {
242  m_set_State[0] |= 0x4;
243  return m_Display_tracks;
244 }
245 
246 ///////////////////////////////////////////////////////////
247 ////////////////// end of inline methods //////////////////
248 ///////////////////////////////////////////////////////////
249 
250 
251 
252 
253 
254 END_objects_SCOPE // namespace ncbi::objects::
255 
257 
258 
259 #endif // OBJECTS_TRACKMGR_TMGR_CREATEREMOTETRACKREPL_BASE_HPP
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_DisplayTrack –.
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
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
bool CanGetDisplay_tracks(void) const
Check if it is safe to call GetDisplay_tracks method.
bool IsSetMessages(void) const
Check if a value has been assigned to Messages data member.
list< CRef< CTMgr_DisplayTrack > > TDisplay_tracks
CTMgr_CreateRemoteTrackReply_Base(const CTMgr_CreateRemoteTrackReply_Base &)
TDisplay_tracks & SetDisplay_tracks(void)
Assign a value to Display_tracks data member.
const TMessages & GetMessages(void) const
Get the Messages member data.
list< CRef< CTMgr_DisplayTrack > > m_Display_tracks
bool CanGetMessages(void) const
Check if it is safe to call GetMessages method.
const TDisplay_tracks & GetDisplay_tracks(void) const
Get the Display_tracks member data.
CTMgr_CreateRemoteTrackReply_Base & operator=(const CTMgr_CreateRemoteTrackReply_Base &)
TMessages & SetMessages(void)
Assign a value to Messages data member.
bool IsSetDisplay_tracks(void) const
Check if a value has been assigned to Display_tracks data member.
Defines to provide correct exporting from DLLs in Windows.
#define NCBI_TRACKMGR_EXPORT
Modified on Sat May 25 14:20:36 2024 by modify_doxy.py rev. 669887