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


Loader for files listing numbers More...

#include <Numbers_file_loader.hpp>

Public Types

typedef std::vector< std::vector< FT > > Data_vector
 List of serialized data. More...
 

Static Public Member Functions

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

Constructors

 T_Numbers_file_loader (const std::string &tag, const std::string &helper="Numbers file name", const std::string &option_name="numbers-file")
 Default constructor. More...
 

Options Descriptions

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

Output Prefix

std::string get_output_prefix (void) const override
 Access to the output prefix of this loader. More...
 
std::string get_name (void) const override
 Return the name of the class itself. More...
 

Data Management

const Data_vectorget_all_data (void) const
 Access to all the containers of spheres (const). More...
 
Data_vectorget_all_data (void)
 Access to all the containers of spheres. More...
 
unsigned get_number_of_data (void) const
 Number of containers of spheres. More...
 
const std::vector< FT > & get_data (unsigned i) const
 ith container of spheres corresponding to the ith input file (const). More...
 
std::vector< FT > & get_data (unsigned i)
 ith container of spheres corresponding to the ith input file. More...
 
const std::vector< FT > & get_data (void) const
 Container of spheres (use only if one input file was provided) (const). More...
 
std::vector< FT > & get_data (void)
 Container of spheres (use only if one input file was provided). More...
 
bool load (unsigned verbose=false, std::ostream &out=std::cout) override
 Once the command line options were parsed, build the containers of spheres from the input files. More...
 
boost::program_options::options_description add_options (void) override
 Virtual method for adding options to the module. More...
 
void statistics (std::ostream &out) const
 Print high level statistics on the loaded spheres. More...
 
static std::vector< std::string > & get_file_names (void)
 Access to the input filenames. 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 FT, class Tag = void>
class SBL::IO::T_Numbers_file_loader< FT, Tag >


Loader for files listing numbers

Template Parameters
FTType of the numbers to load.

Member Typedef Documentation

◆ Data_vector

typedef std::vector<std::vector<FT> > Data_vector

List of serialized data.

Constructor & Destructor Documentation

◆ T_Numbers_file_loader()

T_Numbers_file_loader ( const std::string &  tag,
const std::string &  helper = "Numbers file name",
const std::string &  option_name = "numbers-file" 
)
inline

Default constructor.

Member Function Documentation

◆ add_options()

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()

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_all_data() [1/2]

T_Numbers_file_loader< FT, Tag >::Data_vector & get_all_data ( void  )
inline

Access to all the containers of spheres.

◆ get_all_data() [2/2]

const T_Numbers_file_loader< FT, Tag >::Data_vector & get_all_data ( void  ) const
inline

Access to all the containers of spheres (const).

◆ get_data() [1/4]

std::vector< FT > & get_data ( unsigned  i)
inline

ith container of spheres corresponding to the ith input file.

◆ get_data() [2/4]

const std::vector< FT > & get_data ( unsigned  i) const
inline

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

◆ get_data() [3/4]

std::vector< FT > & get_data ( void  )
inline

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

◆ get_data() [4/4]

const std::vector< FT > & get_data ( void  ) const
inline

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

◆ get_file_names()

std::vector< std::string > & get_file_names ( void  )
inlinestatic

Access to the input filenames.

◆ get_name()

std::string get_name ( void  ) const
inlineoverridevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

◆ get_number_of_data()

unsigned get_number_of_data ( void  ) const
inline

Number of containers of spheres.

◆ 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
inlineoverridevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description< Dummy >.

◆ load()

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

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

Reimplemented from Loader_base.

◆ statistics()

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

Print high level statistics on the loaded spheres.