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>

Public Types

typedef T_Graph_loader< GraphType, FTSelf
 
typedef SBL::IO::Loader_base Base
 
typedef boost::graph_traits< GraphType >::vertex_descriptor Vertex
 
typedef boost::graph_traits< GraphType >::edge_descriptor Edge
 
typedef boost::graph_traits< GraphType >::edge_iterator Edges_iterator
 
typedef T_Graph_loader< GraphType, FTSelf
 
typedef SBL::IO::Loader_base Base
 
typedef boost::graph_traits< GraphType >::vertex_descriptor Vertex
 
typedef boost::graph_traits< GraphType >::edge_descriptor Edge
 
typedef boost::graph_traits< GraphType >::edge_iterator Edges_iterator
 
typedef T_Graph_loader< GraphType, FTSelf
 
typedef SBL::IO::Loader_base Base
 
typedef boost::graph_traits< GraphType >::vertex_descriptor Vertex
 
typedef boost::graph_traits< GraphType >::edge_descriptor Edge
 
typedef boost::graph_traits< GraphType >::edge_iterator Edges_iterator
 

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)
 

Attributes

static std::string s_vertex_weights_file_name = ""
 
static std::string s_edges_file_name = ""
 
static std::string s_edge_weights_file_name = ""
 
GraphType m_graph
 

Constructors

 T_Graph_loader (void)
 Default constructor. More...
 
 T_Graph_loader (void)
 Default constructor. More...
 
 T_Graph_loader (void)
 Default constructor. More...
 

Options Descriptions

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

Output Prefix

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

Data Management

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

Management

void set_loader_instance_name (const std::string &loader_instance_name)
 
const std::string & get_loader_instance_name (void) const
 

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.

Member Typedef Documentation

◆ Base [1/3]

◆ Base [2/3]

◆ Base [3/3]

◆ Edge [1/3]

typedef boost::graph_traits<GraphType>::edge_descriptor Edge

◆ Edge [2/3]

typedef boost::graph_traits<GraphType>::edge_descriptor Edge

◆ Edge [3/3]

typedef boost::graph_traits<GraphType>::edge_descriptor Edge

◆ Edges_iterator [1/3]

typedef boost::graph_traits<GraphType>::edge_iterator Edges_iterator

◆ Edges_iterator [2/3]

typedef boost::graph_traits<GraphType>::edge_iterator Edges_iterator

◆ Edges_iterator [3/3]

typedef boost::graph_traits<GraphType>::edge_iterator Edges_iterator

◆ Self [1/3]

typedef T_Graph_loader<GraphType, FT> Self

◆ Self [2/3]

typedef T_Graph_loader<GraphType, FT> Self

◆ Self [3/3]

typedef T_Graph_loader<GraphType, FT> Self

◆ Vertex [1/3]

typedef boost::graph_traits<GraphType>::vertex_descriptor Vertex

◆ Vertex [2/3]

typedef boost::graph_traits<GraphType>::vertex_descriptor Vertex

◆ Vertex [3/3]

typedef boost::graph_traits<GraphType>::vertex_descriptor Vertex

Constructor & Destructor Documentation

◆ T_Graph_loader() [1/3]

T_Graph_loader ( void  )
inline

Default constructor.

◆ T_Graph_loader() [2/3]

T_Graph_loader ( void  )
inline

Default constructor.

◆ T_Graph_loader() [3/3]

T_Graph_loader ( void  )
inline

Default constructor.

Member Function Documentation

◆ add_options() [1/3]

boost::program_options::options_description add_options ( void  ) const
inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description<>.

◆ add_options() [2/3]

boost::program_options::options_description add_options ( void  ) const
inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description<>.

◆ add_options() [3/3]

boost::program_options::options_description add_options ( void  ) const
inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description<>.

◆ check_options() [1/3]

bool check_options ( std::string &  message) const
inlinevirtual

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description<>.

◆ check_options() [2/3]

bool check_options ( std::string &  message) const
inlinevirtual

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description<>.

◆ check_options() [3/3]

bool check_options ( std::string &  message) const
inlinevirtual

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description<>.

◆ delete_options()

static void delete_options ( void  )
inlinestaticinherited

◆ get_graph() [1/6]

const GraphType & get_graph ( void  ) const
inline

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

◆ get_graph() [2/6]

const GraphType& get_graph ( void  ) const
inline

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

◆ get_graph() [3/6]

GraphType& get_graph ( void  )
inline

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

◆ get_graph() [4/6]

GraphType & get_graph ( void  )
inline

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

◆ get_graph() [5/6]

const GraphType& get_graph ( void  ) const
inline

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

◆ get_graph() [6/6]

GraphType& get_graph ( void  )
inline

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

◆ get_loader_instance_name()

const std::string& get_loader_instance_name ( void  ) const
inlineinherited

◆ get_name() [1/3]

std::string get_name ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from Loader_base.

◆ get_name() [2/3]

std::string get_name ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from Loader_base.

◆ get_name() [3/3]

std::string get_name ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from Loader_base.

◆ get_options()

static boost::program_options::options_description*& get_options ( void  )
inlinestaticinherited

Access to the options' description of the module.

◆ get_output_prefix() [1/3]

std::string get_output_prefix ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description<>.

◆ get_output_prefix() [2/3]

std::string get_output_prefix ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description<>.

◆ get_output_prefix() [3/3]

std::string get_output_prefix ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description<>.

◆ has_options()

static bool has_options ( void  )
inlinestaticinherited

◆ initialize_options()

static void initialize_options ( const std::string &  caption)
inlinestaticinherited

◆ load() [1/3]

bool load ( unsigned  verbose = false,
std::ostream &  out = std::cout 
)
inlinevirtual

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

Reimplemented from Loader_base.

◆ load() [2/3]

bool load ( unsigned  verbose = false,
std::ostream &  out = std::cout 
)
inlinevirtual

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

Reimplemented from Loader_base.

◆ load() [3/3]

bool load ( unsigned  verbose = false,
std::ostream &  out = std::cout 
)
inlinevirtual

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

Reimplemented from Loader_base.

◆ set_loader_instance_name()

void set_loader_instance_name ( const std::string &  loader_instance_name)
inlineinherited

◆ statistics() [1/3]

void statistics ( std::ostream &  out) const
inline

Print high level statistics on the loaded weights.

◆ statistics() [2/3]

void statistics ( std::ostream &  out) const
inline

Print high level statistics on the loaded weights.

◆ statistics() [3/3]

void statistics ( std::ostream &  out) const
inline

Print high level statistics on the loaded weights.

Member Data Documentation

◆ m_graph

GraphType m_graph

◆ s_edge_weights_file_name

std::string s_edge_weights_file_name = ""
static

◆ s_edges_file_name

std::string s_edges_file_name = ""
static

◆ s_vertex_weights_file_name

std::string s_vertex_weights_file_name = ""
static