#include "service.h"
#include "library.h"
#include "async_tasks_manager.h"

Include dependency graph for polymarker_service.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	PolymarkerSequence
	A datatype that stores the information of sequence data that the PolymarkerService can run with. More...

struct	PolymarkerServiceData
	The ServiceData used for the PolymarkerService. More...

Macros
#define	POLYMARKER_SERVICE_API

#define	POLYMARKER_SERVICE_LOCAL

Enumerations
enum	PolymarkerToolType { PTT_WEB, PTT_SYSTEM, PTT_NUM_TYPES }
	An enum listing the different types of PolymarkerTool that are available. More...

Functions
ServicesArray *	GetServices (UserDetails user_p, GrassrootsServer grassroots_p)
	Get the ServicesArray containing the Polymarker Services. More...

void	ReleaseServices (ServicesArray *services_p)
	Free the ServicesArray containing the Polymarker Services. More...

void	ReleasePolymarkerService (Service *service_p)

Variables
NamedParameterType	PS_CONTIG_FILENAME { .npt_name_s = "Contig filename" , .npt_type = PT_STRING }
	The NamedParameterType for the contig filename parameter. More...

NamedParameterType	PS_GENE_ID { .npt_name_s = "Gene" , .npt_type = PT_STRING }
	The NamedParameterType for the gene ID parameter. More...

NamedParameterType	PS_TARGET_CHROMOSOME { .npt_name_s = "Chromosome" , .npt_type = PT_STRING }
	The NamedParameterType for the target chromosome parameter. More...

NamedParameterType	PS_SEQUENCE { .npt_name_s = "Sequence" , .npt_type = PT_LARGE_STRING }
	The NamedParameterType for the sequence parameter. More...

NamedParameterType	PS_JOB_IDS { .npt_name_s = "Previous results" , .npt_type = PT_LARGE_STRING }
	The NamedParameterType for the parameter used for retrieving the results of previously-run jobs. More...

const char *	PS_TOOL_S = "tool"
	The constant string for configuring the tool that Polymarker will use. More...

const char *	PS_TOOL_SYSTEM_S = "system"
	The constant string for denoting that Polymarker will use the system-based tool. More...

const char *	PS_TOOL_WEB_S = "web"
	The constant string for denoting that Polymarker will use the web-based tool. More...

const char *	PS_ALIGNER_BLAST_S = "blast"
	The constant string for denoting that Polymarker will use the blast aligner. More...

const char *	PS_ALIGNER_EXONERATE_S = "exonerate"
	The constant string for denoting that Polymarker will use the exonerate aligner. More...

Macro Definition Documentation

◆ POLYMARKER_SERVICE_API

#define POLYMARKER_SERVICE_API

◆ POLYMARKER_SERVICE_LOCAL

#define POLYMARKER_SERVICE_LOCAL

Enumeration Type Documentation

◆ PolymarkerToolType

enum PolymarkerToolType

An enum listing the different types of PolymarkerTool that are available.

Enumerator
PTT_WEB	The web-based tool.
PTT_SYSTEM	Run the Polymarker program directly on the server.
PTT_NUM_TYPES	The number of different PolymarkerTools available.

Function Documentation

◆ GetServices()

ServicesArray* GetServices	(	UserDetails *	user_p,
		GrassrootsServer *	grassroots_p
	)

Get the ServicesArray containing the Polymarker Services.

Parameters

user_p The UserDetails for the user trying to access the services. This can be NULL.

Returns: The ServicesArray containing all of the Polymarker Services or NULL upon error.

◆ ReleaseServices()

void ReleaseServices ( ServicesArray * services_p )

Free the ServicesArray containing the Polymarker Services.

Parameters

services_p The ServicesArray to free.

◆ ReleasePolymarkerService()

void ReleasePolymarkerService ( Service * service_p )

Variable Documentation

◆ PS_CONTIG_FILENAME

NamedParameterType PS_CONTIG_FILENAME { .npt_name_s = "Contig filename" , .npt_type = PT_STRING }

The NamedParameterType for the contig filename parameter.

◆ PS_GENE_ID

NamedParameterType PS_GENE_ID { .npt_name_s = "Gene" , .npt_type = PT_STRING }

The NamedParameterType for the gene ID parameter.

◆ PS_TARGET_CHROMOSOME

NamedParameterType PS_TARGET_CHROMOSOME { .npt_name_s = "Chromosome" , .npt_type = PT_STRING }

The NamedParameterType for the target chromosome parameter.

◆ PS_SEQUENCE

NamedParameterType PS_SEQUENCE { .npt_name_s = "Sequence" , .npt_type = PT_LARGE_STRING }

The NamedParameterType for the sequence parameter.

◆ PS_JOB_IDS

NamedParameterType PS_JOB_IDS { .npt_name_s = "Previous results" , .npt_type = PT_LARGE_STRING }

The NamedParameterType for the parameter used for retrieving the results of previously-run jobs.

◆ PS_TOOL_S

const char* PS_TOOL_S = "tool"

The constant string for configuring the tool that Polymarker will use.

◆ PS_TOOL_SYSTEM_S

const char* PS_TOOL_SYSTEM_S = "system"

The constant string for denoting that Polymarker will use the system-based tool.

◆ PS_TOOL_WEB_S

const char* PS_TOOL_WEB_S = "web"

The constant string for denoting that Polymarker will use the web-based tool.

◆ PS_ALIGNER_BLAST_S

const char* PS_ALIGNER_BLAST_S = "blast"

The constant string for denoting that Polymarker will use the blast aligner.

◆ PS_ALIGNER_EXONERATE_S

const char* PS_ALIGNER_EXONERATE_S = "exonerate"

The constant string for denoting that Polymarker will use the exonerate aligner.

Data Structures

Macros

Enumerations

Functions

Variables