Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Weighted_points_d_loader< PointD, WeightType > Class Template Reference

#include <Weighted_points_d_loader.hpp>

Public Types

typedef T_Weighted_points_d_loader< PointD, WeightType > Self
 
typedef SBL::IO::Loader_base Base
 
typedef PointD Point
 Representation of a point. More...
 
typedef std::pair< PointD, WeightType > Weighted_point
 Representation of a weighted point. More...
 
typedef std::vector< Weighted_pointWeighted_point_ensemble
 List of weighted points in a file. More...
 

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)
 

Constructors

 T_Weighted_points_d_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...
 

Output Prefix

boost::program_options::options_description add_options (void) const
 Virtual method for adding options to the module. More...
 
std::string get_name (void) const
 Return the name of the class itself. More...
 
std::string get_output_prefix (void) const
 Access to the output prefix of this loader. More...
 

Data Management

unsigned get_number_of_loaded_data (void) const
 Number of containers of points. More...
 
const Weighted_point_ensembleget_data (unsigned i) const
 ith container of points corresponding to the ith input file (const). More...
 
Weighted_point_ensembleget_data (unsigned i)
 ith container of points corresponding to the ith input file. More...
 
const Weighted_point_ensembleget_data (void) const
 Container of points (use only if one input file was provided) (const). More...
 
Weighted_point_ensembleget_data (void)
 Container of points (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 points from the input files. More...
 
void statistics (std::ostream &out) const
 Print high level statistics on the loaded points. More...
 

Management

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

Member Typedef Documentation

◆ Base

◆ Point

typedef PointD Point

Representation of a point.

◆ Self

typedef T_Weighted_points_d_loader<PointD, WeightType> Self

◆ Weighted_point

typedef std::pair<PointD, WeightType> Weighted_point

Representation of a weighted point.

◆ Weighted_point_ensemble

List of weighted points in a file.

Constructor & Destructor Documentation

◆ T_Weighted_points_d_loader()

T_Weighted_points_d_loader ( void  )
inline

Default constructor.

Member Function Documentation

◆ add_options()

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

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

◆ check_options()

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

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description< Dummy >.

◆ delete_options()

static void delete_options ( void  )
inlinestaticinherited

◆ get_data() [1/4]

T_Weighted_points_d_loader< PointD, WeightType >::Weighted_point_ensemble & get_data ( unsigned  i)
inline

ith container of points corresponding to the ith input file.

◆ get_data() [2/4]

const T_Weighted_points_d_loader< PointD, WeightType >::Weighted_point_ensemble & get_data ( unsigned  i) const
inline

ith container of points corresponding to the ith input file (const).

◆ get_data() [3/4]

T_Weighted_points_d_loader< PointD, WeightType >::Weighted_point_ensemble & get_data ( void  )
inline

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

◆ get_data() [4/4]

const T_Weighted_points_d_loader< PointD, WeightType >::Weighted_point_ensemble & get_data ( void  ) const
inline

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

◆ get_loader_instance_name()

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

◆ get_name()

std::string get_name ( void  ) const
inlinevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

◆ get_number_of_loaded_data()

unsigned get_number_of_loaded_data ( void  ) const
inline

Number of containers of points.

◆ get_options()

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

Access to the options' description of the module.

◆ get_output_prefix()

std::string get_output_prefix ( void  ) const
inlinevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description< Dummy >.

◆ has_options()

static bool has_options ( void  )
inlinestaticinherited

◆ initialize_options()

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

◆ load()

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

Once the command line options were parsed, build the containers of points 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()

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

Print high level statistics on the loaded points.