Loader for one or more multiple archives xml archive files
More...

#include "Multiple_archives_xml_archive_file_loader.hpp"

Public Types
typedef std::vector< SerializedData >	Data_vector
	List of serialized data. More...

Public Member Functions
virtual boost::program_options::options_description	add_options (void)
	Virtual method for adding options to 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...

Constructors
	T_Multiple_archives_xml_archive_file_loader (const std::string &tag, const std::string &sec_helper="Secondary archive file name", const std::string &sec_option_name="secondary-archive", const std::string &helper="", const std::string &option_name="")
	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...

Data Management
const Data_vector &	get_all_data (void) const
	Access to all the containers of spheres (const). More...

Data_vector &	get_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 SerializedData &	get_data (unsigned i) const
	ith container of spheres corresponding to the ith input file (const). More...

SerializedData &	get_data (unsigned i)
	ith container of spheres corresponding to the ith input file. More...

const SerializedData &	get_data (void) const
	Container of spheres (use only if one input file was provided) (const). More...

SerializedData &	get_data (void)
	Container of spheres (use only if one input file was provided). More...

const std::vector< SecondaryData * > &	get_secondary_data (void) const
	Container of spheres (use only if one input file was provided) (const). More...

std::vector< SecondaryData * > &	get_secondary_data (void)
	Container of spheres (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 spheres from the input files. More...

void	statistics (std::ostream &out) const
	Print high level statistics on the loaded spheres. More...

Requirements
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

template<class SecondaryArchive, class SecondaryData, class SerializedData>
class SBL::IO::T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >

Loader for one or more multiple archives xml archive files

Loader for one or more multiple archives xml archive files.

Template Parameters

SecondaryArchive	Type of the secondary archive where the full data are stored.
SecondaryData	Type of the data fully stored in the secondary archive.
SerializedData	Type of the data serialized in the archive.

Member Typedef Documentation

◆ Data_vector

typedef std::vector<SerializedData> Data_vector

List of serialized data.

Constructor & Destructor Documentation

◆ T_Multiple_archives_xml_archive_file_loader()

T_Multiple_archives_xml_archive_file_loader	(	const std::string &	tag,
		const std::string &	sec_helper = `"Secondary archive file name"`,
		const std::string &	sec_option_name = `"secondary-archive"`,
		const std::string &	helper = `""`,
		const std::string &	option_name = `""`
	)

inline

Default constructor.

Member Function Documentation

◆ add_options()

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

inlinevirtualinherited

Virtual method for adding options to the module.

◆ 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_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >::Data_vector & get_all_data ( void )

inline

Access to all the containers of spheres.

◆ get_all_data() [2/2]

const T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >::Data_vector & get_all_data ( void ) const

inline

Access to all the containers of spheres (const).

◆ get_data() [1/4]

SerializedData & get_data ( unsigned i )

inline

ith container of spheres corresponding to the ith input file.

◆ get_data() [2/4]

const SerializedData & get_data ( unsigned i ) const

inline

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

◆ get_data() [3/4]

SerializedData & get_data ( void )

inline

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

◆ get_data() [4/4]

const SerializedData & get_data ( void ) const

inline

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

◆ get_name()

virtual std::string get_name ( void ) const

inlinevirtualinherited

Return the name of the class itself.

Reimplemented in T_XTC_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, T_Spheres_3_file_loader< Sphere3, Point3 >, T_Radius_annotator_for_particles_with_annotated_name< NT, SetRadius >, T_Points_d_file_loader< PointD >, T_Particle_annotator_collector< ParticleAnnotator1, ParticleAnnotator2 >, T_Name_annotator_for_atoms< SetAnnotatedName >, T_Dynamic_annotator_for_residues< SetDynamicAnnotation >, T_Dynamic_annotator_for_atoms< SetDynamicAnnotation >, T_Transition_graph_loader< InputArchive, TransitionGraphTraits >, T_Protein_representation_loader< Protein_representation_ >, T_Primitive_labels_loader< PartnerLabelsTraits, MediatorLabelsTraits, ExtraLabelsTraits >, T_Numbers_file_loader< FT, Tag >, T_Molecular_system_loader< Molecular_system_ >, T_Molecular_system_loader< Molecular_system >, T_Molecular_system_loader< Molecular_covalent_structure_builder_::Molecular_covalent_structure::Particle_info::Particle_traits::Molecular_system >, T_Molecular_covalent_structure_loader_from_MOL< MolecularCovalentStructure >, T_Molecular_covalent_structure_loader< Molecular_covalent_structure_builder_ >, T_Molecular_covalent_structure_loader< SBL::CSB::T_Molecular_covalent_structure_builder_for_proteins< typename Protein_representation_::Polypeptide_chain::Molecular_covalent_structure > >, T_Conformation_loader< Conformation_builder_ >, T_Archive_file_loader< InputArchive, SerializedData >, T_PDB_file_loader< ESBTLMolecularSystem, PDBLineFormat >, No_particle_annotator, T_Name_annotator_for_pseudo_atoms< SetAnnotatedName >, T_Generic_annotator_without_file< AnnotationType, SetAnnotation, GetInstanceName >, T_Generic_annotator< KeyType, AnnotationType, MakeKey, SetAnnotation, GetOptionName, GetOptionHelp, GetOptionDisplayName >, T_Domain_annotator_for_particles< Annotations >, T_Conformations_file_loader< ConformationType, ConformationBuilder, ESBTLMolecularSystem, PDBLineFormat >, and T_Molecular_covalent_structure_loader_from_PDB< ParticleTraits, MolecularCovalentStructure, MolecularCovalentStructureBuilder, PDBLineFormat >.

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

◆ get_secondary_data() [1/2]

std::vector< SecondaryData > & get_secondary_data ( void )

inline

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

◆ get_secondary_data() [2/2]

const std::vector< SecondaryData > & get_secondary_data ( void ) const

inline

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

◆ load()

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

inlinevirtual

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.

Public Types

Public Member Functions

Static Public Member Functions

Constructors

Options Descriptions

Output Prefix

Data Management

Requirements

Management

Detailed Description

template<class SecondaryArchive, class SecondaryData, class SerializedData> class SBL::IO::T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >

Member Typedef Documentation

◆ Data_vector

Constructor & Destructor Documentation

◆ T_Multiple_archives_xml_archive_file_loader()

Member Function Documentation

◆ add_options()

◆ check_options()

◆ get_all_data() [1/2]

◆ get_all_data() [2/2]

◆ get_data() [1/4]

◆ get_data() [2/4]

◆ get_data() [3/4]

◆ get_data() [4/4]

◆ get_name()

◆ get_number_of_data()

◆ get_options()

◆ get_output_prefix()

◆ get_secondary_data() [1/2]

◆ get_secondary_data() [2/2]

◆ load()

◆ statistics()

template<class SecondaryArchive, class SecondaryData, class SerializedData>
class SBL::IO::T_Multiple_archives_xml_archive_file_loader< SecondaryArchive, SecondaryData, SerializedData >