Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
Loader_base Class Reference

Base loader from which any loader should inherit. More...

#include "Loader_base.hpp"

Public Member Functions

virtual boost::program_options::options_description add_options (void) const
 Virtual method for adding options to the module. More...
 
virtual bool check_options (std::string &message) const
 Checks that the input options' values are coherent. More...
 
virtual std::string get_output_prefix (void) const
 Returns a prefix that concatains the input line options used when running the module. More...
 

Static Public Member Functions

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

Requirements

virtual bool load (unsigned verbose, std::ostream &out)
 Loads the data. More...
 
virtual std::string get_name (void) const
 Return the name of the class itself. More...
 

Management

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

Detailed Description

Base loader from which any loader should inherit.

Requirements are...

Member Function Documentation

virtual boost::program_options::options_description add_options ( void  ) const
inlinevirtualinherited

Virtual method for adding options to the module.

Reimplemented in T_Exploration_parameters_with_layers< NumberType, Distance >, T_Space_filling_model_interface_finder_module< ModuleTraits >, T_Space_filling_model_inner_approximation_module< ModuleTraits >, T_Molecular_interfaces_module< ModuleTraits >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, T_PDB_file_loader< Molecular_system >, T_Union_of_balls_surface_volume_3_module< ModuleTraits, OutputArchive >, T_Space_filling_model_shelling_diagram_comparison_module< ModuleTraits >, T_Morse_theory_based_analyzer_module< ModuleTraits, MorseSmaleWittenChainComplex >, T_Union_of_balls_boundary_patch_shelling_3_module< ModuleTraits, OutputArchive >, T_Space_filling_model_outer_approximation_module< ModuleTraits >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_Sample_extender_module< ModuleTraits >, T_Space_filling_model_interpolated_approximation_module< ModuleTraits >, T_Stop_criterion_module< ModuleTraits >, T_Alpha_complex_of_molecular_model_module< ModuleTraits >, T_Exploration_parameters_update_module< ModuleTraits >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Union_of_balls_boundary_3_module< ModuleTraits, ExactNT >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_Union_of_balls_mesh_3_module< ModuleTraits >, T_Earth_mover_distance_module< ModuleTraits >, T_Alignment_structures_module< ModuleTraits, AlignmentEngineStructures >, T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Alignment_sequences_module< ModuleTraits, AlignmentEngineSequences >, T_Buried_surface_area_without_label_module< ModuleTraits >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Tertiary_quaternary_structure_annotator_module< ModuleTraits >, T_Buried_surface_area_with_labels_module< ModuleTraits >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Spatial_search_module< ModuleTraits, ApproximatedSpatialSearchEngine >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Nearest_neighbors_graph_builder_module< ModuleTraits >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Acceptance_test_module< ModuleTraits >, T_Energy_landscape_transition_graph_landmarks_paths_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_PDB< MolecularCovalentStructure, MolecularCovalentStructureBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Sample_selector_module< ModuleTraits >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Numbers_file_loader< FT >, T_Sequences_loader< FT >, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Weighted_vertex_graph_loader< PointD, WeightType, GraphType >, T_Graph_loader< GraphType, FT >, T_Cluster_engine_module< ModuleTraits >, T_Weights_file_loader< FT >, T_Archive_file_loader< InputArchive, SerializedData >, T_Archive_file_loader< boost::archive::xml_iarchive, typename Traits::Atom_shelling_forest >, T_Exploration_parameters_default< NumberType, Distance >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Points_d_file_loader< PointD >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Transition_graph_loader< boost::archive::xml_iarchive, typename Traits::Transition_graph_traits >, T_Transition_graph_builder_from_DB_of_critical_points_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, and T_Conformational_ensemble_symmetric_difference_module< ModuleTraits >.

virtual bool check_options ( std::string &  message) const
inlinevirtualinherited

Checks that the input options' values are coherent.

Reimplemented in T_Exploration_parameters_with_layers< NumberType, Distance >, T_Module_based_workflow< Dummy >, T_Module_based_workflow<>, T_Space_filling_model_interface_finder_module< ModuleTraits >, T_Space_filling_model_inner_approximation_module< ModuleTraits >, T_Molecular_interfaces_module< ModuleTraits >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, T_PDB_file_loader< Molecular_system >, T_Union_of_balls_surface_volume_3_module< ModuleTraits, OutputArchive >, T_Space_filling_model_shelling_diagram_comparison_module< ModuleTraits >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Morse_theory_based_analyzer_module< ModuleTraits, MorseSmaleWittenChainComplex >, T_Union_of_balls_boundary_patch_shelling_3_module< ModuleTraits, OutputArchive >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Space_filling_model_outer_approximation_module< ModuleTraits >, T_Sample_extender_module< ModuleTraits >, T_Space_filling_model_interpolated_approximation_module< ModuleTraits >, T_Stop_criterion_module< ModuleTraits >, T_Alpha_complex_of_molecular_model_module< ModuleTraits >, T_Molecular_structure_classifier_module< ModuleTraits >, T_Exploration_parameters_update_module< ModuleTraits >, T_Alignment_structures_module< ModuleTraits, AlignmentEngineStructures >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_Union_of_balls_boundary_3_module< ModuleTraits, ExactNT >, T_Union_of_balls_mesh_3_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_PDB< MolecularCovalentStructure, MolecularCovalentStructureBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Alignment_sequences_module< ModuleTraits, AlignmentEngineSequences >, T_Buried_surface_area_without_label_module< ModuleTraits >, T_Tertiary_quaternary_structure_annotator_module< ModuleTraits >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Buried_surface_area_with_labels_module< ModuleTraits >, T_Spatial_search_module< ModuleTraits, ApproximatedSpatialSearchEngine >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Nearest_neighbors_graph_builder_module< ModuleTraits >, T_Acceptance_test_module< ModuleTraits >, T_Sample_selector_module< ModuleTraits >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Exploration_parameters_default< NumberType, Distance >, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Cluster_engine_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, T_Archive_file_loader< InputArchive, SerializedData >, T_Archive_file_loader< boost::archive::xml_iarchive, typename Traits::Atom_shelling_forest >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >, T_Module_condition< Module, Predicate >, T_Sequences_loader< FT >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Weighted_vertex_graph_loader< PointD, WeightType, GraphType >, T_Graph_loader< GraphType, FT >, T_Points_d_file_loader< PointD >, T_Module_conjunction< ModuleOrLoader1, ModuleOrLoader2 >, T_Weights_file_loader< FT >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Transition_graph_loader< boost::archive::xml_iarchive, typename Traits::Transition_graph_traits >, T_Numbers_file_loader< FT >, and No_particle_annotator.

virtual std::string get_name ( void  ) const
inlinevirtual

Return the name of the class itself.

Reimplemented in T_Exploration_parameters_with_layers< NumberType, Distance >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, T_PDB_file_loader< Molecular_system >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Molecular_covalent_structure_loader_from_PDB< MolecularCovalentStructure, MolecularCovalentStructureBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Exploration_parameters_default< NumberType, Distance >, T_Archive_file_loader< InputArchive, SerializedData >, T_Archive_file_loader< boost::archive::xml_iarchive, typename Traits::Atom_shelling_forest >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, T_Sequences_loader< FT >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Transition_graph_loader< boost::archive::xml_iarchive, typename Traits::Transition_graph_traits >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Weighted_vertex_graph_loader< PointD, WeightType, GraphType >, T_Graph_loader< GraphType, FT >, T_Points_d_file_loader< PointD >, T_Weights_file_loader< FT >, T_Numbers_file_loader< FT >, and No_particle_annotator.

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

Access to the options' description of the module.

virtual std::string get_output_prefix ( void  ) const
inlinevirtualinherited

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

Reimplemented in T_Exploration_parameters_with_layers< NumberType, Distance >, T_Module_based_workflow< Dummy >, T_Module_based_workflow<>, T_Space_filling_model_interface_finder_module< ModuleTraits >, T_Space_filling_model_inner_approximation_module< ModuleTraits >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_Molecular_interfaces_module< ModuleTraits >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, T_PDB_file_loader< Molecular_system >, T_Union_of_balls_surface_volume_3_module< ModuleTraits, OutputArchive >, T_Space_filling_model_shelling_diagram_comparison_module< ModuleTraits >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Morse_theory_based_analyzer_module< ModuleTraits, MorseSmaleWittenChainComplex >, T_Union_of_balls_boundary_patch_shelling_3_module< ModuleTraits, OutputArchive >, T_Space_filling_model_outer_approximation_module< ModuleTraits >, T_Sample_extender_module< ModuleTraits >, T_Space_filling_model_interpolated_approximation_module< ModuleTraits >, T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Stop_criterion_module< ModuleTraits >, T_Alpha_complex_of_molecular_model_module< ModuleTraits >, T_Molecular_structure_classifier_module< ModuleTraits >, T_Exploration_parameters_update_module< ModuleTraits >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_Earth_mover_distance_module< ModuleTraits >, T_Union_of_balls_boundary_3_module< ModuleTraits, ExactNT >, T_Union_of_balls_mesh_3_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_PDB< MolecularCovalentStructure, MolecularCovalentStructureBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Buried_surface_area_without_label_module< ModuleTraits >, T_Tertiary_quaternary_structure_annotator_module< ModuleTraits >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Buried_surface_area_with_labels_module< ModuleTraits >, T_Energy_landscape_transition_graph_landmarks_paths_module< ModuleTraits >, T_Nearest_neighbors_graph_builder_module< ModuleTraits >, T_Spatial_search_module< ModuleTraits, ApproximatedSpatialSearchEngine >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Exploration_parameters_default< NumberType, Distance >, T_Acceptance_test_module< ModuleTraits >, T_Sample_selector_module< ModuleTraits >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Cluster_engine_module< ModuleTraits >, T_Archive_file_loader< InputArchive, SerializedData >, T_Archive_file_loader< boost::archive::xml_iarchive, typename Traits::Atom_shelling_forest >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Transition_graph_builder_from_DB_of_critical_points_module< ModuleTraits >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >, T_Sequences_loader< FT >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Weighted_vertex_graph_loader< PointD, WeightType, GraphType >, T_Graph_loader< GraphType, FT >, T_Conformational_ensemble_symmetric_difference_module< ModuleTraits >, T_Weights_file_loader< FT >, T_Points_d_file_loader< PointD >, T_Module_condition< Module, Predicate >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Transition_graph_loader< boost::archive::xml_iarchive, typename Traits::Transition_graph_traits >, T_Point_cloud_hausdorff_distance_d_module< ModuleTraits >, T_Numbers_file_loader< FT >, T_Module_conjunction< ModuleOrLoader1, ModuleOrLoader2 >, and No_particle_annotator.

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

Loads the data.

Reimplemented in T_Exploration_parameters_with_layers< NumberType, Distance >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, T_PDB_file_loader< Molecular_system >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_Molecular_covalent_structure_loader_from_PDB< MolecularCovalentStructure, MolecularCovalentStructureBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Archive_file_loader< InputArchive, SerializedData >, T_Archive_file_loader< boost::archive::xml_iarchive, typename Traits::Atom_shelling_forest >, T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Weights_file_loader< FT >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Transition_graph_loader< boost::archive::xml_iarchive, typename Traits::Transition_graph_traits >, T_Sequences_loader< FT >, T_Points_d_file_loader< PointD >, T_Numbers_file_loader< FT >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Weighted_vertex_graph_loader< PointD, WeightType, GraphType >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Graph_loader< GraphType, FT >, T_Exploration_parameters_default< NumberType, Distance >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, and No_particle_annotator.