T_Protein_representation_loader< Protein_representation_ > Class Template Reference

Loader for proteins from PDB and mmCIF files using SBL. More...

#include <Protein_representation_loader.hpp>

Public Member Functions
virtual	~T_Protein_representation_loader (void)
	Default destructor. More...
virtual boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module. More...
virtual bool	check_options (std::string &message) const override
	Checks that the input options' values are coherent. More...
bool	load (unsigned verbose, std::ostream &out) override
	Load function. More...
std::string	get_name (void) const override
	Return the name of the class itself. More...
std::string	get_output_prefix (void) const override
	Returns a prefix that concatains the input line options used when running the module. More...
const std::vector< Protein_representation * > &	get_protein_representations (void) const
	Get the protein representations. More...
std::vector< Protein_representation * > &	get_protein_representations (void)
	Get the protein representations. More...
Molecular_covalent_structure_loader &	get_molecular_covalent_structure_loader (void)
	Get the molecular covalent structure loader. More...
void	statistics (std::ostream &out)
	Prints statistics about the loaded protein representations. More...

Static Public Member Functions
static boost::program_options::options_description *&	get_options (void)
	Access to the options' description of the module. 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 Protein_representation_ = Default_protein_representation>
class SBL::IO::T_Protein_representation_loader< Protein_representation_ >

Loader for proteins from PDB and mmCIF files using SBL.

Template Parameters

ProteinRepresentation	A model of SBL::CSB::T_Protein_representation
MolecularCovalentStructureBuilder	Builder of the covalent structure.

Constructor & Destructor Documentation

~T_Protein_representation_loader()

~T_Protein_representation_loader ( void  )

virtual

Default destructor.

Member Function Documentation

add_options()

boost::program_options::options_description add_options ( void  )

overridevirtual

Virtual method for adding options to the module.

Adds the options of the molecular system loader (under "PDB Loader") to the option parser and also as command line arguments.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

bool check_options ( std::string &  message ) const

overridevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

get_molecular_covalent_structure_loader()

T_Protein_representation_loader< Protein_representation_ >::Molecular_covalent_structure_loader & get_molecular_covalent_structure_loader

(

void

)

Get the molecular covalent structure loader.

Returns

A reference to the molecular covalent structure loader.

get_name()

std::string get_name ( void  ) const

overridevirtual

Return the name of the class itself.

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

std::string get_output_prefix ( void  ) const

overridevirtual

Returns a prefix that concatains the input line options used when running the module.

Reimplemented from T_Module_option_description< Dummy >.

get_protein_representations() [1/2]

std::vector< Protein_representation_ * > & get_protein_representations

(

void

)

Get the protein representations.

Returns

A reference to the vector of protein representations.

get_protein_representations() [2/2]

const std::vector< Protein_representation_ * > & get_protein_representations

(

void

)

const

Get the protein representations.

Returns

A constant reference to the vector of protein representations.

load()

bool load ( unsigned  verbose, std::ostream &  out  )

overridevirtual

Load function.

Parameters

	verbose	Verbosity level.
[out]	out	Output stream.

Returns

True if loading is successful, false otherwise. Function to call to execute the main function of a Loader

Load protein representations. This function loads the protein representations.

Reimplemented from Loader_base.

statistics()

void statistics

(

std::ostream &

out

)

Prints statistics about the loaded protein representations.

Parameters

[out]

out

Output stream for printing the statistics.