NCBI C++ ToolKit
include
objects
blast
blastclient_.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 blastclient_.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_BLASTCLIENT_BASE_HPP
42
#define OBJECTS_BLAST_BLASTCLIENT_BASE_HPP
43
44
// standard includes
45
#include <
serial/serialbase.hpp
>
46
47
// generated includes
48
#include <
objects/blast/Blast4_reply.hpp
>
49
#include <
objects/blast/Blast4_reply_body.hpp
>
50
#include <
objects/blast/Blast4_request.hpp
>
51
#include <
objects/blast/Blast4_request_body.hpp
>
52
#include <
serial/rpcbase.hpp
>
53
54
BEGIN_NCBI_SCOPE
55
56
#ifndef BEGIN_objects_SCOPE
57
# define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
58
# define END_objects_SCOPE END_SCOPE(objects)
59
#endif
60
BEGIN_objects_SCOPE
// namespace ncbi::objects::
61
62
63
// generated classes
64
65
66
/** @addtogroup dataspec_NCBI_Blast4
67
*
68
* @{
69
*/
70
71
/////////////////////////////////////////////////////////////////////////////
72
///
73
/// CBlast4Client_Base --
74
///
75
76
class
NCBI_BLAST_EXPORT
CBlast4Client_Base
:
public
CRPCClient
<CBlast4_request, CBlast4_reply>
77
{
78
typedef
CRPCClient<CBlast4_request, CBlast4_reply>
Tparent
;
79
public
:
80
// constructor
81
CBlast4Client_Base
(
void
);
82
// destructor
83
virtual
~
CBlast4Client_Base
(
void
);
84
85
typedef
CBlast4_request
TRequest
;
86
typedef
CBlast4_reply
TReply
;
87
typedef
CBlast4_request_body
TRequestChoice
;
88
typedef
CBlast4_reply_body
TReplyChoice
;
89
90
virtual
void
Ask
(
const
TRequest
& request,
TReply
& reply);
91
virtual
void
Ask
(
const
TRequest
& request,
TReply
& reply,
92
TReplyChoice::E_Choice
wanted);
93
94
95
virtual
const
TRequest
& GetDefaultRequest(
void
)
const
;
96
virtual
TRequest
& SetDefaultRequest(
void
);
97
virtual
void
SetDefaultRequest(
const
TRequest
& request);
98
99
virtual
void
Ask
(
const
TRequestChoice
& req,
TReply
& reply);
100
virtual
void
Ask
(
const
TRequestChoice
& req,
TReply
& reply,
101
TReplyChoice::E_Choice
wanted);
102
103
virtual
CRef<CBlast4_finish_params_reply>
AskFinish_params
104
(
const
CBlast4_finish_params_request
& req,
TReply
* reply = 0);
105
106
virtual
CRef<CBlast4_get_databases_reply>
AskGet_databases
107
(
TReply
* reply = 0);
108
109
virtual
CRef<CBlast4_get_matrices_reply>
AskGet_matrices
110
(
TReply
* reply = 0);
111
112
virtual
CRef<CBlast4_get_parameters_reply>
AskGet_parameters
113
(
TReply
* reply = 0);
114
115
virtual
CRef<CBlast4_get_paramsets_reply>
AskGet_paramsets
116
(
TReply
* reply = 0);
117
118
virtual
CRef<CBlast4_get_programs_reply>
AskGet_programs
119
(
TReply
* reply = 0);
120
121
virtual
CRef<CBlast4_get_search_results_reply>
AskGet_search_results
122
(
const
CBlast4_get_search_results_request
& req,
TReply
* reply = 0);
123
124
virtual
CRef<CBlast4_get_sequences_reply>
AskGet_sequences
125
(
const
CBlast4_get_sequences_request
& req,
TReply
* reply = 0);
126
127
virtual
CRef<CBlast4_queue_search_reply>
AskQueue_search
128
(
const
CBlast4_queue_search_request
& req,
TReply
* reply = 0);
129
130
virtual
CRef<CBlast4_get_request_info_reply>
AskGet_request_info
131
(
const
CBlast4_get_request_info_request
& req,
TReply
* reply = 0);
132
133
virtual
CRef<CBlast4_get_seq_parts_reply>
AskGet_sequence_parts
134
(
const
CBlast4_get_seq_parts_request
& req,
TReply
* reply = 0);
135
136
virtual
CRef<CBlast4_get_windowmasked_taxids_reply>
AskGet_windowmasked_taxids
137
(
TReply
* reply = 0);
138
139
virtual
CRef<CBlast4_get_protocol_info_reply>
AskGet_protocol_info
140
(
const
CBlast4_get_protocol_info_request
& req,
TReply
* reply = 0);
141
142
virtual
CRef<CBlast4_get_search_info_reply>
AskGet_search_info
143
(
const
CBlast4_get_search_info_request
& req,
TReply
* reply = 0);
144
145
virtual
CRef<CBlast4_get_databases_ex_reply>
AskGet_databases_ex
146
(
const
CBlast4_get_databases_ex_request
& req,
TReply
* reply = 0);
147
148
149
private
:
150
CRef<TRequest>
m_DefaultRequest
;
151
152
TReplyChoice
& x_Choice(
TReply
& reply);
153
};
154
155
/* @} */
156
157
158
159
160
161
///////////////////////////////////////////////////////////
162
///////////////////// inline methods //////////////////////
163
///////////////////////////////////////////////////////////
164
inline
165
CBlast4Client_Base::TReplyChoice
&
CBlast4Client_Base::x_Choice
(
CBlast4Client_Base::TReply
& reply)
166
{
167
return
reply.
SetBody
();
168
}
169
170
inline
171
void
CBlast4Client_Base::Ask
(
const
CBlast4Client_Base::TRequest
& request,
CBlast4Client_Base::TReply
& reply)
172
{
173
Tparent::Ask
(request, reply);
174
}
175
176
177
inline
178
const
CBlast4Client_Base::TRequest
&
CBlast4Client_Base::GetDefaultRequest
(
void
)
const
179
{
180
return
*
m_DefaultRequest
;
181
}
182
183
inline
184
CBlast4Client_Base::TRequest
&
CBlast4Client_Base::SetDefaultRequest
(
void
)
185
{
186
return
*
m_DefaultRequest
;
187
}
188
189
inline
190
void
CBlast4Client_Base::SetDefaultRequest
(
const
CBlast4Client_Base::TRequest
& request)
191
{
192
m_DefaultRequest
->Assign(request);
193
}
194
195
196
///////////////////////////////////////////////////////////
197
////////////////// end of inline methods //////////////////
198
///////////////////////////////////////////////////////////
199
200
201
202
203
204
END_objects_SCOPE
// namespace ncbi::objects::
205
206
END_NCBI_SCOPE
207
208
209
#endif
// OBJECTS_BLAST_BLASTCLIENT_BASE_HPP
Blast4_reply.hpp
User-defined methods of the data storage class.
Blast4_reply_body.hpp
User-defined methods of the data storage class.
Blast4_request.hpp
User-defined methods of the data storage class.
Blast4_request_body.hpp
User-defined methods of the data storage class.
CBlast4Client_Base
CBlast4Client_Base –.
Definition:
blastclient_.hpp:77
CBlast4_finish_params_request
CBlast4_finish_params_request –.
Definition:
Blast_finish_params_reques.hpp:66
CBlast4_get_databases_ex_request
CBlast4_get_databases_ex_request –.
Definition:
Blast_get_databa_ex_reques.hpp:66
CBlast4_get_protocol_info_request
CBlast4_get_protocol_info_request –.
Definition:
Blast_get_proto_info_reque.hpp:66
CBlast4_get_request_info_request
CBlast4_get_request_info_request –.
Definition:
Blast_get_reque_info_reque.hpp:66
CBlast4_get_search_info_request
CBlast4_get_search_info_request –.
Definition:
Blast_get_searc_info_reque.hpp:66
CBlast4_get_search_results_request
CBlast4_get_search_results_request –.
Definition:
Blas_get_searc_resul_reque.hpp:66
CBlast4_get_seq_parts_request
CBlast4_get_seq_parts_request –.
Definition:
Blast_get_seq_parts_reques.hpp:66
CBlast4_get_sequences_request
CBlast4_get_sequences_request –.
Definition:
Blast4_get_sequenc_request.hpp:66
CBlast4_queue_search_request
CBlast4_queue_search_request –.
Definition:
Blast4_queue_search_reques.hpp:66
CBlast4_reply_body
CBlast4_reply_body –.
Definition:
Blast4_reply_body.hpp:66
CBlast4_reply
CBlast4_reply –.
Definition:
Blast4_reply.hpp:66
CBlast4_request_body
CBlast4_request_body –.
Definition:
Blast4_request_body.hpp:66
CBlast4_request
CBlast4_request –.
Definition:
Blast4_request.hpp:66
CRPCClient
CRPCClient – prototype client for ASN.1/XML-based RPC.
Definition:
rpcbase.hpp:63
CRef
CRef –.
Definition:
ncbiobj.hpp:618
CRPCClient::Ask
virtual void Ask(const TRequest &request, TReply &reply)
Definition:
rpcbase.hpp:87
END_NCBI_SCOPE
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition:
ncbistl.hpp:103
BEGIN_NCBI_SCOPE
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition:
ncbistl.hpp:100
NCBI_BLAST_EXPORT
#define NCBI_BLAST_EXPORT
Definition:
ncbi_export.h:360
CBlast4_reply_body_Base::E_Choice
E_Choice
Choice variants.
Definition:
Blast4_reply_body_.hpp:101
CBlast4Client_Base::SetDefaultRequest
virtual TRequest & SetDefaultRequest(void)
Definition:
blastclient_.hpp:184
CBlast4Client_Base::m_DefaultRequest
CRef< TRequest > m_DefaultRequest
Definition:
blastclient_.hpp:150
CBlast4Client_Base::GetDefaultRequest
virtual const TRequest & GetDefaultRequest(void) const
Definition:
blastclient_.hpp:178
CBlast4Client_Base::TReplyChoice
CBlast4_reply_body TReplyChoice
Definition:
blastclient_.hpp:88
CBlast4Client_Base::TReply
CBlast4_reply TReply
Definition:
blastclient_.hpp:86
CBlast4Client_Base::TRequest
CBlast4_request TRequest
Definition:
blastclient_.hpp:85
CBlast4_reply_Base::SetBody
void SetBody(TBody &value)
Assign a value to Body data member.
Definition:
Blast4_reply_.cpp:67
CBlast4Client_Base::x_Choice
TReplyChoice & x_Choice(TReply &reply)
Definition:
blastclient_.hpp:165
CBlast4Client_Base::Tparent
CRPCClient< CBlast4_request, CBlast4_reply > Tparent
Definition:
blastclient_.hpp:78
CBlast4Client_Base::Ask
virtual void Ask(const TRequest &request, TReply &reply)
Definition:
blastclient_.hpp:171
CBlast4Client_Base::TRequestChoice
CBlast4_request_body TRequestChoice
Definition:
blastclient_.hpp:87
rpcbase.hpp
serialbase.hpp
Generated by
1.9.0
Modified on Sun Apr 28 04:47:53 2024 by modify_doxy.py rev. 669887