Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
BM_Run_specification_tuple Class Reference

Built-in Methods

 __init__ (self, executable_path="")
 Initialize a run specification with possibly the executable path.
 __len__ (self)
 Return the number of options in the specification.

Executable Path

 get_run_options (self)
 Return the list of nvp options corresponding to this run.
 get_executable_path (self)
 Get the executable path.
 set_executable_path (self, executable_path)
 Set the executable file path.

Options Management

 add_option (self, name, value="")
 Add the option name for an input option with a given value.
 add_file_option (self, name, value="")
 Add the option name for an input file option with the path to a file.
 build_run_command (self)
 Create the command line corresponding to the specified run.
 run (self)
 Starts the specified run.

Detailed Description

A list of name-value-pairs to specify one run. A list of name-value-pairs to specify one run.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
executable_path = "" )

Initialize a run specification with possibly the executable path.

Member Function Documentation

◆ __len__()

__len__ ( self)

Return the number of options in the specification.

◆ add_file_option()

add_file_option ( self,
name,
value = "" )

Add the option name for an input file option with the path to a file.

The path is converted to an absolute path when stored. Note that the object itself is returned such that it is possible to add multiple options in one instruction.

◆ add_option()

add_option ( self,
name,
value = "" )

Add the option name for an input option with a given value.

If no value is given, it is an implicit value (for example, a boolean). Note that the object itself is returned such that it is possible to add multiple options in one instruction.

◆ build_run_command()

build_run_command ( self)

Create the command line corresponding to the specified run.

◆ get_executable_path()

get_executable_path ( self)

Get the executable path.

◆ get_run_options()

get_run_options ( self)

Return the list of nvp options corresponding to this run.

◆ run()

run ( self)

Starts the specified run.

◆ set_executable_path()

set_executable_path ( self,
executable_path )

Set the executable file path.