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.
Public Member Functions | Static Public Member Functions
BlastFormatter Class Referenceabstract
The BLAST Services Module

This class is for converting the output of a blast job between the available different formats. More...

#include <blast_formatter.h>

Inheritance diagram for BlastFormatter:
[legend]

Public Member Functions

 BlastFormatter ()
 
virtual ~BlastFormatter ()
 The BlastFormatter destructor. More...
 
virtual char * GetConvertedOutput (const char *job_id_s, const uint32 output_format_code, const char *custom_format_s, const struct BlastServiceData *data_p)=0
 The function to get the converted output as a c-style string. More...
 

Static Public Member Functions

static char * GetConvertedOutputFilename (const char *const filename_s, const uint32 output_format_code)
 Get the output filename for the converted output in a given format. More...
 
static bool IsCustomisableOutputFormat (const uint32 output_format_code)
 

Detailed Description

This class is for converting the output of a blast job between the available different formats.

The input format must be "BLAST archive format (ASN.1)"

Constructor & Destructor Documentation

◆ BlastFormatter()

BlastFormatter ( )

◆ ~BlastFormatter()

virtual ~BlastFormatter ( )
virtual

The BlastFormatter destructor.

Member Function Documentation

◆ GetConvertedOutputFilename()

static char* GetConvertedOutputFilename ( const char *const  filename_s,
const uint32  output_format_code 
)
static

Get the output filename for the converted output in a given format.

Parameters
filename_sThe full path to the filename to convert.
output_format_codeThe required output format code.
output_format_code_ssThe string for the format code gets stored here.
Returns
The full path to the output filename for the given output format code or 0 upon error.

◆ GetConvertedOutput()

virtual char* GetConvertedOutput ( const char *  job_id_s,
const uint32  output_format_code,
const char *  custom_format_s,
const struct BlastServiceData *  data_p 
)
pure virtual

The function to get the converted output as a c-style string.

Parameters
input_filename_sThe file that is in "BLAST archive format (ASN.1)" format.
output_format_codeThe required output code.
Returns
The converted output or NULL upon error.
See also
BlastOutputFormat

◆ IsCustomisableOutputFormat()

static bool IsCustomisableOutputFormat ( const uint32  output_format_code)
static
The documentation for this class was generated from the following file: