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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: alignment_file.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:39:29  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.3
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef UTIL_CREADERS___ALIGNMENT_FILE__HPP
  10. #define UTIL_CREADERS___ALIGNMENT_FILE__HPP
  11. /*  $Id: alignment_file.hpp,v 1000.1 2004/06/01 19:39:29 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:  Josh Cherry
  37.  *
  38.  * File Description:  C++ wrappers for alignment file reading
  39.  *
  40.  */
  41. #include <corelib/ncbistd.hpp>
  42. BEGIN_NCBI_SCOPE
  43. /// A bunch of strings listing characters with various
  44. /// meanings in an alignment file.  Analogous to
  45. /// SSequenceInfo.
  46. class CSequenceInfo {
  47. public:
  48.     const string& GetAlphabet(void) const {return m_Alphabet;};
  49.     string& SetAlphabet(void) {return m_Alphabet;};
  50.     void SetAlphabet(const string& value) {m_Alphabet = value;};
  51.     const string& GetBeginningGap(void) const {return m_BeginningGap;};
  52.     string& SetBeginningGap(void) {return m_BeginningGap;};
  53.     void SetBeginningGap(const string& value) {m_BeginningGap = value;};
  54.     const string& GetMiddleGap(void) const {return m_MiddleGap;};
  55.     string& SetMiddleGap(void) {return m_MiddleGap;};
  56.     void SetMiddleGap(const string& value) {m_MiddleGap = value;};
  57.     const string& GetEndGap(void) const {return m_EndGap;};
  58.     string& SetEndGap(void) {return m_EndGap;};
  59.     void SetEndGap(const string& value) {m_EndGap = value;};
  60.     /// Convenience function for setting beginning, middle, and
  61.     /// end gap to the same thing
  62.     void SetAllGap(const string& value) {
  63.         m_BeginningGap = m_MiddleGap = m_EndGap = value;
  64.     };
  65.     const string& GetMissing(void) const {return m_Missing;};
  66.     string& SetMissing(void) {return m_Missing;};
  67.     void SetMissing(const string& value) {m_Missing = value;};
  68.     const string& GetMatch(void) const {return m_Match;};
  69.     string& SetMatch(void) {return m_Match;};
  70.     void SetMatch(const string& value) {m_Match = value;};
  71. private:
  72.     string m_Alphabet;
  73.     string m_BeginningGap;
  74.     string m_MiddleGap;
  75.     string m_EndGap;
  76.     string m_Missing;
  77.     string m_Match;
  78. };
  79. /// This class holds the results of reading an alignment file.
  80. /// It is analogous to SAlignmentFile.
  81. /// Seqs are upper-case strings representing the sequences, with
  82. /// '-' for a gap.  Ids are ids read from file.  Organisms and
  83. /// Deflines may not be set, depending on the file.
  84. class CAlignment
  85. {
  86. public:
  87.     const vector<string>& GetIds(void) const {return m_Ids;};
  88.     vector<string>& SetIds(void) {return m_Ids;};
  89.     const vector<string>& GetSeqs(void) const {return m_Seqs;};
  90.     vector<string>& SetSeqs(void) {return m_Seqs;};
  91.     const vector<string>& GetOrganisms(void) const {return m_Organisms;};
  92.     vector<string>& SetOrganisms(void) {return m_Organisms;};
  93.     const vector<string>& GetDeflines(void) const {return m_Deflines;};
  94.     vector<string>& SetDeflines(void) {return m_Deflines;};
  95.     
  96. private:
  97.     vector<string> m_Ids;
  98.     vector<string> m_Seqs;
  99.     vector<string> m_Organisms;
  100.     vector<string> m_Deflines;
  101. };
  102. /// Methods for reading alignment files
  103. class CAlignmentFile
  104. {
  105. public:
  106.     static void Read(CNcbiIstream& is, const CSequenceInfo& info,
  107.                      CAlignment& result);
  108.     static void ReadClustalProtein(CNcbiIstream& is, CAlignment& result);
  109.     static void ReadClustalNuc(CNcbiIstream& is, CAlignment& result);
  110. };
  111. END_NCBI_SCOPE
  112. #endif // UTIL_CREADERS___ALIGNMENT_FILE__HPP
  113. /*
  114.  * ===========================================================================
  115.  * $Log: alignment_file.hpp,v $
  116.  * Revision 1000.1  2004/06/01 19:39:29  gouriano
  117.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.3
  118.  *
  119.  * Revision 1.3  2004/02/19 12:49:39  dicuccio
  120.  * Roll back to version 1.1
  121.  *
  122.  * Revision 1.1  2004/02/09 16:02:36  jcherry
  123.  * Initial versionnnn
  124.  *
  125.  * ===========================================================================
  126.  */