libStatGen Software  1
FastQStatus.h
00001 /*
00002  *  Copyright (C) 2010  Regents of the University of Michigan
00003  *
00004  *   This program is free software: you can redistribute it and/or modify
00005  *   it under the terms of the GNU General Public License as published by
00006  *   the Free Software Foundation, either version 3 of the License, or
00007  *   (at your option) any later version.
00008  *
00009  *   This program is distributed in the hope that it will be useful,
00010  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *   GNU General Public License for more details.
00013  *
00014  *   You should have received a copy of the GNU General Public License
00015  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016  */
00017 
00018 #ifndef __FASTQ_STATUS_H__
00019 #define __FASTQ_STATUS_H__
00020 
00021 #include <string>
00022 
00023 /// Status for FastQ operations.
00024 class FastQStatus
00025 {
00026  public:
00027 
00028     /// Return value enum for the FastQFile class methods, indicating
00029     /// success or error codes.
00030    enum Status 
00031        {
00032            FASTQ_SUCCESS = 0,      ///< indicates method finished successfully.
00033            FASTQ_INVALID,          ///< means that the sequence was invalid.
00034            FASTQ_ORDER_ERROR,      ///< means the methods are called out of order, like trying to read a file before opening it.
00035            FASTQ_OPEN_ERROR,       ///< means the file could not be opened.
00036            FASTQ_CLOSE_ERROR,      ///< means the file could not be closed.
00037            FASTQ_READ_ERROR,       ///< means that a problem occurred on a read.
00038            FASTQ_NO_SEQUENCE_ERROR ///< means there were no errors, but no sequences read.
00039        };
00040 
00041    /// Get the enum string for the status.
00042    static const char* getStatusString(Status status);
00043 
00044 private:
00045    static const char* enumString[];
00046 };
00047 
00048 
00049 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends