SequenceReader/GenerateTestFastaFiles.h

Go to the documentation of this file.
00001 /*  Last edited: Apr 19 10:08 2002 (ac2) */
00002 
00003 // #######################################################################
00004 
00005 // SSAHA : Sequence Search and Alignment by Hashing Algorithm
00006 // Version 3.2, released 1st March 2004
00007 // Copyright (c) Genome Research 2002
00008 
00009 // SSAHA is free software; you can redistribute it and/or modify 
00010 // it under the terms of version 2 of the GNU General Public Licence
00011 // as published by the Free Software Foundation.
00012  
00013 // This program is distributed in the hope that it will be useful,
00014 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00015 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016 // GNU General Public Licence for more details.
00017  
00018 // You should have received a copy of the GNU General Public Licence
00019 // along with this program; if not, write to the Free Software
00020 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00021 // or see the on-line version at http://www.gnu.org/copyleft/gpl.txt
00022 
00023 // #######################################################################
00024 
00025 // Module Name  : GenerateTestFastaFiles
00026 // File Name    : GenerateTestFastaFiles.h
00027 // Language     : C++
00028 // Module Author: Anthony J. Cox (ac2@sanger.ac.uk)
00029 
00030 // Include guard:
00031 #ifndef INCLUDED_GenerateTestFastaFiles
00032 #define INCLUDED_GenerateTestFastaFiles
00033 
00034 // Description:
00035 
00036 // Includes:
00037 
00038 #include <string>
00039 using namespace std;
00040 
00041 // NB it is good practise for #include statements in header files to be
00042 // replaced by forward declarations if at all possible
00043 
00044 // ### Function Declarations ###
00045 
00046 // Name:
00047 // Arguments:
00048 // TYPE  NAME  IN/OUT COMMENT
00049 // Returns: TYPE COMMENT
00050 
00051 class BaseGenerator
00052 {
00053   public:
00054   BaseGenerator( int numBases, int seed = -9999 );
00055 
00056   void generateSubjectFile
00057   ( int seqSize, int basesOverlap, 
00058     const char* fileName = "test_subject.fasta");
00059 
00060   void generateSubjectFileFastq
00061   ( int seqSize, int basesOverlap, 
00062     const char* fileName = "test_subject.fastq");
00063 
00064   void generateQueryFile
00065   ( int baseStart, int seqSize,
00066     const char* fileName = "test_query.fasta");
00067 
00068   void getBases
00069   ( int baseStart, int seqSize, string& outputString );
00070 
00071   protected:
00072   string bases_;
00073   int numBases_;
00074 };
00075 
00076 
00077 // End of include guard:
00078 #endif
00079 
00080 // End of file GenerateTestFastaFiles.h
00081 
00082 
00083 

Generated on Fri Dec 21 13:12:16 2007 for ssaha by  doxygen 1.5.2