NVBIO
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Methods | List of all members
BamTools::BamReader Class Reference

Detailed description

Definition at line 25 of file BamReader.h.

#include <BamReader.h>

Classes

struct  BamReaderPrivate
 

Public Methods

 BamReader (void)
 
 ~BamReader (void)
 
void Close (void)
 
bool Jump (int refID, int position=0)
 
void Open (const std::string &filename, const std::string &indexFilename="")
 
bool Rewind (void)
 
bool GetNextAlignment (BamAlignment &bAlignment)
 
const std::string GetHeaderText (void) const
 
const int GetReferenceCount (void) const
 
const BamTools::RefVector GetReferenceData (void) const
 
const int GetReferenceID (const std::string &refName) const
 
bool CreateIndex (void)
 

Constructor & Destructor Documentation

BamReader::BamReader ( void  )

Definition at line 125 of file BamReader.cpp.

BamReader::~BamReader ( void  )

Definition at line 130 of file BamReader.cpp.

Member Function Documentation

void BamReader::Close ( void  )

Definition at line 136 of file BamReader.cpp.

bool BamReader::CreateIndex ( void  )

Definition at line 151 of file BamReader.cpp.

const string BamReader::GetHeaderText ( void  ) const

Definition at line 145 of file BamReader.cpp.

bool BamReader::GetNextAlignment ( BamAlignment bAlignment)

Definition at line 142 of file BamReader.cpp.

const int BamReader::GetReferenceCount ( void  ) const

Definition at line 146 of file BamReader.cpp.

const RefVector BamReader::GetReferenceData ( void  ) const

Definition at line 147 of file BamReader.cpp.

const int BamReader::GetReferenceID ( const std::string &  refName) const

Definition at line 148 of file BamReader.cpp.

bool BamReader::Jump ( int  refID,
int  position = 0 
)

Definition at line 137 of file BamReader.cpp.

void BamReader::Open ( const std::string &  filename,
const std::string &  indexFilename = "" 
)

Definition at line 138 of file BamReader.cpp.

bool BamReader::Rewind ( void  )

Definition at line 139 of file BamReader.cpp.


The documentation for this class was generated from the following files: