blast_util.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
**     http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
/*
 * blast_util.h
 *
 *  Created on: 19 Oct 2016
 *      Author: billy
 */
 
#ifndef SERVER_SRC_SERVICES_BLAST_INCLUDE_BLAST_UTIL_H_
#define SERVER_SRC_SERVICES_BLAST_INCLUDE_BLAST_UTIL_H_
 
 
#include "args_processor.hpp"
#include "blast_service_api.h"
#include "byte_buffer.h"
#include "parameter_set.h"
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
BLAST_SERVICE_LOCAL bool GetAndAddBlastArgs (const ParameterSet *param_set_p, const char *param_name_s, bool required_flag, ArgsProcessor *ap_p);
 
 
BLAST_SERVICE_LOCAL bool AddBlastArgs (const Parameter *param_p, ArgsProcessor *ap_p);
 
 
BLAST_SERVICE_LOCAL bool AddArg (const char *arg_s, ArgsProcessor *ap_p, bool hyphen_flag);
 
 
 
BLAST_SERVICE_LOCAL bool AddArgsPair (const char *key_s, const char *value_s, ArgsProcessor *ap_p);
 
 
BLAST_SERVICE_LOCAL bool AddArgsPairFromIntegerParameter (const ParameterSet *params_p, const char * const param_name_s, const char *key_s, ArgsProcessor *ap_p, const bool unsigned_flag, const bool required_flag);
 
 
BLAST_SERVICE_LOCAL bool AddArgsPairFromStringParameter (const ParameterSet *params_p, const char * const param_name_s, const char *key_s, ArgsProcessor *ap_p,  const bool required_flag);
 
 
 
 
BLAST_SERVICE_LOCAL bool WriteCommandLineToFile (const char *command_line_s, const char *filename_s);
 
 
BLAST_SERVICE_LOCAL char *GetBlastJobFilename (const char * const prefix_s, const char *job_id_s, const char * const suffix_s);
 
 
BLAST_SERVICE_LOCAL char *GetBlastJobFilenameByUuid (const char * const prefix_s, const uuid_t id, const char * const suffix_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SERVER_SRC_SERVICES_BLAST_INCLUDE_BLAST_UTIL_H_ */