The configuration data for the Blast Service. More...

#include <blast_service.h>

Inheritance diagram for BlastServiceData:

Collaboration diagram for BlastServiceData:

Public Member Functions
bool	GetBlastServiceConfig (BlastServiceData *data_p)
	Check whether the required configuration details contain the required information for a Blast Service to be used. More...

BlastServiceData *	AllocateBlastServiceData (Service *blast_service_p, DatabaseType database_type)
	Allocate a BlastServiceData. More...

void	FreeBlastServiceData (BlastServiceData *data_p)
	Free a BlastServiceData. More...

Data Fields
ServiceData	bsd_base_data
	The base ServiceData. More...

char *	bsd_working_dir_s
	The directory where the Blast input, output and log files will be stored. More...

BlastFormatter *	bsd_formatter_p
	The BlastFormatter used to convert the Blast output between the different output formats. More...

DatabaseInfo *	bsd_databases_p
	A NULL-terminated array of the databases available to search. More...

BlastToolFactory *	bsd_tool_factory_p
	The BlastToolFactory used to generate each BlastTool that actually run the Blast jobs. More...

DatabaseType	bsd_type
	Specifies whether the databases are nucleotide or protein databases. More...

AsyncTasksManager *	bsd_task_manager_p

Data Fields inherited from ServiceData
struct Service *	sd_service_p
	The service that owns this data. More...

json_t *	sd_config_p
	If this service has an entry in global server config it will be stored here. More...

bool	sd_config_flag
	If this is true, then this ServiceData will decrease the reference count on sd_config_p when this ServiceData is freed. More...

Detailed Description

The configuration data for the Blast Service.

Member Function Documentation

◆ AllocateBlastServiceData()

BlastServiceData * AllocateBlastServiceData	(	Service *	blast_service_p,
		DatabaseType	database_type
	)

Allocate a BlastServiceData.

Parameters

blast_service_p	The Blast Service that will own this BlastServiceData.
database_type	The type of data that the given Blast Service can act upon.

Returns: The newly-created BlastServiceData or NULL upon error.

◆ FreeBlastServiceData()

void FreeBlastServiceData ( BlastServiceData * data_p )

Free a BlastServiceData.

Parameters

data_p The BlastServiceData to free.

Field Documentation

◆ bsd_base_data

ServiceData bsd_base_data

The base ServiceData.

◆ bsd_working_dir_s

char* bsd_working_dir_s

The directory where the Blast input, output and log files will be stored.

◆ bsd_formatter_p

BlastFormatter* bsd_formatter_p

The BlastFormatter used to convert the Blast output between the different output formats.

◆ bsd_databases_p

DatabaseInfo* bsd_databases_p

A NULL-terminated array of the databases available to search.

◆ bsd_tool_factory_p

BlastToolFactory* bsd_tool_factory_p

The BlastToolFactory used to generate each BlastTool that actually run the Blast jobs.

◆ bsd_type

DatabaseType bsd_type

Specifies whether the databases are nucleotide or protein databases.

◆ bsd_task_manager_p

AsyncTasksManager* bsd_task_manager_p

The documentation for this struct was generated from the following file:

blast_service.h

Public Member Functions

Data Fields