NCBI C++ ToolKit
Blast4_error_code_.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id$
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file Blast4_error_code_.hpp
29 /// Data storage class.
30 ///
31 /// This file was generated by application DATATOOL
32 /// using the following specifications:
33 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blast/blast.asn">blast.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blast/blast.def">blast.def</a>
36 ///
37 /// ATTENTION:
38 /// Don't edit or commit this file into CVS as this file will
39 /// be overridden (by DATATOOL) without warning!
40 
41 #ifndef OBJECTS_BLAST_BLAST4_ERROR_CODE_BASE_HPP
42 #define OBJECTS_BLAST_BLAST4_ERROR_CODE_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
47 
48 #ifndef BEGIN_objects_SCOPE
49 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
50 # define END_objects_SCOPE END_SCOPE(objects)
51 #endif
52 BEGIN_objects_SCOPE // namespace ncbi::objects::
53 
54 
55 // generated classes
56 
57 
58 /** @addtogroup dataspec_NCBI_Blast4
59  *
60  * @{
61  */
62 
63 /// Defines values for use in Blast4-error::code.
64 /// Note: warnings should have values greater than 1024 and less than 2048,
65 /// errors should have values greater than 2048.
67  eBlast4_error_code_conversion_warning = 1024, ///< A conversion issue was found when converting to/from blast3 from/to blast4 protocol in the blast4 server
68  eBlast4_error_code_internal_error = 2048, ///< Indicates internal errors in the blast4 server
69  eBlast4_error_code_not_implemented = 2049, ///< Request type is not implemented in the blast4 server
70  eBlast4_error_code_not_allowed = 2050, ///< Request type is not allowed in the blast4 server
71  eBlast4_error_code_bad_request = 2051, ///< Malformed/invalid requests (e.g.: parsing errors or invalid data in request)
72  eBlast4_error_code_bad_request_id = 2052, ///< The RID requested is unknown or it has expired
73  eBlast4_error_code_search_pending = 2053 ///< The search is pending
74 };
75 
76 /// Access to EBlast4_error_code's attributes (values, names) as defined in spec
77 NCBI_BLAST_EXPORT const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EBlast4_error_code)(void);
78 
79 
80 /* @} */
81 END_objects_SCOPE // namespace ncbi::objects::
82 
84 
85 
86 #endif // OBJECTS_BLAST_BLAST4_ERROR_CODE_BASE_HPP
#define ENUM_METHOD_NAME(EnumName)
Definition: serialbase.hpp:994
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_BLAST_EXPORT
Definition: ncbi_export.h:360
EBlast4_error_code
Defines values for use in Blast4-errorcode.
@ eBlast4_error_code_bad_request_id
The RID requested is unknown or it has expired.
@ eBlast4_error_code_not_implemented
Request type is not implemented in the blast4 server.
@ eBlast4_error_code_search_pending
The search is pending.
@ eBlast4_error_code_conversion_warning
A conversion issue was found when converting to/from blast3 from/to blast4 protocol in the blast4 ser...
@ eBlast4_error_code_not_allowed
Request type is not allowed in the blast4 server.
@ eBlast4_error_code_bad_request
Malformed/invalid requests (e.g.: parsing errors or invalid data in request)
@ eBlast4_error_code_internal_error
Indicates internal errors in the blast4 server.
Modified on Thu Feb 22 17:10:26 2024 by modify_doxy.py rev. 669887