T_Points_d_file_loader< PointD > Class Template Reference

Loader for one or more txt files listing dD points Loader for one or more txt files listing dD points. More...

#include "Points_d_file_loader.hpp"

Public Types
typedef PointD	Point
	Representation of a point. More...
typedef std::vector< Point >	Points_ensemble
	List of points in a file. 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_Points_d_file_loader (void)
	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
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module. More...
std::string	get_name (void) const override
	Return the name of the class itself. More...
std::string	get_output_prefix (void) const override
	Access to the output prefix of this loader. More...

Data Management
std::vector< std::string > &	get_file_names (void)
	Access to all the containers of points (const). More...
unsigned	get_number_of_loaded_data (void) const
	Number of containers of points. More...
const Points_ensemble &	get_data (unsigned i) const
	ith container of points corresponding to the ith input file (const). More...
Points_ensemble &	get_data (unsigned i)
	ith container of points corresponding to the ith input file. More...
const Points_ensemble &	get_data (void) const
	Container of points (use only if one input file was provided) (const). More...
Points_ensemble &	get_data (void)
	Container of points (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 points from the input files. More...
void	statistics (std::ostream &out) const
	Print high level statistics on the loaded points. More...
static void	add_file_name (const std::string &file_name)

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 PointD>
class SBL::Models::T_Points_d_file_loader< PointD >

Loader for one or more txt files listing dD points Loader for one or more txt files listing dD points.

Template Parameters

PointD

Representation of a points in dimension D.

Member Typedef Documentation

Point

typedef PointD Point

Representation of a point.

Points_ensemble

typedef std::vector<Point> Points_ensemble

List of points in a file.

Constructor & Destructor Documentation

T_Points_d_file_loader()

T_Points_d_file_loader ( void  )

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

Check that the parsed options are valid for this loader.

Reimplemented from T_Module_option_description< Dummy >.

get_data() [1/4]

T_Points_d_file_loader< PointD >::Points_ensemble & get_data ( unsigned  i )

inline

ith container of points corresponding to the ith input file.

get_data() [2/4]

const T_Points_d_file_loader< PointD >::Points_ensemble & get_data ( unsigned  i ) const

inline

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

get_data() [3/4]

T_Points_d_file_loader< PointD >::Points_ensemble & get_data ( void  )

inline

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

get_data() [4/4]

const T_Points_d_file_loader< PointD >::Points_ensemble & get_data ( void  ) const

inline

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

get_file_names()

std::vector< std::string > & get_file_names ( void  )

inline

Access to all the containers of points (const).

get_name()

std::string get_name ( void  ) const

inlineoverridevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_number_of_loaded_data()

unsigned get_number_of_loaded_data ( void  ) const

inline

Number of containers of points.

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

load()

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

inlineoverridevirtual

Once the command line options were parsed, build the containers of points from the input files.

Reimplemented from Loader_base.

statistics()

void statistics ( std::ostream &  out ) const

inline

Print high level statistics on the loaded points.