T_Transition_graph_loader< InputArchive, TransitionGraphTraits > Class Template Reference

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

#include <Transition_graph_loader.hpp>

Public Types
typedef std::vector< typename TransitionGraphTraits::Graph * >	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...

Constructors
	T_Transition_graph_loader (const std::string &tag="Transition Graph Loader", const std::string &helper="Transition graph archive", const std::string &option_name="transition-graph")
	Default constructor. More...

Options Descriptions
bool	check_options (std::string &message) const override
	Checks that the input options' values are coherent. More...

Output Prefix
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module. More...
std::string	get_output_prefix (void) const override
	Returns a prefix that concatains the input line options used when running the module. More...
std::string	get_name (void) const override
	Returns the name of the package. 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 TransitionGraphTraits::Graph &	get_data (unsigned i) const
	ith container of spheres corresponding to the ith input file (const). More...
TransitionGraphTraits::Graph &	get_data (unsigned i)
	ith container of spheres corresponding to the ith input file. More...
const TransitionGraphTraits::Graph &	get_data (void) const
	Container of spheres (use only if one input file was provided) (const). More...
TransitionGraphTraits::Graph &	get_data (void)
	Container of spheres (use only if one input file was provided). More...
bool	load (unsigned verbose=false, std::ostream &out=std::cout) override
	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...

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 TransitionGraphTraits>
class SBL::IO::T_Transition_graph_loader< InputArchive, TransitionGraphTraits >

Loader for one or more boost archive files

Template Parameters

Sphere3	Representation of a 3D sphere.
Point3	Representation of the center of a 3D sphere.

Member Typedef Documentation

Data_vector

typedef std::vector<typename TransitionGraphTraits::Graph*> Data_vector

List of serialized data.

Constructor & Destructor Documentation

T_Transition_graph_loader()

T_Transition_graph_loader ( const std::string &  tag = "Transition Graph Loader", const std::string &  helper = "Transition graph archive", const std::string &  option_name = "transition-graph"  )

inline

Default constructor.

Member Function Documentation

add_options()

boost::program_options::options_description add_options ( void  )

inlineoverridevirtual

Virtual method for adding options to the module.

Reimplemented from T_Module_option_description< Dummy >.

check_options()

bool check_options ( std::string &  message ) const

inlineoverridevirtual

Checks that the input options' values are coherent.

Reimplemented from T_Module_option_description< Dummy >.

get_all_data() [1/2]

T_Transition_graph_loader< InputArchive, TransitionGraphTraits >::Data_vector & get_all_data ( void  )

inline

Access to all the containers of spheres.

get_all_data() [2/2]

const T_Transition_graph_loader< InputArchive, TransitionGraphTraits >::Data_vector & get_all_data ( void  ) const

inline

Access to all the containers of spheres (const).

get_data() [1/4]

TransitionGraphTraits::Graph & get_data ( unsigned  i )

inline

ith container of spheres corresponding to the ith input file.

get_data() [2/4]

const TransitionGraphTraits::Graph & get_data ( unsigned  i ) const

inline

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

get_data() [3/4]

TransitionGraphTraits::Graph & get_data ( void  )

inline

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

get_data() [4/4]

const TransitionGraphTraits::Graph & get_data ( void  ) const

inline

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

get_name()

std::string get_name ( void  ) const

inlineoverridevirtual

Returns the name of the package.

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

inlineoverridevirtual

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

Reimplemented from T_Module_option_description< Dummy >.

load()

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

inlineoverridevirtual

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.