blast_message.h
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:3k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_message.h,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:03:36  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: blast_message.h,v 1000.2 2004/06/01 18:03:36 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Author:  Tom Madden
  35.  *
  36.  */
  37. /** @file blast_message.h
  38.  * Structures for BLAST messages
  39.  */
  40. #ifndef __BLASTMESSAGES__
  41. #define __BLASTMESSAGES__
  42. #include <algo/blast/core/blast_def.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /** Blast error message severities */
  47. typedef enum {
  48.    BLAST_SEV_INFO = 0,
  49.    BLAST_SEV_WARNING,
  50.    BLAST_SEV_ERROR,
  51.    BLAST_SEV_FATAL
  52. } BlastSeverity;
  53. /** Structure to hold the a message from the BLAST code. */
  54. typedef struct Blast_Message {
  55. BlastSeverity severity; /**< severity code (0, 1, 2, 3) */
  56. Int4 code; /**< major code for error. */
  57. Int4 subcode; /**< minor code for this error. */
  58. char* message; /**< User message to be saved. */
  59. } Blast_Message;
  60. /** Deallocates message memory.
  61.  * @param blast_msg structure to be deallocated [in]
  62. */
  63. Blast_Message* Blast_MessageFree(Blast_Message* blast_msg);
  64. /** Writes a message to a structure.  The Blast_Message* is allocated.
  65.  * @param blast_msg structure to be filled in [in] 
  66.  * @param severity severity code (0, 1, 2, 3) [in] 
  67.  * @param code major code for this error [in]
  68.  * @param subcode minor code for this error [in] 
  69.  * @param message User message to be saved [in]
  70. */
  71. Int2 Blast_MessageWrite(Blast_Message* *blast_msg, BlastSeverity severity, 
  72.                         Int4 code, Int4 subcode, const char *message);
  73. /** Print a message with ErrPostEx
  74.  * @param blast_msg message to be printed [in]
  75. */
  76. Int2 Blast_MessagePost(Blast_Message* blast_msg);
  77. #ifdef __cplusplus
  78. }
  79. #endif
  80. #endif /* !__BLASTMESSAGES__ */