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.
DrmaaToolArgsProcessor Class Reference

An ArgsProcessor that adds all of its values to a given DrmaaTool. More...

#include <drmaa_tool_args_processor.hpp>

Inheritance diagram for DrmaaToolArgsProcessor:
[legend]
Collaboration diagram for DrmaaToolArgsProcessor:
[legend]

Public Member Functions

 DrmaaToolArgsProcessor (DrmaaTool *drmaa_p)
 Construct a new DrmaaToolArgsProcessor. More...
 
virtual ~DrmaaToolArgsProcessor ()
 The DrmaaToolArgsProcessor destructor. More...
 
virtual bool AddArg (const char *arg_s, const bool hyphen_flag)
 Add an argument to the underlying DrmaaTool. More...
 
- Public Member Functions inherited from ArgsProcessor
 ArgsProcessor ()
 Construct an ArgsProcessor. More...
 
virtual ~ArgsProcessor ()
 The ArgsProcessor destructor. 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 that adds all of its values to a given DrmaaTool.

Constructor & Destructor Documentation

◆ DrmaaToolArgsProcessor()

Construct a new DrmaaToolArgsProcessor.

Parameters
drmaa_pThe DrmaaTool to add all arguments to.

◆ ~DrmaaToolArgsProcessor()

virtual ~DrmaaToolArgsProcessor ( )
virtual

The DrmaaToolArgsProcessor destructor.

Member Function Documentation

◆ AddArg()

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

Add an argument to the underlying DrmaaTool.

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.

Implements ArgsProcessor.


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