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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: gnomon.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:47:53  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_GNOMON___GNOMON__HPP
  10. #define ALGO_GNOMON___GNOMON__HPP
  11. /*  $Id: gnomon.hpp,v 1000.1 2004/04/12 17:47:53 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Mike DiCuccio
  37.  *
  38.  * File Description:
  39.  *
  40.  */
  41. #include <corelib/ncbiobj.hpp>
  42. #include <objmgr/seq_vector.hpp>
  43. #include <objects/seq/Seq_annot.hpp>
  44. #include <util/range.hpp>
  45. BEGIN_NCBI_SCOPE
  46. class CClusterSet;
  47. class CFrameShiftInfo;
  48. typedef vector<CFrameShiftInfo> TFrameShifts;
  49. class NCBI_XALGOGNOMON_EXPORT CGnomon
  50. {
  51. public:
  52.     CGnomon();
  53.     ~CGnomon();
  54.     // set our sequence, as a vector of IUPACna characters
  55.     void SetSequence(const vector<char>& seq);
  56.     // set our sequence, as a string of IUPACna characters
  57.     void SetSequence(const string& seq);
  58.     // set our sequence, as a CSeqVector.  We will explicitly convert these
  59.     // to IUPACna.
  60.     void SetSequence(const objects::CSeqVector& vec);
  61.     // set the name of the model data file
  62.     void SetModelData(const string& file);
  63.     // set the name of the a priori information file
  64.     void SetAprioriInfo(const string& file);
  65.     // set the name of the frame shifts file
  66.     void SetFrameShiftInfo(const string& file);
  67.     // set the repeats flag.  By default, we do not use repeat information.
  68.     void SetRepeats(bool val);
  69.     // set the range to scan.  By default, we scan the whole sequence.
  70.     void SetScanRange(const CRange<TSeqPos>& range);
  71.     // set the scan starting position
  72.     void SetScanFrom(TSeqPos from);
  73.     // set the scan stopping position
  74.     void SetScanTo  (TSeqPos to);
  75.     // run the algorithm
  76.     void Run(void);
  77.     CRef<objects::CSeq_annot> GetAnnot(void) const;
  78. private:
  79.     // our sequence
  80.     vector<char> m_Seq;
  81.     // our scan range
  82.     CRange<TSeqPos> m_ScanRange;
  83.     // the model data file
  84.     string m_ModelFile;
  85.     // the a priori information
  86.     auto_ptr<CClusterSet> m_Clusters;
  87.     // the frame shifts information
  88.     auto_ptr<TFrameShifts> m_Fshifts;
  89.     // flag: do we use repeat information?
  90.     bool m_Repeats;
  91.     // our resulting annotation
  92.     CRef<objects::CSeq_annot> m_Annot;
  93.     // copying is prohibited
  94.     CGnomon(const CGnomon&);
  95.     CGnomon& operator=(const CGnomon&);
  96. };
  97. END_NCBI_SCOPE
  98. /*
  99.  * ===========================================================================
  100.  * $Log: gnomon.hpp,v $
  101.  * Revision 1000.1  2004/04/12 17:47:53  gouriano
  102.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.2
  103.  *
  104.  * Revision 1.2  2004/03/16 15:37:43  vasilche
  105.  * Added required include
  106.  *
  107.  * Revision 1.1  2003/10/24 15:06:30  dicuccio
  108.  * Initial revision
  109.  *
  110.  * ===========================================================================
  111.  */
  112. #endif  // ALGO_GNOMON___GNOMON__HPP