]> git.donarmstrong.com Git - bamtools.git/blobdiff - src/api/BamReader.h
Fixed: typo in BamReader.h
[bamtools.git] / src / api / BamReader.h
index 8e15a5c4abdb0e68804a035e1d3a116059c59ae0..15b41354d9e2e119e2c1e4e2cc38cd80fd500ecc 100644 (file)
@@ -2,7 +2,7 @@
 // BamReader.h (c) 2009 Derek Barnett, Michael Str�mberg\r
 // Marth Lab, Department of Biology, Boston College\r
 // ---------------------------------------------------------------------------\r
-// Last modified: 7 October 2011 (DB)\r
+// Last modified: 18 November 2012 (DB)\r
 // ---------------------------------------------------------------------------\r
 // Provides read access to BAM files.\r
 // ***************************************************************************\r
 #ifndef BAMREADER_H\r
 #define BAMREADER_H\r
 \r
-#include <api/api_global.h>\r
-#include <api/BamAlignment.h>\r
-#include <api/BamIndex.h>\r
-#include <api/SamHeader.h>\r
+#include "api/api_global.h"\r
+#include "api/BamAlignment.h"\r
+#include "api/BamIndex.h"\r
+#include "api/SamHeader.h"\r
 #include <string>\r
 \r
 namespace BamTools {\r
@@ -69,7 +69,9 @@ class API_EXPORT BamReader {
         // access header data\r
         // ----------------------\r
 \r
-        // returns SAM header data\r
+        // returns a read-only reference to SAM header data\r
+        const SamHeader& GetConstSamHeader(void) const;\r
+        // returns an editable copy of SAM header data\r
         SamHeader GetHeader(void) const;\r
         // returns SAM header data, as SAM-formatted text\r
         std::string GetHeaderText(void) const;\r
@@ -99,8 +101,6 @@ class API_EXPORT BamReader {
         bool OpenIndex(const std::string& indexFilename);\r
         // sets a custom BamIndex on this reader\r
         void SetIndex(BamIndex* index);\r
-        // changes the caching behavior of the index data\r
-        void SetIndexCacheMode(const BamIndex::IndexCacheMode& mode);\r
 \r
         // ----------------------\r
         // error handling\r