/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``AS IS'' and any express or implied
#   warranties, including, but not limited to, the implied warranties of
#   merchantability and fitness for a particular purpose, are disclaimed.
#   In no event shall the authors or the University of Washington be
#   liable for any direct, indirect, incidental, special, exemplary, or
#   consequential damages (including, but not limited to, procurement of
#   substitute goods or services; loss of use, data, or profits; or
#   business interruption) however caused and on any theory of liability,
#   whether in contract, strict liability, or tort (including negligence
#   or otherwise) arising in any way out of the use of this software, even
#   if advised of the possibility of such damage.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
#ifndef READTYPES_INCLUDED
#define READTYPES_INCLUDED

#include    "assert.h"


const unsigned char TOP_STRAND_PRIMER_READS = 1;
const unsigned char TOP_STRAND_TERMINATOR_READS = 2;
const unsigned char BOTTOM_STRAND_PRIMER_READS = 4;
const unsigned char BOTTOM_STRAND_TERMINATOR_READS = 8;

typedef unsigned char readTypes;


// for using as an index to arrays

const int nTopStrandTerminator = 0;
const int nTopStrandPrimer = 1;
const int nBottomStrandTerminator = 2;
const int nBottomStrandPrimer = 3;


// read types for Fragment::nReadType_ and autoFinishExpTag::nReadType_

const int nUniversalForward = 1;
const int nUniversalReverse = 2;
const int nPCREnd = 3;
const int nWalk = 4;
const int nReadTypesMaxSubscript = nWalk;



inline char* szGetReadType( const unsigned char ucReadType ) {
   if ( ucReadType == TOP_STRAND_PRIMER_READS )
      return( "top strand primer reads" );
   else if ( ucReadType == TOP_STRAND_TERMINATOR_READS )
      return( "top strand terminator reads" );
   else if ( ucReadType == BOTTOM_STRAND_PRIMER_READS )
      return( "bottom strand primer reads" );
   else if ( ucReadType == BOTTOM_STRAND_TERMINATOR_READS )
      return( "bottom strand terminator reads" );
   else
      assert( false );
}



// used to print out the read type
inline char* szGetReadType2( const int nReadType ) {
   if ( nReadType == nUniversalForward )
      return( "universal forward" );
   else if ( nReadType == nUniversalReverse )
      return( "universal reverse" );
   else if ( nReadType == nPCREnd )
      return( "pcr end" );
   else if ( nReadType == nWalk )
      return( "walk" );
   else if ( nReadType == 0 )
      return( "unknown" );
   else
      assert( false );
}







#endif