bamtools_utilities.h

   1 // ***************************************************************************
   2 // bamtools_utilities.h (c) 2010 Derek Barnett, Erik Garrison
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 2 June 2010
   7 // ---------------------------------------------------------------------------
   8 // Provides general utilities used by BamTools sub-tools.
   9 // ***************************************************************************
  10
  11 #ifndef BAMTOOLS_UTILITIES_H
  12 #define BAMTOOLS_UTILITIES_H
  13
  14 #include <string>
  15 #include "BamAux.h"
  16
  17 namespace BamTools {
  18
  19 class BamReader;
  20 class BamMultiReader;
  21
  22 class Utilities {
  23
  24     public:
  25         // Parses a region string, uses reader to do validation (valid ID's, positions), stores in Region struct
  26         // Returns success (true/false)
  27         static bool ParseRegionString(const std::string& regionString, const BamReader& reader, BamRegion& region);
  28         // Same as above, but accepts a BamMultiReader
  29         static bool ParseRegionString(const std::string& regionString, const BamMultiReader& reader, BamRegion& region);
  30
  31         // check if a file exists
  32         static bool FileExists(const std::string& fname);
  33 };
  34
  35 } // namespace BamTools
  36
  37 #endif // BAMTOOLS_UTILITIES_H