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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: Seq_align.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 19:30:39  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.13
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: Seq_align.hpp,v 1000.2 2004/06/01 19:30:39 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 data definition file
  42.  *   'seqalign.asn'.
  43.  */
  44. #ifndef OBJECTS_SEQALIGN_SEQ_ALIGN_HPP
  45. #define OBJECTS_SEQALIGN_SEQ_ALIGN_HPP
  46. // generated includes
  47. #include <objects/seqalign/Seq_align_.hpp>
  48. #include <util/range.hpp>
  49. // generated classes
  50. BEGIN_NCBI_SCOPE
  51. BEGIN_objects_SCOPE // namespace ncbi::objects::
  52. class CSeq_id;
  53. class NCBI_SEQALIGN_EXPORT CSeq_align : public CSeq_align_Base
  54. {
  55.     typedef CSeq_align_Base Tparent;
  56. public:
  57.     // constructor
  58.     CSeq_align(void);
  59.     // destructor
  60.     ~CSeq_align(void);
  61.     // Validatiors
  62.     TDim CheckNumRows(void)                   const;
  63.     void Validate    (bool full_test = false) const;
  64.     // GetSeqRange
  65.     CRange<TSeqPos> GetSeqRange(TDim row) const;
  66.     TSeqPos         GetSeqStart(TDim row) const;
  67.     TSeqPos         GetSeqStop (TDim row) const;
  68.     // Get seq-id (the first one if segments have different ids).
  69.     // Throw exception if row is invalid.
  70.     const CSeq_id&  GetSeq_id(TDim row) const;
  71.     // Get score
  72.     bool GetNamedScore(const string& id, int &score) const;
  73.     bool GetNamedScore(const string& id, double &score) const;
  74.     /// Reverse the segments' orientation
  75.     /// NOTE: currently *only* works for dense-seg
  76.     void Reverse(void);
  77.     /// Swap the position of two rows in the alignment
  78.     /// NOTE: currently *only* works for dense-seg & disc
  79.     void SwapRows(TDim row1, TDim row2);
  80.     // Create a Dense-seg from a Std-seg
  81.     // Used by AlnMgr to handle nucl2prot alignments
  82.     //
  83.     // NOTE: Here we assume that the same rows on different segments
  84.     // contain the same sequence. Without access to OM we can only check
  85.     // if the ids are the same via SerialEquals, and we throw an exception
  86.     // if not equal. Since the same sequence can be represented with a 
  87.     // different type of seq-id, we provide an optional callback mechanism
  88.     // to compare id1 and id2, and if both resolve to the same sequence 
  89.     // and id2 is preferred, to SerialAssign it to id1. Otherwise, again,
  90.     // an exception should be thrown.
  91.     struct SSeqIdChooser : CObject
  92.     {
  93.         virtual void ChooseSeqId(CSeq_id& id1, const CSeq_id& id2) = 0;
  94.     };
  95.     CRef<CSeq_align> CreateDensegFromStdseg(SSeqIdChooser* SeqIdChooser = 0) const;
  96.     // Create a Dense-seg with widths from Dense-seg of nucleotides
  97.     // Used by AlnMgr to handle translated nucl2nucl alignments
  98.     // IMPORTANT NOTE: Do *NOT* use for alignments containing proteins;
  99.     //                 the code will not check for this
  100.     CRef<CSeq_align> CreateTranslatedDensegFromNADenseg(void) const;
  101. private:
  102.     // Prohibit copy constructor and assignment operator
  103.     CSeq_align(const CSeq_align& value);
  104.     CSeq_align& operator=(const CSeq_align& value);
  105. };
  106. /////////////////// CSeq_align inline methods
  107. // constructor
  108. inline
  109. CSeq_align::CSeq_align(void)
  110. {
  111. }
  112. /////////////////// end of CSeq_align inline methods
  113. END_objects_SCOPE // namespace ncbi::objects::
  114. END_NCBI_SCOPE
  115. /*
  116. * ===========================================================================
  117. *
  118. * $Log: Seq_align.hpp,v $
  119. * Revision 1000.2  2004/06/01 19:30:39  gouriano
  120. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.13
  121. *
  122. * Revision 1.13  2004/05/05 19:16:25  johnson
  123. * Added SwapRows method for 'disc' seq-align / seq-align-set
  124. *
  125. * Revision 1.12  2004/04/27 19:17:13  johnson
  126. * Added GetNamedScore helper function
  127. *
  128. * Revision 1.11  2004/04/19 17:27:22  grichenk
  129. * Added GetSeq_id(TDim row)
  130. *
  131. * Revision 1.10  2004/03/15 17:42:29  todorov
  132. * Derive SSeqIdChooser from CObject to avoid possible multiple inheritance in
  133. * the client. Workshop has problems with it (missplaced vtable).
  134. *
  135. * Revision 1.9  2004/03/09 17:14:17  todorov
  136. * changed the C-style callback to a functor
  137. *
  138. * Revision 1.8  2004/02/23 16:17:53  ucko
  139. * Add forward declaration of CSeq_id.
  140. *
  141. * Revision 1.7  2004/02/23 15:30:55  todorov
  142. * +TChooseSeqIdCallback to abstract resolving seq-ids in CreateDensegFromStdseg()
  143. *
  144. * Revision 1.6  2004/01/15 20:13:27  todorov
  145. * -CheckNumSegs
  146. *
  147. * Revision 1.5  2003/12/16 22:54:14  todorov
  148. * +CreateTranslatedDensegFromNADenseg
  149. *
  150. * Revision 1.4  2003/09/16 15:31:59  todorov
  151. * Added validation methods. Added seq range methods
  152. *
  153. * Revision 1.3  2003/08/26 20:28:38  johnson
  154. * added 'SwapRows' method
  155. *
  156. * Revision 1.2  2003/08/19 21:10:39  todorov
  157. * +CreateDensegFromStdseg
  158. *
  159. * Revision 1.1  2003/08/13 18:11:35  johnson
  160. * added 'Reverse' method
  161. *
  162. *
  163. * ===========================================================================
  164. */
  165. #endif // OBJECTS_SEQALIGN_SEQ_ALIGN_HPP
  166. /* Original file checksum: lines: 93, chars: 2426, CRC32: 6ba198f0 */