T_Nucleic_acid_representation_loader< NucleicAcidRepresentation, MCSLoader > Class Template Reference

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

#include <Nucleic_acid_representation_loader.hpp>

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

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

Detailed Description

template<class NucleicAcidRepresentation, class MCSLoader>
class SBL::IO::T_Nucleic_acid_representation_loader< NucleicAcidRepresentation, MCSLoader >

Loader for nucleic_acids from PDB and mmCIF files using SBL.

Template Parameters

NucleicAcidRepresentation	A model of SBL::CSB::T_Nucleic_acid_representation
MolecularCovalentStructureBuilder	Builder of the covalent structure.

Constructor & Destructor Documentation

~T_Nucleic_acid_representation_loader()

template<class NucleicAcidRepresentation, class MCSLoader>

~T_Nucleic_acid_representation_loader ( void )

virtual

Default destructor.

Member Function Documentation

add_options()

template<class NucleicAcidRepresentation, class MCSLoader>

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

template<class NucleicAcidRepresentation, class MCSLoader>

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

template<class NucleicAcidRepresentation, class MCSLoader>

T_Nucleic_acid_representation_loader< NucleicAcidRepresentation, MCSLoader >::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()

template<class NucleicAcidRepresentation, class MCSLoader>

std::string get_name ( void ) const

overridevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_nucleic_acid_representations() [1/2]

template<class NucleicAcidRepresentation, class MCSLoader>

std::vector< NucleicAcidRepresentation * > & get_nucleic_acid_representations

(

void

)

Get the nucleic acid representations.

Returns

A reference to the vector of nucleic acid representations.

get_nucleic_acid_representations() [2/2]

template<class NucleicAcidRepresentation, class MCSLoader>

const std::vector< NucleicAcidRepresentation * > & get_nucleic_acid_representations

(

void

)

const

Get the nucleic acid representations.

Returns

A constant reference to the vector of nucleic acid representations.

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 NucleicAcidRepresentation, class MCSLoader>

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

load()

template<class NucleicAcidRepresentation, class MCSLoader>

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 nucleic acid representations. This function loads the nucleic acid representations.

Reimplemented from Loader_base.

statistics()

template<class NucleicAcidRepresentation, class MCSLoader>

void statistics

(

std::ostream &

out

)

Prints statistics about the loaded nucleic acid representations.

Parameters

[out]

out

Output stream for printing the statistics.