![]() |
Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
|
Generic manager for reading arguments of the program and run the calculations
More...
#include <Morse_theory_based_analyzer_module.hpp>
Public Types | |
typedef T_Morse_theory_based_analyzer_for_NNG_module< ModuleTraits > | Self |
Static Public Member Functions | |
static boost::program_options::options_description *& | get_options (void) |
Access to the options' description of the module. More... | |
static bool | has_options (void) |
static void | delete_options (void) |
static void | initialize_options (const std::string &caption) |
Traits Requirements | |
typedef ModuleTraits::Nearest_neighbors_graph | Nearest_neighbors_graph |
typedef ModuleTraits::Morse_function | Morse_function |
typedef ModuleTraits::Distance_graph_function | Distance_graph_function |
Input Accessors | |
Nearest_neighbors_graph *& | get_nearest_neighbors_graph (void) |
Morse_function *& | get_Morse_function (void) |
Mandatory Requirements | |
void | run (unsigned verbose, std::ostream &out) |
Runs the module following the input options. More... | |
bool | is_runnable (void) const |
Checks that all the input options were set. More... | |
std::string | get_name (void) const |
Returns the name of the package. More... | |
Optional Requirements | |
void | report (const std::string &prefix) |
Reports the output and statistics in output files. More... | |
boost::program_options::options_description | add_options () const |
Virtual method for adding options to the module. More... | |
Input Accessors | |
Morse_Smale_Witten_chain_complex *& | get_Morse_Smale_Witten_chain_complex (void) |
static const std::string & | get_Morse_Smale_Witten_chain_complex_filename (void) |
Output Accessors | |
const Morse_theory_based_analyzer & | get_Morse_theory_based_analyzer (void) const |
Morse_theory_based_analyzer & | get_Morse_theory_based_analyzer (void) |
Mandatory Requirements | |
void | statistics (std::ostream &out) |
Reports high-level statistics on the module. More... | |
Optional Requirements | |
bool | check_options (std::string &message) const |
Checks that the input options' values are coherent. More... | |
std::string | get_output_prefix (void) const |
Returns a prefix that concatains the input line options used when running the module. More... | |
Modules Management | |
void | set_module_instance_name (const std::string &module_instance_name) |
Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules. More... | |
const std::string & | get_module_instance_name (void) const |
Get the name of this instance of this module. More... | |
void | set_report_mode (std::ios_base::openmode report_mode) |
Set a report mode, that is open or append modes. More... | |
void | set_report_mode (std::ios_base::openmode &report_mode) |
Set a report mode, that is open or append modes. More... | |
const std::ios_base::openmode | get_report_mode (void) const |
Get the report mode to be used when reporting. More... | |
Optional Requirements | |
void | check_filesystem_directory_exists (const std::string &output_prefix) |
To avoid later crash: check filesystem / existence of directory / directory exists. More... | |
Others | |
template<class Self_ > | |
Self_ * | clone (const Self_ *s) const |
Clones the object using the copy constructor. More... | |
virtual bool | is_logical_module (void) const |
Checks that this module defines a logical operator. More... | |
virtual bool | is_condition_module (void) const |
Checks that this module defines a condition operator. More... | |
virtual bool | operator() (void) |
Only for condition modules, for returning the predicate value. More... | |
virtual bool | is_modules_collection (void) const |
Checks that this module defines a collection of modules. More... | |
Parameters | |
static bool & | get_show_diagrams (void) |
Generic manager for reading arguments of the program and run the calculations
ModuleTraits | Model of a traits class defining the types used in the manager (see T_Conformational_clustering_traits). |
typedef T_Morse_theory_based_analyzer_module<ModuleTraits, Morse_Smale_Witten_chain_complex> Base |
|
inherited |
typedef ModuleTraits::Distance_graph_function Distance_graph_function |
|
inherited |
typedef ModuleTraits::Morse_function Morse_function |
typedef Morse_Smale_Witten_chain_complex_builder::Morse_Smale_Witten_chain_complex Morse_Smale_Witten_chain_complex |
typedef SBL::GT::T_Morse_Smale_Witten_chain_complex_from_NNG_builder<Nearest_neighbors_graph, Morse_function> Morse_Smale_Witten_chain_complex_builder |
typedef SBL::GT::T_Morse_Smale_Witten_chain_complex_from_NNG_builder<Nearest_neighbors_graph, Morse_function, Distance_graph_function> Morse_Smale_Witten_chain_complex_builder_normalized |
|
inherited |
typedef ModuleTraits::Nearest_neighbors_graph Nearest_neighbors_graph |
|
inherited |
|
inherited |
|
inherited |
typedef T_Morse_theory_based_analyzer_for_NNG_module<ModuleTraits> Self |
|
inherited |
|
inlinevirtual |
Virtual method for adding options to the module.
Reimplemented from T_Module_option_description< Dummy >.
|
inlineinherited |
To avoid later crash: check filesystem / existence of directory / directory exists.
|
inlinevirtualinherited |
Checks that the input options' values are coherent.
Reimplemented from T_Module_option_description< Dummy >.
|
inlineinherited |
Clones the object using the copy constructor.
|
inlinestaticinherited |
|
inlineinherited |
Get the name of this instance of this module.
|
inline |
|
inlineinherited |
|
inlinestaticprotectedinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinevirtual |
Returns the name of the package.
Reimplemented from Module_base.
|
inline |
|
inlinestaticinherited |
Access to the options' description of the module.
|
inlinevirtualinherited |
Returns a prefix that concatains the input line options used when running the module.
Reimplemented from T_Module_option_description< Dummy >.
|
inlineinherited |
Get the report mode to be used when reporting.
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineprotectedvirtualinherited |
Checks that this module defines a condition operator.
|
inlineprotectedvirtualinherited |
Checks that this module defines a logical operator.
|
inlineprotectedvirtualinherited |
Checks that this module defines a collection of modules.
|
inlinevirtual |
Checks that all the input options were set.
Reimplemented from Module_base.
|
inlineprotectedvirtualinherited |
Only for condition modules, for returning the predicate value.
|
inlinevirtual |
Reports the output and statistics in output files.
Reimplemented from Module_base.
|
inlinevirtual |
Runs the module following the input options.
Implements Module_base.
|
inlineinherited |
Sets a name for this instance of this module. In particular, it will be used in the prefix of output files generated by a collection of modules.
|
inlineinherited |
Set a report mode, that is open or append modes.
|
inlineinherited |
Set a report mode, that is open or append modes.
|
inlinevirtualinherited |
Reports high-level statistics on the module.
Reimplemented from Module_base.