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

Go to the SVN repository for this file.

1 #ifndef OBJTOOLS_READERS_SEQDB__SEQDBTAX_HPP
2 #define OBJTOOLS_READERS_SEQDB__SEQDBTAX_HPP
3 
4 /* $Id: seqdbtax.hpp 90549 2020-06-26 12:59:33Z grichenk $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Author: Kevin Bealer
30  *
31  */
32 
33 /// @file seqdbtax.hpp
34 /// Defines database volume access classes.
35 ///
36 /// Defines classes:
37 /// CSeqDBTaxNames, CSeqDBTaxId, CSeqDBTaxInfo
38 ///
39 /// Implemented for: UNIX, MS-Windows
40 
44 
46 
47 /// Import definitions from the objects namespace.
49 
50 
51 
52 /// CSeqDBTaxInfo class
53 ///
54 /// This manages access to the taxonomy database.
55 
57 public:
58 
59  /// Get the taxonomy names for a given tax id
60  ///
61  /// The tax id is looked up in the taxonomy database and the
62  /// corresponding strings indicating the taxonomy names are
63  /// returned in the provided structure.
64  ///
65  /// @param tax_id
66  /// The taxonomic identiifer.
67  /// @param info
68  /// A container structure in which to return the names.
69  /// @param locked
70  /// The lock holder object for this thread.
71  /// @return true if the taxonomic id was found
72  static bool GetTaxNames(TTaxId tax_id, SSeqDBTaxInfo & info);
73 
74 
75 };
76 
78 
79 #endif // OBJTOOLS_READERS_SEQDB__SEQDBTAX_HPP
80 
81 
CSeqDBTaxInfo class.
Definition: seqdbtax.hpp:56
SStrictId_Tax::TId TTaxId
Taxon id type.
Definition: ncbimisc.hpp:1048
#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_XOBJREAD_EXPORT
Definition: ncbi_export.h:1315
static MDB_envinfo info
Definition: mdb_load.c:37
Defines BLAST database access classes.
File access objects for CSeqDB.
ISAM index database access object.
USING_SCOPE(objects)
Import definitions from the objects namespace.
SSeqDBTaxInfo.
Modified on Sun Apr 14 05:29:13 2024 by modify_doxy.py rev. 669887