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

Detailed description

A FASTQ file implementing the FASTQ_stream model needed by FASTQ_reader

Definition at line 113 of file fastq.h.

#include <fastq.h>

Public Methods

 FASTQ_file (const uint32 buffer_size=64536u)
 
 FASTQ_file (const char *filename, const uint32 buffer_size=64536u)
 
void open (const char *filename)
 
 ~FASTQ_file ()
 
bool valid () const
 
uint8 get ()
 

Constructor & Destructor Documentation

nvbio::FASTQ_file::FASTQ_file ( const uint32  buffer_size = 64536u)
inline

constructor

Definition at line 48 of file fastq_inl.h.

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

constructor

Definition at line 58 of file fastq_inl.h.

nvbio::FASTQ_file::~FASTQ_file ( )
inline

destructor

Definition at line 78 of file fastq_inl.h.

Member Function Documentation

uint8 nvbio::FASTQ_file::get ( )
inline

get the next character, or 255 if EOF

Definition at line 87 of file fastq_inl.h.

void nvbio::FASTQ_file::open ( const char *  filename)
inline

open a new file

Definition at line 67 of file fastq_inl.h.

bool nvbio::FASTQ_file::valid ( ) const
inline

return whether the file is valid

Definition at line 133 of file fastq.h.


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