cigar.h

Go to the documentation of this file.

#ifndef __gamgee__cigar__
#define __gamgee__cigar__

#include "htslib/sam.h"

#include <memory>
#include <string>

namespace gamgee {

enum class CigarOperator { M, I, D, N, S, H, P, EQ, X, B };

class Cigar {
 public:
  explicit Cigar(const std::shared_ptr<bam1_t>& sam_record);
  Cigar(const Cigar& other);
  Cigar(Cigar&& other) noexcept;
  Cigar& operator=(const Cigar& other);
  Cigar& operator=(Cigar&& other) noexcept;
  ~Cigar() = default; 

  uint32_t operator[](const uint32_t index) const;       
  uint32_t size() const { return m_num_cigar_elements; } 
  std::string to_string() const;

  inline static CigarOperator cigar_op(const uint32_t cigar_element) {
    return static_cast<CigarOperator>(bam_cigar_op(cigar_element));
  }

  inline static uint32_t cigar_oplen(const uint32_t cigar_element) {
    return bam_cigar_oplen(cigar_element);
  }

 private:
  std::shared_ptr<bam1_t> m_sam_record;   
  uint32_t* m_cigar;                      
  uint32_t m_num_cigar_elements;          

  static const char cigar_ops_as_chars[]; 
};

}

#endif /* __gamgee__cigar__ */