/*****************************************************************************
#   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 WHYISPRIMERNOTACCEPTABLETYPES_INCLUDED
#define WHYISPRIMERNOTACCEPTABLETYPES_INCLUDED

#define BAD_PRIMER_STICKS_TO_SEQUENCE_IN_FILE 1
#define BAD_PRIMER_STICKS_TO_SOMEWHERE_ELSE     2
#define BAD_PRIMER_STICKS_TO_SELF               3
#define BAD_PRIMER_MELTING_TEMPERATURE_TOO_LOW  4   
#define BAD_PRIMER_MELTING_TEMPERATURE_TOO_HIGH 5
#define BAD_PRIMER_TOO_LOW_QUALITY              6
#define BAD_PRIMER_MONONUCLEOTIDE_REPEAT        7
#define BAD_PRIMER_HAS_NO_TEMPLATE              8
#define BAD_PRIMER_IN_SINGLE_SUBCLONE_REGION    9
#define BAD_PRIMER_WHERE_HIGH_QUALITY_DISCREPANCIES 10
#define BAD_PRIMER_WHERE_UNALIGNED_HIGH_QUALITY_REGION 11
#define BAD_PRIMER_NOT_ENOUGH_TEMPLATES        12
#define BAD_PRIMER_NOT_JUST_ACGT                13

#define BAD_PRIMER_PAIR_FORMS_PRODUCT_SOMEWHERE_ELSE 14
#define BAD_PRIMER_PAIR_FORMS_PRODUCT_WITHIN_OR_ENCLOSING_DESIRED_PRODUCT 15
#define BAD_PRIMER_PAIR_TEMP_DIFF_TOO_GREAT 16
#define BAD_PRIMER_PAIR_FORMS_PRIMER_DIMER 17


#include    "rwcstring.h"
#include    "assert.h"

inline RWCString soWhyIsPrimerNotAcceptable( const unsigned char ucReason ) {
   
   RWCString soReason;
   switch( ucReason ) {
   case BAD_PRIMER_PAIR_FORMS_PRODUCT_SOMEWHERE_ELSE:
      soReason = "primer pair forms product somewhere else";
      break;
   case BAD_PRIMER_PAIR_FORMS_PRODUCT_WITHIN_OR_ENCLOSING_DESIRED_PRODUCT:
      soReason = "primer pair forms product within or enclosing desired product";
      break;
   case BAD_PRIMER_PAIR_TEMP_DIFF_TOO_GREAT:
      soReason = "primer melting temperatures differ too much";
      break;
   case BAD_PRIMER_PAIR_FORMS_PRIMER_DIMER:
      soReason = "primers form primer dimer";
      break;
   default:
      assert( false );
      break;
   }
      
   return( soReason );
}


#endif