NVBIO
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Methods | List of all members
nvbio::FASTQ_gzfile Struct Reference

Detailed description

A gzipped FASTQ file implementing the FASTQ_stream model needed by FASTQ_reader

Definition at line 71 of file fastq.h.

#include <fastq.h>

Classes

struct  Impl
 

Public Methods

 FASTQ_gzfile (const uint32 buffer_size=64536u)
 
 FASTQ_gzfile (const char *filename, const uint32 buffer_size=64536u)
 
 ~FASTQ_gzfile ()
 
void open (const char *filename)
 
bool valid () const
 
uint8 get ()
 
uint32 read (uint8 *buffer, const uint32 n)
 

Constructor & Destructor Documentation

nvbio::FASTQ_gzfile::FASTQ_gzfile ( const uint32  buffer_size = 64536u)

constructor

Definition at line 57 of file fastq.cpp.

nvbio::FASTQ_gzfile::FASTQ_gzfile ( const char *  filename,
const uint32  buffer_size = 64536u 
)

constructor

Definition at line 67 of file fastq.cpp.

nvbio::FASTQ_gzfile::~FASTQ_gzfile ( )

destructor

Definition at line 77 of file fastq.cpp.

Member Function Documentation

uint8 nvbio::FASTQ_gzfile::get ( )
inline

get the next character, or 255 if EOF

Definition at line 35 of file fastq_inl.h.

void nvbio::FASTQ_gzfile::open ( const char *  filename)

open a new file

Definition at line 81 of file fastq.cpp.

uint32 nvbio::FASTQ_gzfile::read ( uint8 buffer,
const uint32  n 
)

read a buffer

Definition at line 98 of file fastq.cpp.

bool nvbio::FASTQ_gzfile::valid ( ) const

return whether the file is valid

Definition at line 91 of file fastq.cpp.


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