Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Graph_loader< GraphType, FT > Class Template Reference

Loader for one or more txt files listing weights. More...

#include <Graph_loader.hpp>

Static Public Member Functions

static boost::program_options::options_description *& get_options (void)
 Access to the options' description of the module.

Constructors

 T_Graph_loader (void)
 Default constructor.

Options Descriptions

bool check_options (std::string &message) const override
 Check that the parsed options are valid for this loader.

Output Prefix

std::string get_name (void) const override
 Access to the output prefix of this loader.
std::string get_output_prefix (void) const override
 Access to the output prefix of this loader.

Data Management

boost::program_options::options_description add_options (void) override
 Virtual method for adding options to the module.
const GraphType & get_graph (void) const
 Container of weights (use only if one input file was provided) (const).
GraphType & get_graph (void)
 Container of weights (use only if one input file was provided).
bool load (unsigned verbose=false, std::ostream &out=std::cout) override
 Once the command line options were parsed, build the containers of weights from the input files.
void statistics (std::ostream &out) const
 Print high level statistics on the loaded weights.

Detailed Description

template<class GraphType, class FT>
class SBL::Models::T_Graph_loader< GraphType, FT >

Loader for one or more txt files listing weights.

Template Parameters
FTRepresentation of a weight.

Constructor & Destructor Documentation

◆ T_Graph_loader()

template<class GraphType, class FT>
T_Graph_loader ( void )
inline

Default constructor.

Member Function Documentation

◆ add_options()

template<class GraphType, class FT>
boost::program_options::options_description add_options ( void )
inlineoverridevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ check_options()

template<class GraphType, class FT>
bool check_options ( std::string & message) const
inlineoverridevirtual

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description< Dummy >.

◆ get_graph() [1/2]

template<class GraphType, class FT>
GraphType & get_graph ( void )
inline

Container of weights (use only if one input file was provided).

◆ get_graph() [2/2]

template<class GraphType, class FT>
const GraphType & get_graph ( void ) const
inline

Container of weights (use only if one input file was provided) (const).

◆ get_name()

template<class GraphType, class FT>
std::string get_name ( void ) const
inlineoverridevirtual

Access to the output prefix of this loader.

Reimplemented from Loader_base.

◆ get_options()

template<class Dummy = void>
boost::program_options::options_description *& get_options ( void )
inlinestaticinherited

Access to the options' description of the module.

◆ get_output_prefix()

template<class GraphType, class FT>
std::string get_output_prefix ( void ) const
inlineoverridevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description< Dummy >.

◆ load()

template<class GraphType, class FT>
bool load ( unsigned verbose = false,
std::ostream & out = std::cout )
inlineoverridevirtual

Once the command line options were parsed, build the containers of weights from the input files.

Reimplemented from Loader_base.

◆ statistics()

template<class GraphType, class FT>
void statistics ( std::ostream & out) const
inline

Print high level statistics on the loaded weights.