Seq_feat.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:7k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: Seq_feat.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:23:55  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.16
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: Seq_feat.hpp,v 1000.1 2004/04/12 17:23:55 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Author:  .......
  35.  *
  36.  * File Description:
  37.  *   .......
  38.  *
  39.  * Remark:
  40.  *   This code was originally generated by application DATATOOL
  41.  *   using specifications from the ASN data definition file
  42.  *   'seqfeat.asn'.
  43.  */
  44. #ifndef OBJECTS_SEQFEAT_SEQ_FEAT_HPP
  45. #define OBJECTS_SEQFEAT_SEQ_FEAT_HPP
  46. // generated includes
  47. #include <objects/seqfeat/Seq_feat_.hpp>
  48. #include <objects/seqfeat/Gene_ref.hpp>
  49. #include <objects/seqfeat/Prot_ref.hpp>
  50. #include <objects/seqfeat/SeqFeatData.hpp>
  51. #include <objects/seqloc/Seq_loc.hpp>
  52. // generated classes
  53. BEGIN_NCBI_SCOPE
  54. BEGIN_objects_SCOPE // namespace ncbi::objects::
  55. class NCBI_SEQFEAT_EXPORT CSeq_feat : public CSeq_feat_Base
  56. {
  57.     typedef CSeq_feat_Base Tparent;
  58. public:
  59.     // constructor
  60.     CSeq_feat(void);
  61.     // destructor
  62.     ~CSeq_feat(void);
  63.     
  64.     //
  65.     // See related function in util/feature.hpp
  66.     //
  67.     //   void GetLabel (const CSeq_feat&, string*, ELabelType, CScope*)
  68.     //
  69.     // get gene (if present) from Seq-feat.xref list
  70.     const CGene_ref* GetGeneXref(void) const;
  71.     void SetGeneXref(CGene_ref& value);
  72.     CGene_ref& SetGeneXref(void);
  73.     // get protein (if present) from Seq-feat.xref list
  74.     const CProt_ref* GetProtXref(void) const;
  75.     void SetProtXref(CProt_ref& value);
  76.     CProt_ref& SetProtXref(void);
  77.     // Add a qualifier to this feature
  78.     void AddQualifier(const string& qual_name, const string& qual_val);
  79.     // add a DB xref to this feature
  80.     void AddDbxref(const string& db_name, const string& db_key);
  81.     void AddDbxref(const string& db_name, int db_key);
  82.     // Optional locations are used for features with locations
  83.     // re-mapped to a master sequence
  84.     int CompareNonLocation(const CSeq_feat& f2,
  85.                            const CSeq_loc& loc1, const CSeq_loc& loc2) const;
  86.     int GetTypeSortingOrder(void) const;
  87.     static int GetTypeSortingOrder(CSeqFeatData::E_Choice type);
  88.     int Compare(const CSeq_feat& f2) const;
  89.     int Compare(const CSeq_feat& f2,
  90.                 const CSeq_loc& mapped1, const CSeq_loc& mapped2) const;
  91. private:
  92.     // Prohibit copy constructor and assignment operator
  93.     CSeq_feat(const CSeq_feat& value);
  94.     CSeq_feat& operator=(const CSeq_feat& value);        
  95. };
  96. /////////////////// CSeq_feat inline methods
  97. // constructor
  98. inline
  99. CSeq_feat::CSeq_feat(void)
  100. {
  101. }
  102. // Corresponds to SortFeatItemListByPos from the C toolkit
  103. inline
  104. int CSeq_feat::Compare(const CSeq_feat& f2,
  105.                        const CSeq_loc& loc1, const CSeq_loc& loc2) const
  106. {
  107.     int diff = loc1.Compare(loc2);
  108.     return diff != 0? diff: CompareNonLocation(f2, loc1, loc2);
  109. }
  110. // Corresponds to SortFeatItemListByPos from the C toolkit
  111. inline
  112. int CSeq_feat::Compare(const CSeq_feat& f2) const
  113. {
  114.     return Compare(f2, GetLocation(), f2.GetLocation());
  115. }
  116. inline
  117. int CSeq_feat::GetTypeSortingOrder(void) const
  118. {
  119.     return GetTypeSortingOrder(GetData().Which());
  120. }
  121. NCBI_SEQFEAT_EXPORT
  122. inline
  123. bool operator< (const CSeq_feat& f1, const CSeq_feat& f2)
  124. {
  125.     return f1.Compare(f2) < 0;
  126. }
  127. /////////////////// end of CSeq_feat inline methods
  128. END_objects_SCOPE // namespace ncbi::objects::
  129. END_NCBI_SCOPE
  130. #endif // OBJECTS_SEQFEAT_SEQ_FEAT_HPP
  131. /* Original file checksum: lines: 90, chars: 2388, CRC32: c285198b */
  132. /*
  133. * ===========================================================================
  134. * $Log: Seq_feat.hpp,v $
  135. * Revision 1000.1  2004/04/12 17:23:55  gouriano
  136. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.16
  137. *
  138. * Revision 1.16  2004/01/05 19:16:36  dicuccio
  139. * Added APIs to ease adding qualifiers and dbxrefs
  140. *
  141. * Revision 1.15  2003/12/31 15:36:07  grichenk
  142. * Moved CompareLocations() from CSeq_feat to CSeq_loc,
  143. * renamed it to Compare().
  144. *
  145. * Revision 1.14  2003/08/07 21:42:03  kans
  146. * added SetGeneXref and SetProtXref
  147. *
  148. * Revision 1.13  2003/04/24 16:15:31  vasilche
  149. * Fixed CSeq_feat::Compare().
  150. *
  151. * Revision 1.12  2003/02/26 17:53:06  vasilche
  152. * Added public version of feature comparison assuming that
  153. * total range check is done already.
  154. *
  155. * Revision 1.11  2003/02/24 18:52:57  vasilche
  156. * Added optional mapped locations arguments to feature comparison.
  157. *
  158. * Revision 1.10  2003/02/10 15:52:07  grichenk
  159. * CSeq_feat::Compare() takes optional seq-locs for remapped features
  160. *
  161. * Revision 1.9  2003/02/06 22:24:23  vasilche
  162. * Added int CSeq_feat::Compare().
  163. * Fixed slow comparison of CSeq_feat with mix seq locs.
  164. *
  165. * Revision 1.8  2003/01/29 17:43:22  vasilche
  166. * Added Compare(CSeq_feat, CSeq_feat) returning int for easier comparison.
  167. * operator<(CSeq_feat, CSeq_feat) uses Compare().
  168. *
  169. * Revision 1.7  2002/12/26 12:43:27  dicuccio
  170. * Added Win32 export specifiers
  171. *
  172. * Revision 1.6  2002/12/19 22:12:03  kans
  173. * include Gene_ref.hpp and Prot_ref.hpp, move log to bottom of file
  174. *
  175. * Revision 1.5  2002/12/19 21:31:09  kans
  176. * added GetGeneXref and GetProtXref
  177. *
  178. * Revision 1.4  2002/06/07 11:59:10  clausen
  179. * Added related function comment
  180. *
  181. * Revision 1.3  2002/06/06 20:56:30  clausen
  182. * Moved GetLabel to objects/util/feature.hpp
  183. *
  184. * Revision 1.2  2002/01/10 19:55:01  clausen
  185. * Added GetLabel
  186. *
  187. * Revision 1.1  2001/10/30 20:25:57  ucko
  188. * Implement feature labels/keys, subtypes, and sorting
  189. *
  190. *
  191. * ===========================================================================
  192. */