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

Go to the SVN repository for this file.

1 /* $Id: ilinkoutdb.hpp 58134 2013-05-13 19:13:43Z grichenk $
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  * Author: Christiam Camacho
27  *
28  */
29 
30 /// @file ilinkoutdb.hpp
31 /// Declares the ILinkoutDB interface
32 
33 #ifndef OBJTOOLS_ALIGN_FORMAT___ILINKOUTDB_HPP
34 #define OBJTOOLS_ALIGN_FORMAT___ILINKOUTDB_HPP
35 
37 
38 /**setting up scope*/
40 BEGIN_SCOPE(align_format)
41 
42 /// Interface to LinkoutDB
44 public:
45  /// Retrieve the Linkout for a given GI
46  /// @param gi GI of interest [in]
47  /// @param mv_build_name MapViewer build name for this GI [in]
48  /// @return integer encoding linkout bits or 0 if not found
49  virtual int GetLinkout(TGi gi, const string& mv_build_name) = 0;
50 
51  /// Retrieve the Linkout for a given Seq-id
52  /// @param id Seq-id of interest [in]
53  /// @param mv_build_name MapViewer build name for this Seq-id [in]
54  /// @return integer encoding linkout bits or 0 if not found
55  virtual int GetLinkout(const objects::CSeq_id& id, const string& mv_build_name) = 0;
56 };
57 
58 
59 END_SCOPE(align_format)
61 
62 #endif /* OBJTOOLS_ALIGN_FORMAT___ILINKOUTDB_HPP */
CObject –.
Definition: ncbiobj.hpp:180
setting up scope
Definition: ilinkoutdb.hpp:43
virtual int GetLinkout(const objects::CSeq_id &id, const string &mv_build_name)=0
Retrieve the Linkout for a given Seq-id.
virtual int GetLinkout(TGi gi, const string &mv_build_name)=0
Retrieve the Linkout for a given GI.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define END_SCOPE(ns)
End the previously defined scope.
Definition: ncbistl.hpp:75
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define BEGIN_SCOPE(ns)
Define a new scope.
Definition: ncbistl.hpp:72
#define NCBI_ALIGN_FORMAT_EXPORT
Definition: ncbi_export.h:1081
Modified on Wed Jun 12 11:11:21 2024 by modify_doxy.py rev. 669887