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.

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

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.

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

Output Prefix
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module.
std::string	get_output_prefix (void) const override
	Returns a prefix that concatains the input line options used when running the module.
std::string	get_name (void) const override
	Returns the name of the package.

Data Management
const Data_vector &	get_all_data (void) const
	Access to all the containers of spheres (const).
Data_vector &	get_all_data (void)
	Access to all the containers of spheres.
unsigned	get_number_of_data (void) const
	Number of containers of spheres.
const TransitionGraphTraits::Graph &	get_data (unsigned i) const
	ith container of spheres corresponding to the ith input file (const).
TransitionGraphTraits::Graph &	get_data (unsigned i)
	ith container of spheres corresponding to the ith input file.
const TransitionGraphTraits::Graph &	get_data (void) const
	Container of spheres (use only if one input file was provided) (const).
TransitionGraphTraits::Graph &	get_data (void)
	Container of spheres (use only if one input file was provided).
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.
void	statistics (std::ostream &out) const
	Print high level statistics on the loaded spheres.

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

template<class InputArchive, class TransitionGraphTraits>

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

List of serialized data.

Constructor & Destructor Documentation

T_Transition_graph_loader()

template<class InputArchive, class TransitionGraphTraits>

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

template<class InputArchive, class TransitionGraphTraits>

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

template<class InputArchive, class TransitionGraphTraits>

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]

template<class InputArchive, class TransitionGraphTraits>

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]

template<class InputArchive, class TransitionGraphTraits>

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]

template<class InputArchive, class TransitionGraphTraits>

TransitionGraphTraits::Graph & get_data ( unsigned i )

inline

ith container of spheres corresponding to the ith input file.

get_data() [2/4]

template<class InputArchive, class TransitionGraphTraits>

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

inline

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

get_data() [3/4]

template<class InputArchive, class TransitionGraphTraits>

TransitionGraphTraits::Graph & get_data ( void )

inline

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

get_data() [4/4]

template<class InputArchive, class TransitionGraphTraits>

const TransitionGraphTraits::Graph & get_data ( void ) const

inline

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

get_name()

template<class InputArchive, class TransitionGraphTraits>

std::string get_name ( void ) const

inlineoverridevirtual

Returns the name of the package.

Reimplemented from Loader_base.

get_number_of_data()

template<class InputArchive, class TransitionGraphTraits>

unsigned get_number_of_data ( void ) const

inline

Number of containers of spheres.

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 InputArchive, class TransitionGraphTraits>

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

template<class InputArchive, class TransitionGraphTraits>

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

template<class InputArchive, class TransitionGraphTraits>

void statistics ( std::ostream & out ) const

inline

Print high level statistics on the loaded spheres.