T_Archive_file_loader< InputArchive, SerializedData > Class Template Reference

Loader for one or more boost archive files
More...

#include "Archive_file_loader.hpp"

Public Types
typedef T_Archive_file_loader< InputArchive, SerializedData >	Self
typedef SBL::IO::Loader_base	Base
typedef std::vector< SerializedData * >	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...
static bool	has_options (void)
static void	delete_options (void)
static void	initialize_options (const std::string &caption)

Constructors
	T_Archive_file_loader (const std::string &tag, const std::string &helper="Archive file name", const std::string &option_name="filename,f")
	Default constructor. More...
	~T_Archive_file_loader (void)

Options Descriptions
boost::program_options::options_description	add_options (void) const
	Virtual method for adding options to the module. More...
bool	check_options (std::string &message) const
	Check that the parsed options are valid for this loader. More...

Output Prefix
std::string	get_output_prefix (void) const
	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...
std::string	get_name (void) const
	Return the name of the class itself. 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)
	Print high level statistics on the loaded spheres. 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 InputArchive, class SerializedData>
class SBL::IO::T_Archive_file_loader< InputArchive, SerializedData >

Loader for one or more boost archive files

Loader for one or more boost archive files.

Template Parameters

InputArchive	Type of the boost archive from which the data structure will be loaded.
SerializedData	Type of the data serialized in the archive.

Member Typedef Documentation

Base

typedef SBL::IO::Loader_base Base

Data_vector

typedef std::vector<SerializedData*> Data_vector

List of serialized data.

Self

typedef T_Archive_file_loader<InputArchive, SerializedData> Self

Constructor & Destructor Documentation

T_Archive_file_loader()

T_Archive_file_loader ( const std::string &  tag, const std::string &  helper = "Archive file name", const std::string &  option_name = "filename,f"  )

inline

Default constructor.

~T_Archive_file_loader()

~T_Archive_file_loader ( void  )

inline

Member Function Documentation

add_options()

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

inlinevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

bool check_options ( std::string &  message ) const

inlinevirtual

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description< Dummy >.

delete_options()

static void delete_options ( void  )

inlinestaticinherited

get_all_data() [1/2]

T_Archive_file_loader< InputArchive, SerializedData >::Data_vector & get_all_data ( void  )

inline

Access to all the containers of spheres.

get_all_data() [2/2]

const T_Archive_file_loader< InputArchive, 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_loader_instance_name()

const std::string& get_loader_instance_name ( void  ) const

inlineinherited

get_name()

std::string get_name ( void  ) const

inlinevirtual

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

inlinevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description< Dummy >.

has_options()

static bool has_options ( void  )

inlinestaticinherited

initialize_options()

static void initialize_options ( const std::string &  caption )

inlinestaticinherited

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.

set_loader_instance_name()

void set_loader_instance_name ( const std::string &  loader_instance_name )

inlineinherited

statistics()

void statistics ( std::ostream &  out )

inline

Print high level statistics on the loaded spheres.