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

Go to the SVN repository for this file.

1 #ifndef ALGO_BLAST_API___PHIBLAST_PROT_OPTIONS__HPP
2 #define ALGO_BLAST_API___PHIBLAST_PROT_OPTIONS__HPP
3 
4 /* $Id: phiblast_prot_options.hpp 33815 2007-05-04 17:18:18Z kazimird $
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  * Authors: Ilya Dondoshansky
30  *
31  */
32 
33 /// @file phiblast_prot_options.hpp
34 /// Declares the CPHIBlastProtOptionsHandle class.
35 
36 
39 
40 /** @addtogroup AlgoBlast
41  *
42  * @{
43  */
44 
46 BEGIN_SCOPE(blast)
47 
48 /// Handle to the protein PHI BLAST options.
49 ///
50 /// Adapter class for PHI BLAST search.
51 /// Exposes an interface to allow manipulation the options that are relevant to
52 /// this type of search.
53 
55 {
56 public:
57 
58  /// Creates object with default options set
61 
62  /******************* PHI options ***********************/
63  const char* GetPHIPattern() const;
64  void SetPHIPattern(const char* p);
65 
66 private:
67  /// Disallow copy constructor
69  /// Disallow assignment operator
71 };
72 
73 /// Retrieves the pattern string option
74 /// @return Pattern string satisfying PROSITE rules.
76 {
77  return m_Opts->GetPHIPattern();
78 }
79 
80 /// Sets the pattern string option
81 /// @param pattern The pattern string satisfying PROSITE rules.
82 inline void CPHIBlastProtOptionsHandle::SetPHIPattern(const char* pattern)
83 {
84  m_Opts->SetPHIPattern(pattern, false);
85 }
86 
87 END_SCOPE(blast)
89 
90 
91 /* @} */
92 
93 #endif /* ALGO_BLAST_API___PHIBLAST_PROT_OPTIONS__HPP */
Declares the CBlastAdvancedProteinOptionsHandle class.
#define NCBI_XBLAST_EXPORT
NULL operations for other cases.
Definition: blast_export.h:65
Declares the CBlastProteinOptionsHandle class.
EAPILocality
Enumerates the possible contexts in which objects of this type can be used.
@ eLocal
To be used for running BLAST locally.
Handle to the protein-protein options to the BLAST algorithm.
Handle to the protein PHI BLAST options.
void SetPHIPattern(const char *pattern, bool is_dna)
CPHIBlastProtOptionsHandle & operator=(const CPHIBlastProtOptionsHandle &rhs)
Disallow assignment operator.
const char * GetPHIPattern() const
void SetPHIPattern(const char *p)
Sets the pattern string option.
CRef< CBlastOptions > m_Opts
Data type this class controls access to.
const char * GetPHIPattern() const
Retrieves the pattern string option.
CPHIBlastProtOptionsHandle(const CPHIBlastProtOptionsHandle &rhs)
Disallow copy constructor.
#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
Modified on Mon Jul 22 05:04:07 2024 by modify_doxy.py rev. 669887