BamReader.h

   1 // ***************************************************************************\r
   2 // BamReader.h (c) 2009 Derek Barnett, Michael Str�mberg\r
   3 // Marth Lab, Department of Biology, Boston College\r
   4 // All rights reserved.\r
   5 // ---------------------------------------------------------------------------\r
   6 // Last modified: 8 June 2010 (DB)\r
   7 // ---------------------------------------------------------------------------\r
   8 // Uses BGZF routines were adapted from the bgzf.c code developed at the Broad\r
   9 // Institute.\r
  10 // ---------------------------------------------------------------------------\r
  11 // Provides the basic functionality for reading BAM files\r
  12 // ***************************************************************************\r
  13 \r
  14 #ifndef BAMREADER_H\r
  15 #define BAMREADER_H\r
  16 \r
  17 // C++ includes\r
  18 #include <string>\r
  19 \r
  20 // BamTools includes\r
  21 #include "BamAux.h"\r
  22 \r
  23 namespace BamTools {\r
  24 \r
  25 class BamReader {\r
  26 \r
  27     // constructor / destructor\r
  28     public:\r
  29         BamReader(void);\r
  30         ~BamReader(void);\r
  31 \r
  32     // public interface\r
  33     public:\r
  34 \r
  35         // ----------------------\r
  36         // BAM file operations\r
  37         // ----------------------\r
  38 \r
  39         // close BAM file\r
  40         void Close(void);\r
  41         // performs random-access jump to reference, position\r
  42         bool Jump(int refID, int position = 0);\r
  43         // opens BAM file (and optional BAM index file, if provided)\r
  44         void Open(const std::string& filename, const std::string& indexFilename = "");\r
  45         // returns file pointer to beginning of alignments\r
  46         bool Rewind(void);\r
  47 \r
  48         // ----------------------\r
  49         // access alignment data\r
  50         // ----------------------\r
  51 \r
  52         // retrieves next available alignment (returns success/fail)\r
  53         bool GetNextAlignment(BamAlignment& bAlignment);\r
  54         // retrieves next available alignment core data (returns success/fail)\r
  55         // ** DOES NOT parse any character data (bases, qualities, tag data)\r
  56         //    these can be accessed, if necessary, from the supportData \r
  57         // useful for operations requiring ONLY positional or other alignment-related information\r
  58         bool GetNextAlignmentCore(BamAlignment& bAlignment, BamAlignmentSupportData& supportData);\r
  59 \r
  60         // ----------------------\r
  61         // access auxiliary data\r
  62         // ----------------------\r
  63 \r
  64         // returns SAM header text\r
  65         const std::string GetHeaderText(void) const;\r
  66         // returns number of reference sequences\r
  67         int GetReferenceCount(void) const;\r
  68         // returns vector of reference objects\r
  69         const BamTools::RefVector GetReferenceData(void) const;\r
  70         // returns reference id (used for BamReader::Jump()) for the given reference name\r
  71         int GetReferenceID(const std::string& refName) const;\r
  72         // returns the name of the file associated with this BamReader\r
  73         const std::string GetFilename(void) const;\r
  74 \r
  75         // ----------------------\r
  76         // BAM index operations\r
  77         // ----------------------\r
  78 \r
  79         // creates index for BAM file, saves to file (default = bamFilename + ".bai")\r
  80         bool CreateIndex(void);\r
  81 \r
  82     // private implementation\r
  83     private:\r
  84         struct BamReaderPrivate;\r
  85         BamReaderPrivate* d;\r
  86 };\r
  87 \r
  88 } // namespace BamTools\r
  89 \r
  90 #endif // BAMREADER_H\r