src/api/SamConstants.h

   1 // ***************************************************************************
   2 // SamConstants.h (c) 2010 Derek Barnett
   3 // Marth Lab, Department of Biology, Boston College
   4 // ---------------------------------------------------------------------------
   5 // Last modified: 10 October 2011 (DB)
   6 // ---------------------------------------------------------------------------
   7 // Provides constants for SAM header
   8 // ***************************************************************************
   9
  10 #ifndef SAM_CONSTANTS_H
  11 #define SAM_CONSTANTS_H
  12
  13 #include "api/api_global.h"
  14 #include <string>
  15
  16 namespace BamTools {
  17 namespace Constants {
  18
  19 // basic char constants used in SAM format
  20 const char SAM_COLON  = ':';
  21 const char SAM_EQUAL  = '=';
  22 const char SAM_PERIOD = '.';
  23 const char SAM_STAR   = '*';
  24 const char SAM_TAB    = '\t';
  25 const std::string SAM_DIGITS = "0123456789";
  26
  27 // HD entries
  28 const std::string SAM_HD_BEGIN_TOKEN    = "@HD";
  29 const std::string SAM_HD_VERSION_TAG    = "VN";
  30 const std::string SAM_HD_SORTORDER_TAG  = "SO";
  31 const std::string SAM_HD_GROUPORDER_TAG = "GO";
  32
  33 // SQ entries
  34 const std::string SAM_SQ_BEGIN_TOKEN    = "@SQ";
  35 const std::string SAM_SQ_ASSEMBLYID_TAG = "AS";
  36 const std::string SAM_SQ_CHECKSUM_TAG   = "M5";
  37 const std::string SAM_SQ_LENGTH_TAG     = "LN";
  38 const std::string SAM_SQ_NAME_TAG       = "SN";
  39 const std::string SAM_SQ_SPECIES_TAG    = "SP";
  40 const std::string SAM_SQ_URI_TAG        = "UR";
  41
  42 // RG entries
  43 const std::string SAM_RG_BEGIN_TOKEN             = "@RG";
  44 const std::string SAM_RG_DESCRIPTION_TAG         = "DS";
  45 const std::string SAM_RG_FLOWORDER_TAG           = "FO";
  46 const std::string SAM_RG_ID_TAG                  = "ID";
  47 const std::string SAM_RG_KEYSEQUENCE_TAG         = "KS";
  48 const std::string SAM_RG_LIBRARY_TAG             = "LB";
  49 const std::string SAM_RG_PLATFORMUNIT_TAG        = "PU";
  50 const std::string SAM_RG_PREDICTEDINSERTSIZE_TAG = "PI";
  51 const std::string SAM_RG_PRODUCTIONDATE_TAG      = "DT";
  52 const std::string SAM_RG_PROGRAM_TAG             = "PG";
  53 const std::string SAM_RG_SAMPLE_TAG              = "SM";
  54 const std::string SAM_RG_SEQCENTER_TAG           = "CN";
  55 const std::string SAM_RG_SEQTECHNOLOGY_TAG       = "PL";
  56
  57 // PG entries
  58 const std::string SAM_PG_BEGIN_TOKEN         = "@PG";
  59 const std::string SAM_PG_COMMANDLINE_TAG     = "CL";
  60 const std::string SAM_PG_ID_TAG              = "ID";
  61 const std::string SAM_PG_NAME_TAG            = "PN";
  62 const std::string SAM_PG_PREVIOUSPROGRAM_TAG = "PP";
  63 const std::string SAM_PG_VERSION_TAG         = "VN";
  64
  65 // CO entries
  66 const std::string SAM_CO_BEGIN_TOKEN = "@CO";
  67
  68 // HD:SO values
  69 const std::string SAM_HD_SORTORDER_COORDINATE = "coordinate";
  70 const std::string SAM_HD_SORTORDER_QUERYNAME  = "queryname";
  71 const std::string SAM_HD_SORTORDER_UNKNOWN    = "unknown";
  72 const std::string SAM_HD_SORTORDER_UNSORTED   = "unsorted";
  73
  74 // HD:GO values
  75 const std::string SAM_HD_GROUPORDER_NONE      = "none";
  76 const std::string SAM_HD_GROUPORDER_QUERY     = "query";
  77 const std::string SAM_HD_GROUPORDER_REFERENCE = "reference";
  78
  79 // SQ:LN values
  80 const unsigned int SAM_SQ_LENGTH_MIN = 1;
  81 const unsigned int SAM_SQ_LENGTH_MAX = 536870911; // 2^29 - 1
  82
  83 // RG:PL values
  84 const std::string SAM_RG_SEQTECHNOLOGY_CAPILLARY  = "CAPILLARY";
  85 const std::string SAM_RG_SEQTECHNOLOGY_HELICOS    = "HELICOS";
  86 const std::string SAM_RG_SEQTECHNOLOGY_ILLUMINA   = "ILLUMINA";
  87 const std::string SAM_RG_SEQTECHNOLOGY_IONTORRENT = "IONTORRENT";
  88 const std::string SAM_RG_SEQTECHNOLOGY_LS454      = "LS454";
  89 const std::string SAM_RG_SEQTECHNOLOGY_PACBIO     = "PACBIO";
  90 const std::string SAM_RG_SEQTECHNOLOGY_SOLID      = "SOLID";
  91
  92 } // namespace Constants
  93 } // namespace BamTools
  94
  95 #endif // SAM_CONSTANTS_H