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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: parameters.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/01 21:02:27  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CORE_002] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef DBAPI_DRIVER_UTIL___PARAMETERS__HPP
  10. #define DBAPI_DRIVER_UTIL___PARAMETERS__HPP
  11. /* $Id: parameters.hpp,v 1000.1 2004/04/01 21:02:27 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Vladimir Soussov
  37.  *
  38.  * File Description:  Param container
  39.  *
  40.  */
  41. #include <dbapi/driver/types.hpp>
  42. BEGIN_NCBI_SCOPE
  43. NCBI_DBAPIDRIVER_EXPORT
  44. void g_SubstituteParam(string& query, const string& name, const string& val);
  45. class NCBI_DBAPIDRIVER_EXPORT  CDB_Params
  46. {
  47. public:
  48.     CDB_Params(unsigned int nof_params = 0);
  49.     // static const unsigned int kNoParamNumber = kMax_UInt; <<=not compatible with MS compiler
  50.     enum { kNoParamNumber = kMax_UInt };
  51.     bool BindParam(unsigned int param_no, const string& param_name,
  52.                    CDB_Object* param, bool is_out = false);
  53.     bool SetParam(unsigned int param_no, const string& param_name,
  54.                   CDB_Object* param, bool is_out = false);
  55.     unsigned int NofParams() const {
  56.         return m_NofParams;
  57.     }
  58.     CDB_Object* GetParam(unsigned int param_no) const {
  59.         return (param_no >= m_NofParams) ? 0 : m_Params[param_no].param;
  60.     }
  61.     const string& GetParamName(unsigned int param_no) const {
  62.         return (param_no >= m_NofParams) ? kEmptyStr : m_Params[param_no].name;
  63.     }
  64.     enum EStatus {
  65.         fBound  = 0x1,  // the parameter is bound to some pointer
  66.         fSet    = 0x2,  // the parameter is set (value copied)
  67.         fOutput = 0x4   // it is "output" parameter
  68.     };
  69.     typedef int TStatus;
  70.     TStatus GetParamStatus(unsigned int param_no) const {
  71.         return (param_no >= m_NofParams) ? 0 : m_Params[param_no].status;
  72.     }
  73.     ~CDB_Params();
  74. private:
  75.     unsigned int m_NofParams;
  76.     struct SParam {
  77.         string       name;
  78.         CDB_Object*  param;
  79.         TStatus      status;
  80.     };
  81.     SParam* m_Params;
  82. };
  83. END_NCBI_SCOPE
  84. #endif  /* DBAPI_DRIVER_UTIL___PARAMETERS__HPP */
  85. /*
  86.  * ===========================================================================
  87.  * $Log: parameters.hpp,v $
  88.  * Revision 1000.1  2004/04/01 21:02:27  gouriano
  89.  * PRODUCTION: UPGRADED [CORE_002] Dev-tree R1.6
  90.  *
  91.  * Revision 1.6  2004/03/15 21:03:19  gorelenk
  92.  * Added export prefix NCBI_DBAPIDRIVER_EXPORT to declaration of function
  93.  * g_SubstituteParam.
  94.  *
  95.  * Revision 1.5  2003/02/13 15:40:50  ivanov
  96.  * Added export specifier NCBI_DBAPIDRIVER_EXPORT
  97.  *
  98.  * Revision 1.4  2001/12/28 21:22:39  sapojnik
  99.  * Made compatible with MS compiler: long long to Int8, static const within class def to enum
  100.  *
  101.  * Revision 1.3  2001/11/06 17:58:07  lavr
  102.  * Formatted uniformly as the rest of the library
  103.  *
  104.  * Revision 1.2  2001/10/22 15:18:29  lavr
  105.  * + g_SubstituteParam
  106.  *
  107.  * Revision 1.1  2001/09/21 23:39:55  vakatov
  108.  * -----  Initial (draft) revision.  -----
  109.  * This is a major revamp (by Denis Vakatov, with help from Vladimir Soussov)
  110.  * of the DBAPI "driver" libs originally written by Vladimir Soussov.
  111.  * The revamp involved massive code shuffling and grooming, numerous local
  112.  * API redesigns, adding comments and incorporating DBAPI to the C++ Toolkit.
  113.  *
  114.  * ===========================================================================
  115.  */