src/api/internal/BamHeader_p.h

   1 // ***************************************************************************
   2 // BamHeader_p.h (c) 2010 Derek Barnett
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 25 December 2010 (DB)
   7 // ---------------------------------------------------------------------------
   8 // Provides the basic functionality for handling BAM headers.
   9 // ***************************************************************************
  10
  11 #ifndef BAMHEADER_P_H
  12 #define BAMHEADER_P_H
  13
  14 //  -------------
  15 //  W A R N I N G
  16 //  -------------
  17 //
  18 // This file is not part of the BamTools API.  It exists purely as an
  19 // implementation detail. This header file may change from version to version
  20 // without notice, or even be removed.
  21 //
  22 // We mean it.
  23
  24 #include <api/SamHeader.h>
  25 #include <string>
  26
  27 namespace BamTools {
  28
  29 class BgzfData;
  30
  31 namespace Internal {
  32
  33 class BamHeader {
  34
  35     public:
  36         BamHeader(void);
  37         ~BamHeader(void);
  38
  39     public:
  40         void Clear(void);
  41         bool IsValid(void) const;
  42         bool Load(BgzfData* stream);
  43
  44     public:
  45         SamHeader ToSamHeader(void) const;
  46         std::string ToString(void) const;
  47
  48     private:
  49         struct BamHeaderPrivate;
  50         BamHeaderPrivate* d;
  51 };
  52
  53 } // namespace Internal
  54 } // namespace BamTools
  55
  56 #endif // BAMHEADER_P_H