NCBI C++ ToolKit
TMgr_Identity_.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_Identity_.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_IDENTITY_BASE_HPP
42 #define OBJECTS_TRACKMGR_TMGR_IDENTITY_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_IdentityId;
64 
65 
66 // generated classes
67 
68 
69 /** @addtogroup dataspec_NCBI_TrackManager
70  *
71  * @{
72  */
73 
74 /////////////////////////////////////////////////////////////////////////////
75 ///
76 /// CTMgr_Identity_Base --
77 ///
78 
80 {
82 public:
83  // constructor
84  CTMgr_Identity_Base(void);
85  // destructor
86  virtual ~CTMgr_Identity_Base(void);
87 
88  // type info
90 
91  // types
93  typedef list< CRef< CTMgr_IdentityId > > TIds;
94 
95  // member index
96  enum class E_memberIndex {
97  e__allMandatory = 0,
98  e_ids
99  };
101 
102  // getters
103  // setters
104 
105  /// Check if a value has been assigned to Ids data member.
106  ///
107  /// Data member Ids is mandatory;
108  /// its type is defined as 'typedef list< CRef< CTMgr_IdentityId > > TIds'
109  /// @return
110  /// - true, if a value has been assigned.
111  /// - false, otherwise.
112  bool IsSetIds(void) const;
113 
114  /// Check if it is safe to call GetIds method.
115  ///
116  /// @return
117  /// - true, if the data member is getatable.
118  /// - false, otherwise.
119  bool CanGetIds(void) const;
120 
121  /// Reset Ids data member.
122  void ResetIds(void);
123 
124  /// Get the Ids member data.
125  ///
126  /// @return
127  /// Reference to the member data.
128  const TIds& GetIds(void) const;
129 
130  /// Assign a value to Ids data member.
131  ///
132  /// @return
133  /// Reference to the data value.
134  TIds& SetIds(void);
135 
136  /// Reset the whole object
137  virtual void Reset(void);
138 
139 
140 private:
141  // Prohibit copy constructor and assignment operator
144 
145  // data
146  Uint4 m_set_State[1];
147  list< CRef< CTMgr_IdentityId > > m_Ids;
148 };
149 
150 /* @} */
151 
152 
153 
154 
155 
156 ///////////////////////////////////////////////////////////
157 ///////////////////// inline methods //////////////////////
158 ///////////////////////////////////////////////////////////
159 inline
161 {
162  return ((m_set_State[0] & 0x3) != 0);
163 }
164 
165 inline
167 {
168  return true;
169 }
170 
171 inline
173 {
174  return m_Ids;
175 }
176 
177 inline
179 {
180  m_set_State[0] |= 0x1;
181  return m_Ids;
182 }
183 
184 ///////////////////////////////////////////////////////////
185 ////////////////// end of inline methods //////////////////
186 ///////////////////////////////////////////////////////////
187 
188 
189 
190 
191 
192 END_objects_SCOPE // namespace ncbi::objects::
193 
195 
196 
197 #endif // OBJECTS_TRACKMGR_TMGR_IDENTITY_BASE_HPP
Base class for all serializable objects.
Definition: serialbase.hpp:150
CTMgr_Identity_Base –.
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
bool CanGetIds(void) const
Check if it is safe to call GetIds method.
bool IsSetIds(void) const
Check if a value has been assigned to Ids data member.
list< CRef< CTMgr_IdentityId > > m_Ids
CSerialObject Tparent
TIds & SetIds(void)
Assign a value to Ids data member.
list< CRef< CTMgr_IdentityId > > TIds
const TIds & GetIds(void) const
Get the Ids member data.
CTMgr_Identity_Base & operator=(const CTMgr_Identity_Base &)
CTMgr_IdentityId C_E
Tparent::CMemberIndex< E_memberIndex, 2 > TmemberIndex
CTMgr_Identity_Base(const CTMgr_Identity_Base &)
static bool GetIds(const T &d, set< string > &labels, const string name="", bool detect=false, bool found=false)
Defines to provide correct exporting from DLLs in Windows.
#define NCBI_TRACKMGR_EXPORT
Modified on Mon May 20 05:05:00 2024 by modify_doxy.py rev. 669887