NCBI C++ ToolKit
SeqEdit_Cmd_RemoveSeqEntry_.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 SeqEdit_Cmd_RemoveSeqEntry_.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/seqedit/seqedit.asn">seqedit.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqedit/seqedit.def">seqedit.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_SEQEDIT_SEQEDIT_CMD_REMOVESEQENTRY_BASE_HPP
42 #define OBJECTS_SEQEDIT_SEQEDIT_CMD_REMOVESEQENTRY_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
47 
48 #ifndef BEGIN_objects_SCOPE
49 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
50 # define END_objects_SCOPE END_SCOPE(objects)
51 #endif
52 BEGIN_objects_SCOPE // namespace ncbi::objects::
53 
54 
55 // forward declarations
56 class CSeqEdit_Id;
57 
58 
59 // generated classes
60 
61 
62 /** @addtogroup dataspec_NCBI_SeqEdit
63  *
64  * @{
65  */
66 
67 /////////////////////////////////////////////////////////////////////////////
68 /// Remove a seq entry from bioseq-set
69 ///
70 /// CSeqEdit_Cmd_RemoveSeqEntry_Base --
71 ///
72 
74 {
76 public:
77  // constructor
79  // destructor
80  virtual ~CSeqEdit_Cmd_RemoveSeqEntry_Base(void);
81 
82  // type info
84 
85  // types
86  typedef CSeqEdit_Id TId;
88 
89  // member index
90  enum class E_memberIndex {
91  e__allMandatory = 0,
92  e_id,
93  e_entry_id
94  };
96 
97  // getters
98  // setters
99 
100  /// Bioseq_set id
101  /// Check if a value has been assigned to Id data member.
102  ///
103  /// Data member Id is mandatory;
104  /// its type is defined as 'typedef CSeqEdit_Id TId'
105  /// @return
106  /// - true, if a value has been assigned.
107  /// - false, otherwise.
108  bool IsSetId(void) const;
109 
110  /// Check if it is safe to call GetId method.
111  ///
112  /// @return
113  /// - true, if the data member is getatable.
114  /// - false, otherwise.
115  bool CanGetId(void) const;
116 
117  /// Reset Id data member.
118  void ResetId(void);
119 
120  /// Get the Id member data.
121  ///
122  /// @return
123  /// Reference to the member data.
124  const TId& GetId(void) const;
125 
126  /// Assign a value to Id data member.
127  ///
128  /// @param value
129  /// Reference to value.
130  void SetId(TId& value);
131 
132  /// Assign a value to Id data member.
133  ///
134  /// @return
135  /// Reference to the data value.
136  TId& SetId(void);
137 
138  /// Seq_entry for deletion
139  /// Check if a value has been assigned to Entry_id data member.
140  ///
141  /// Data member Entry_id is mandatory;
142  /// its type is defined as 'typedef CSeqEdit_Id TEntry_id'
143  /// @return
144  /// - true, if a value has been assigned.
145  /// - false, otherwise.
146  bool IsSetEntry_id(void) const;
147 
148  /// Check if it is safe to call GetEntry_id method.
149  ///
150  /// @return
151  /// - true, if the data member is getatable.
152  /// - false, otherwise.
153  bool CanGetEntry_id(void) const;
154 
155  /// Reset Entry_id data member.
156  void ResetEntry_id(void);
157 
158  /// Get the Entry_id member data.
159  ///
160  /// @return
161  /// Reference to the member data.
162  const TEntry_id& GetEntry_id(void) const;
163 
164  /// Assign a value to Entry_id data member.
165  ///
166  /// @param value
167  /// Reference to value.
168  void SetEntry_id(TEntry_id& value);
169 
170  /// Assign a value to Entry_id data member.
171  ///
172  /// @return
173  /// Reference to the data value.
174  TEntry_id& SetEntry_id(void);
175 
176  /// Reset the whole object
177  virtual void Reset(void);
178 
179 
180 private:
181  // Prohibit copy constructor and assignment operator
184 
185  // data
186  Uint4 m_set_State[1];
189 };
190 
191 /* @} */
192 
193 
194 
195 
196 
197 ///////////////////////////////////////////////////////////
198 ///////////////////// inline methods //////////////////////
199 ///////////////////////////////////////////////////////////
200 inline
202 {
203  return m_Id.NotEmpty();
204 }
205 
206 inline
208 {
209  return true;
210 }
211 
212 inline
214 {
215  if ( !m_Id ) {
216  const_cast<CSeqEdit_Cmd_RemoveSeqEntry_Base*>(this)->ResetId();
217  }
218  return (*m_Id);
219 }
220 
221 inline
223 {
224  if ( !m_Id ) {
225  ResetId();
226  }
227  return (*m_Id);
228 }
229 
230 inline
232 {
233  return m_Entry_id.NotEmpty();
234 }
235 
236 inline
238 {
239  return true;
240 }
241 
242 inline
244 {
245  if ( !m_Entry_id ) {
246  const_cast<CSeqEdit_Cmd_RemoveSeqEntry_Base*>(this)->ResetEntry_id();
247  }
248  return (*m_Entry_id);
249 }
250 
251 inline
253 {
254  if ( !m_Entry_id ) {
255  ResetEntry_id();
256  }
257  return (*m_Entry_id);
258 }
259 
260 ///////////////////////////////////////////////////////////
261 ////////////////// end of inline methods //////////////////
262 ///////////////////////////////////////////////////////////
263 
264 
265 
266 
267 
268 END_objects_SCOPE // namespace ncbi::objects::
269 
271 
272 
273 #endif // OBJECTS_SEQEDIT_SEQEDIT_CMD_REMOVESEQENTRY_BASE_HPP
CRef –.
Definition: ncbiobj.hpp:618
Remove a seq entry from bioseq-set.
CSeqEdit_Id –.
Definition: SeqEdit_Id.hpp:66
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_SEQEDIT_EXPORT
Definition: ncbi_export.h:801
CSeqEdit_Cmd_RemoveSeqEntry_Base(const CSeqEdit_Cmd_RemoveSeqEntry_Base &)
const TId & GetId(void) const
Get the Id member data.
const TEntry_id & GetEntry_id(void) const
Get the Entry_id member data.
Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
void ResetId(void)
Reset Id data member.
bool CanGetEntry_id(void) const
Check if it is safe to call GetEntry_id method.
TEntry_id & SetEntry_id(void)
Assign a value to Entry_id data member.
TId & SetId(void)
Assign a value to Id data member.
bool IsSetId(void) const
Bioseq_set id Check if a value has been assigned to Id data member.
void ResetEntry_id(void)
Reset Entry_id data member.
bool IsSetEntry_id(void) const
Seq_entry for deletion Check if a value has been assigned to Entry_id data member.
bool CanGetId(void) const
Check if it is safe to call GetId method.
CSeqEdit_Cmd_RemoveSeqEntry_Base & operator=(const CSeqEdit_Cmd_RemoveSeqEntry_Base &)
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Tue May 28 05:51:57 2024 by modify_doxy.py rev. 669887