#ifndef DESC_CI__HPP #define DESC_CI__HPP /* $Id: seq_descr_ci.hpp 36009 2007-11-08 15:42:46Z vasilche $ * =========================================================================== * * PUBLIC DOMAIN NOTICE * National Center for Biotechnology Information * * This software/database is a "United States Government Work" under the * terms of the United States Copyright Act. It was written as part of * the author's official duties as a United States Government employee and * thus cannot be copyrighted. This software/database is freely available * to the public for use. The National Library of Medicine and the U.S. * Government have not placed any restriction on its use or reproduction. * * Although all reasonable efforts have been taken to ensure the accuracy * and reliability of the software and data, the NLM and the U.S. * Government do not and cannot warrant the performance or results that * may be obtained by using this software or data. The NLM and the U.S. * Government disclaim all warranties, express or implied, including * warranties of performance, merchantability or fitness for any particular * purpose. * * Please cite the author in any work or product based on this material. * * =========================================================================== * * Author: Aleksey Grichenko, Michael Kimelman * * File Description: * Object manager iterators * */ #include <objects/seq/Seq_descr.hpp> #include <objmgr/bioseq_handle.hpp> #include <objmgr/bioseq_set_handle.hpp> #include <objmgr/seq_entry_handle.hpp> #include <objmgr/impl/bioseq_base_info.hpp> #include <corelib/ncbistd.hpp> BEGIN_NCBI_SCOPE BEGIN_SCOPE(objects) /** @addtogroup ObjectManagerIterators * * @{ */ class CBioseq_Handle; class CSeqdesc_CI; class CBioseq_Base_Info; ///////////////////////////////////////////////////////////////////////////// /// /// CSeq_descr_CI -- /// /// Enumerate CSeq_descr objects from a Bioseq or Seq-entry handle /// class NCBI_XOBJMGR_EXPORT CSeq_descr_CI { public: /// Create an empty iterator CSeq_descr_CI(void); /// Create an iterator that enumerates CSeq_descr objects /// from a bioseq with limit number of seq-entries /// to "search_depth" (0 = unlimited). explicit CSeq_descr_CI(const CBioseq_Handle& handle, size_t search_depth = 0); /// Create an iterator that enumerates CSeq_descr objects /// from a bioseq with limit number of seq-entries /// to "search_depth" (0 = unlimited). explicit CSeq_descr_CI(const CBioseq_set_Handle& handle, size_t search_depth = 0); /// Create an iterator that enumerates CSeq_descr objects /// from a seq-entry, limit number of seq-entries /// to "search_depth" (0 = unlimited). explicit CSeq_descr_CI(const CSeq_entry_Handle& entry, size_t search_depth = 0); CSeq_descr_CI(const CSeq_descr_CI& iter); ~CSeq_descr_CI(void); CSeq_descr_CI& operator= (const CSeq_descr_CI& iter); /// Move to the next object in iterated sequence CSeq_descr_CI& operator++ (void); /// Check if iterator points to an object DECLARE_OPERATOR_BOOL_REF(m_CurrentBase); const CSeq_descr& operator* (void) const; const CSeq_descr* operator-> (void) const; CSeq_entry_Handle GetSeq_entry_Handle(void) const; private: friend class CSeqdesc_CI; // Move to the next entry containing a descriptor void x_Next(void); void x_Step(void); void x_Settle(void); const CBioseq_Base_Info& x_GetBaseInfo(void) const; CConstRef<CBioseq_Base_Info> m_CurrentBase; CBioseq_Handle m_CurrentSeq; CBioseq_set_Handle m_CurrentSet; size_t m_ParentLimit; }; inline CSeq_descr_CI& CSeq_descr_CI::operator++(void) { x_Next(); return *this; } inline const CBioseq_Base_Info& CSeq_descr_CI::x_GetBaseInfo(void) const { return *m_CurrentBase; } inline const CSeq_descr& CSeq_descr_CI::operator* (void) const { return x_GetBaseInfo().GetDescr(); } inline const CSeq_descr* CSeq_descr_CI::operator-> (void) const { return &x_GetBaseInfo().GetDescr(); } /* @} */ END_SCOPE(objects) END_NCBI_SCOPE #endif // DESC_CI__HPP
0001 0002 0003 0004 0005 0006 0007 0008 0009 0010 0011 0012 0013 0014 0015 0016 0017 0018 0019 0020 0021 0022 0023 0024 0025 0026 0027 0028 0029 0030 0031 0032 0033 0034 0035 0036 0037 0038 0039 0040 0041 0042 0043 0044 0045 0046 0047 0048 0049 0050 0051 0052 0053 0054 0055 0056 0057 0058 0059 0060 0061 0062 0063 0064 0065 0066 0067 0068 0069 0070 0071 0072 0073 0074 0075 0076 0077 0078 0079 0080 0081 0082 0083 0084 0085 0086 0087 0088 0089 0090 0091 0092 0093 0094 0095 0096 0097 0098 0099 0100 0101 0102 0103 0104 0105 0106 0107 0108 0109 0110 0111 0112 0113 0114 0115 0116 0117 0118 0119 0120 0121 0122 0123 0124 0125 0126 0127 0128 0129 0130 0131 0132 0133 0134 0135 0136 0137 0138 0139 0140 0141 0142 0143 0144 0145 0146 0147 0148 0149 0150 0151 0152 0153 0154 0155 0156