A class that will run Blast as an asynchronous system process. More...

#include <async_system_blast_tool.hpp>

Inheritance diagram for AsyncSystemBlastTool:

Collaboration diagram for AsyncSystemBlastTool:

Public Member Functions
	AsyncSystemBlastTool (BlastServiceJob service_job_p, const char name_s, const char factory_s, const BlastServiceData data_p, const char *blast_program_name_s)
	Create a AsyncSystemBlastTool for a given ServiceJob. More...

	AsyncSystemBlastTool (BlastServiceJob job_p, const BlastServiceData data_p, const json_t *json_p)
	Create a AsyncSystemBlastTool for a given ServiceJob using the configuration details from a serialised JSON fragment. More...

virtual	~AsyncSystemBlastTool ()
	The AsyncSystemBlastTool destructor. More...

virtual bool	AddToJSON (json_t *root_p)
	This method is used to serialise this AsyncSystemBlastTool so that it can be recreated from another calling process when required. More...

virtual OperationStatus	Run ()
	Run this AsyncSystemBlastTool. More...

virtual bool	PreRun ()
	Any custom functionality required before running a BlastTool. More...

virtual OperationStatus	GetStatus (bool update_flag=true)
	Get the status of an AsyncSystemBlastTool. More...

virtual char *	GetResults (BlastFormatter *formatter_p)
	Get the results after the AsyncSystemBlastTool has finished running. More...

Public Member Functions inherited from SystemBlastTool
	SystemBlastTool (BlastServiceJob service_job_p, const char name_s, const char factory_s, const BlastServiceData data_p, const char *blast_program_name_s)
	Create a SystemBlastTool for a given ServiceJob. More...

	SystemBlastTool (BlastServiceJob job_p, const BlastServiceData data_p, const json_t *json_p)
	Create a SystemBlastTool for a given ServiceJob using the configuration details from a serialised JSON fragment. More...

virtual	~SystemBlastTool ()
	The SystemBlastTool destructor. More...

virtual bool	ParseParameters (ParameterSet params_p, BlastAppParameters app_params_p)
	Parse a ParameterSet to configure a BlastTool prior to it being ran. More...

Public Member Functions inherited from ExternalBlastTool
	ExternalBlastTool (BlastServiceJob job_p, const char name_s, const char factory_s, const BlastServiceData data_p, const char *blast_program_name_s, const bool async_flag)
	Create a ExternalBlastTool for a given ServiceJob. More...

	ExternalBlastTool (BlastServiceJob job_p, const BlastServiceData data_p, const json_t *json_p)
	Create a ExternalBlastTool for a given ServiceJob using the configuration details from a serialised JSON fragment. More...

virtual	~ExternalBlastTool ()
	The ExternalBlastTool destructor. More...

virtual bool	SetInputFilename (const char *const filename_s)
	Set the input filename for the BlastTool to use. More...

virtual bool	SetUpOutputFile ()
	Set the output file parameter. More...

virtual char *	GetLog ()
	Get a copy of the log data from the run of this ExternalBlastTool's run. More...

Public Member Functions inherited from BlastTool
	BlastTool (BlastServiceJob job_p, const char name_s, const char factory_s, const BlastServiceData data_p, const uint32 output_format, const char *custom_output_s)
	Create a BlastTool for a given ServiceJob. More...

	BlastTool (BlastServiceJob job_p, const BlastServiceData data_p, const json_t *json_p)
	Create a BlastTool for a given ServiceJob. More...

virtual	~BlastTool ()
	The BlastTool destructor,. More...

uint32	GetOutputFormat () const
	Get the output format code that this BlastTool will produce its results in. More...

virtual void	PostRun ()
	Any custom functionality required after running a BlastTool. More...

virtual bool	AddErrorDetails ()

const uuid_t &	GetUUID () const
	Get the uuid for the ServiceJob that this BlastTool is linked with. More...

const char *	GetName () const
	Get the name asssociated with this BlastTool. More...

json_t *	GetAsJSON ()
	Get the JSON-based persistent description of this BlastTool. More...

const char *	GetFactoryName () const
	Get the name of the BlastToolFactory that created this BlastTool. More...

bool	SetCustomOutputColumns (const char *custom_columns_s)

void	FreeBlastTool (BlastTool *tool_p)
	Free a BlastTool. More...

OperationStatus	RunBlast (BlastTool *tool_p)
	Run Blast using the parameters that have been previously using ConvertArguments. More...

OperationStatus	GetBlastStatus (BlastTool *tool_p)
	Get the current OperationStatus of a BlastTool. More...

bool	IsBlastToolSynchronous (BlastTool *tool_p)
	Is the BlastTool going to run asynchronously? More...

Additional Inherited Members
Static Public Attributes inherited from ExternalBlastTool
static const char *const	EBT_INPUT_SUFFIX_S
	This is the string that will get appended to each input file used by the ExternalBlastTool. More...

static const char *const	EBT_ASYNC_S
	This is the string that will get appended to each log file created when an ExternalBlastTool is ran. More...

Protected Member Functions inherited from SystemBlastTool
virtual ArgsProcessor *	GetArgsProcessor ()
	Get the ArgsProcessor that this BlastTool will use to parse the input ParameterSet prior to running its job. More...

bool	Init (const char *prog_s)
	Initialise the SystemBlastTool prior to it being run. More...

bool	SaveCommandLine (const char *command_line_s)

Protected Member Functions inherited from ExternalBlastTool
virtual bool	AddBlastArg (const char *const arg_s, const bool hyphen_flag)
	Add the argument to the command line arguments that this BlastTool will run with. More...

virtual bool	AddBlastArgsPair (const char key_s, const char value_s)
	Add a pair of arguments to the command line arguments that this BlastTool will run with. More...

char *	GetJobFilename (const char const prefix_s, const char const suffix_s)
	Create the filename to use for a ServiceJob. More...

Protected Attributes inherited from SystemBlastTool
ByteBufferArgsProcessor *	sbt_args_processor_p

Protected Attributes inherited from ExternalBlastTool
char *	ebt_results_filename_s
	The filename which the Blast results will be written to if the job runs successfully. More...

char *	ebt_working_directory_s
	The working directory where all of the input, output and log files will be created. More...

char *	ebt_blast_s
	The name of the blast command line executable to use. More...

bool	ebt_async_flag
	If this is `true`, then the ExternalBlastTool will run asynchronously. More...

Protected Attributes inherited from BlastTool
uint32	bt_output_format
	The output format code to use. More...

char *	bt_custom_output_columns_s
	Any custom columns for tabular output formats. More...

Detailed Description

A class that will run Blast as an asynchronous system process.

Constructor & Destructor Documentation

◆ AsyncSystemBlastTool() [1/2]

AsyncSystemBlastTool	(	BlastServiceJob *	service_job_p,
		const char *	name_s,
		const char *	factory_s,
		const BlastServiceData *	data_p,
		const char *	blast_program_name_s
	)

Create a AsyncSystemBlastTool for a given ServiceJob.

Parameters

service_job_p	The ServiceJob to associate with this AsyncSystemBlastTool.
name_s	The name to give to this AsyncSystemBlastTool.
factory_s	The name of the DrmaaBlastFactory that is creating this AsyncSystemBlastTool.
data_p	The BlastServiceData for the Service that will run this AsyncSystemBlastTool.
blast_program_name_s	The name of blast command line executable that this AsyncSystemBlastTool will call to run its blast job.

◆ AsyncSystemBlastTool() [2/2]

AsyncSystemBlastTool	(	BlastServiceJob *	job_p,
		const BlastServiceData *	data_p,
		const json_t *	json_p
	)

Create a AsyncSystemBlastTool for a given ServiceJob using the configuration details from a serialised JSON fragment.

Parameters

job_p	The ServiceJob to associate with this AsyncSystemBlastTool.
data_p	The BlastServiceData for the Service that will run this AsyncSystemBlastTool.
json_p	The JSON fragment to fill in the serialised values such as job name, etc.

◆ ~AsyncSystemBlastTool()

virtual ~AsyncSystemBlastTool ( )

virtual

The AsyncSystemBlastTool destructor.

Member Function Documentation

◆ AddToJSON()

virtual bool AddToJSON ( json_t * root_p )

virtual

This method is used to serialise this AsyncSystemBlastTool so that it can be recreated from another calling process when required.

This is used to store the AsyncSystemBlastTool in the JobsManager.

Parameters

root_p The json object to add the serialisation of this AsyncSystemBlastTool to.

Returns: true if the BlastTool was serialised successfully, false otherwise.

Reimplemented from ExternalBlastTool.

◆ Run()

virtual OperationStatus Run ( )

virtual

Run this AsyncSystemBlastTool.

Returns: The OperationStatus of this AsyncSystemBlastTool after it has started running.

Reimplemented from SystemBlastTool.

◆ PreRun()

virtual bool PreRun ( )

virtual

Any custom functionality required before running a BlastTool.

Reimplemented from BlastTool.

◆ GetStatus()

virtual OperationStatus GetStatus ( bool update_flag = true )

virtual

Get the status of an AsyncSystemBlastTool.

Parameters

update_flag if this is true then the AsyncSystemBlastTool will check the status of its running jobs if necessary, if this is false it will return the last cached value.

Returns: The OperationStatus of this AsyncSystemBlastTool.

Reimplemented from SystemBlastTool.

◆ GetResults()

virtual char* GetResults ( BlastFormatter * formatter_p )

virtual

Get the results after the AsyncSystemBlastTool has finished running.

Parameters

formatter_p The BlastFormatter to convert the results into a different format. If this is 0, then the results will be returned without any conversion.

Returns: The results as a c-style string or 0 upon error.

Reimplemented from ExternalBlastTool.

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

async_system_blast_tool.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AsyncSystemBlastTool() [1/2]

◆ AsyncSystemBlastTool() [2/2]

◆ ~AsyncSystemBlastTool()

Member Function Documentation

◆ AddToJSON()

◆ Run()

◆ PreRun()

◆ GetStatus()

◆ GetResults()