Grassroots Infrastructure
The Grassroots Infrastructure is a suite of computing tools to help users and developers use scientific data infrastructure that can easily be interconnected.
blastp_service.h
Go to the documentation of this file.
1 /*
2  * protein_blast_service.h
3  *
4  * Created on: 13 Oct 2016
5  * Author: billy
6  */
7 
8 #ifndef SERVER_SRC_SERVICES_BLAST_INCLUDE_BLASTP_SERVICE_H_
9 #define SERVER_SRC_SERVICES_BLAST_INCLUDE_BLASTP_SERVICE_H_
10 
11 
12 #include "args_processor.hpp"
13 #include "blast_service.h"
14 #include "blast_service_api.h"
15 #include "blast_service_params.h"
16 #include "parameter_set.h"
17 #include "service.h"
18 
19 
20 #ifdef __cplusplus
21 extern "C"
22 {
23 #endif
24 
32 BLAST_SERVICE_LOCAL Service *GetBlastPService (GrassrootsServer *grassroots_p);
33 
34 
35 BLAST_SERVICE_LOCAL bool AddProteinBlastParameters (BlastServiceData *data_p, ParameterSet *param_set_p);
36 
37 
38 BLAST_SERVICE_LOCAL bool ParseBlastPParameters (const BlastServiceData *data_p, ParameterSet *params_p, ArgsProcessor *ap_p);
39 
40 
41 BLAST_SERVICE_LOCAL ParameterSet *CreateProteinBlastServiceParameters (Service *service_p, DataResource *resource_p, const char *param_set_name_s, const char *param_set_description_s, AddAdditionalParamsFn query_sequence_callback_fn, void *callback_data_p, const BlastTask *tasks_p, const uint32 num_tasks);
42 
43 
44 BLAST_SERVICE_LOCAL bool GetProteinBlastParameterTypeForNamedParameter (const char *param_name_s, ParameterType *pt_p);
45 
46 
47 #ifdef __cplusplus
48 }
49 #endif
50 
51 
52 #endif /* SERVER_SRC_SERVICES_BLAST_INCLUDE_BLASTP_SERVICE_H_ */
BlastTask
This datatype is used for describing the algorithms that some of the BLAST tools allow the user to ch...
Definition: blast_service_params.h:204
AddAdditionalParamsFn
bool(* AddAdditionalParamsFn)(BlastServiceData *data_p, ParameterSet *param_set_p, ParameterGroup *group_p, const void *callback_data_p)
A callback function used to amend a given ParameterSet.
Definition: blast_service.h:186
ParameterType
ParameterType
The different types that a Parameter can take.
Definition: parameter_type.h:35
service.h
parameter_set.h
BlastServiceData
The configuration data for the Blast Service.
Definition: blast_service.h:143
DataResource
A datatype representing a URI.
Definition: data_resource.h:40
blast_service_params.h
blast_service_api.h
args_processor.hpp
Service
A datatype which defines an available service, its capabilities and its parameters.
Definition: service.h:153
BLAST_SERVICE_LOCAL
#define BLAST_SERVICE_LOCAL
Definition: blast_service_api.h:48
ParseBlastPParameters
bool ParseBlastPParameters(const BlastServiceData *data_p, ParameterSet *params_p, ArgsProcessor *ap_p)
CreateProteinBlastServiceParameters
ParameterSet * CreateProteinBlastServiceParameters(Service *service_p, DataResource *resource_p, const char *param_set_name_s, const char *param_set_description_s, AddAdditionalParamsFn query_sequence_callback_fn, void *callback_data_p, const BlastTask *tasks_p, const uint32 num_tasks)
GrassrootsServer
Definition: grassroots_server.h:45
AddProteinBlastParameters
bool AddProteinBlastParameters(BlastServiceData *data_p, ParameterSet *param_set_p)
blast_service.h
GetProteinBlastParameterTypeForNamedParameter
bool GetProteinBlastParameterTypeForNamedParameter(const char *param_name_s, ParameterType *pt_p)
ParameterSet
A set of Parameters along with an optional name and description.
Definition: parameter_set.h:46
GetBlastPService
Service * GetBlastPService(GrassrootsServer *grassroots_p)
Get a Service capable of running BlastP searches.
ArgsProcessor
An ArgsProcessor is a class to abstract out how a particular BlastTool stores a value when an argumen...
Definition: args_processor.hpp:46