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.
ArgsProcessor Class Referenceabstract

An ArgsProcessor is a class to abstract out how a particular BlastTool stores a value when an argument is passed to it. More...

#include <args_processor.hpp>

Inheritance diagram for ArgsProcessor:
[legend]

Public Member Functions

 ArgsProcessor ()
 Construct an ArgsProcessor. More...
 
virtual ~ArgsProcessor ()
 The ArgsProcessor destructor. More...
 
virtual bool AddArg (const char *arg_s, const bool hyphen_flag)=0
 Add an argument to the underlying tool. More...
 
bool GetAndAddBlastArgs (const ParameterSet *param_set_p, const char *param_name_s, bool required_flag, ArgsProcessor *ap_p)
 Get the named Parameter from a ParameterSet and add it to an ArgsProcessor. More...
 
bool AddBlastArgs (const Parameter *param_p, ArgsProcessor *ap_p)
 Add an argument derived from the current value of a Parameter to an ArgsProcessor. More...
 
bool AddArgsPair (const char *key_s, const char *value_s, ArgsProcessor *ap_p)
 Add a pair of arguments to the command line arguments stored in a ByteBuffer. More...
 
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)
 Get the value of an integer-based Parameter and add it as key-value pair to the command line arguments accessed by an ArgsProcessor. More...
 
bool AddArgsPairFromStringParameter (const ParameterSet *params_p, const char *const param_name_s, const char *key_s, ArgsProcessor *ap_p, const bool required_flag)
 Get the value of an string-based Parameter and add it as key-value pair to the command line arguments accessed by an ArgsProcessor. More...
 

Detailed Description

An ArgsProcessor is a class to abstract out how a particular BlastTool stores a value when an argument is passed to it.

Constructor & Destructor Documentation

◆ ArgsProcessor()

Construct an ArgsProcessor.

◆ ~ArgsProcessor()

virtual ~ArgsProcessor ( )
virtual

The ArgsProcessor destructor.

Member Function Documentation

◆ AddArg()

virtual bool AddArg ( const char *  arg_s,
const bool  hyphen_flag 
)
pure virtual

Add an argument to the underlying tool.

Parameters
arg_sThe value to add.
hyphen_flagIf this is true then the value specified by arg_s will be prefixed by a '-' when adding to this ArgsProcessor.
Returns
true if the argument was added successfully, false otherwise.

Implemented in DrmaaToolArgsProcessor, ByteBufferArgsProcessor, and StringsArgsProcessor.


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