T_Points_d_file_loader_generic< PointD, PointD_filler > 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_generic.hpp"

Public Types
typedef PointD	Point
	Representation of a point.
typedef std::vector< Point >	Points_ensemble
	List of points in a file.

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

Constructors
	T_Points_d_file_loader_generic (void)
	Default constructor.

Options Descriptions
bool	check_options (std::string &message) const override
	Check that the parsed options are valid for this loader.

Output Prefix
boost::program_options::options_description	add_options (void) override
	Virtual method for adding options to the module.
std::string	get_name (void) const override
	Return the name of the class itself.
std::string	get_output_prefix (void) const override
	Access to the output prefix of this loader.

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

Detailed Description

template<class PointD, class PointD_filler>
class SBL::Models::T_Points_d_file_loader_generic< PointD, PointD_filler >

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

template<class PointD, class PointD_filler>

typedef PointD Point

Representation of a point.

Points_ensemble

template<class PointD, class PointD_filler>

typedef std::vector<Point> Points_ensemble

List of points in a file.

Constructor & Destructor Documentation

T_Points_d_file_loader_generic()

template<class PointD, class PointD_filler>

T_Points_d_file_loader_generic ( void )

inline

Default constructor.

Member Function Documentation

add_options()

template<class PointD, class PointD_filler>

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 PointD, class PointD_filler>

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]

template<class PointD, class PointD_filler>

T_Points_d_file_loader_generic< PointD, PointD_filler >::Points_ensemble & get_data ( unsigned i )

inline

ith container of points corresponding to the ith input file.

get_data() [2/4]

template<class PointD, class PointD_filler>

const T_Points_d_file_loader_generic< PointD, PointD_filler >::Points_ensemble & get_data ( unsigned i ) const

inline

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

get_data() [3/4]

template<class PointD, class PointD_filler>

T_Points_d_file_loader_generic< PointD, PointD_filler >::Points_ensemble & get_data ( void )

inline

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

get_data() [4/4]

template<class PointD, class PointD_filler>

const T_Points_d_file_loader_generic< PointD, PointD_filler >::Points_ensemble & get_data ( void ) const

inline

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

get_file_names()

template<class PointD, class PointD_filler>

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

inline

Access to all the containers of points (const).

get_name()

template<class PointD, class PointD_filler>

std::string get_name ( void ) const

inlineoverridevirtual

Return the name of the class itself.

Reimplemented from Loader_base.

get_number_of_loaded_data()

template<class PointD, class PointD_filler>

unsigned get_number_of_loaded_data ( void ) const

inline

Number of containers of points.

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 PointD, class PointD_filler>

std::string get_output_prefix ( void ) const

inlineoverridevirtual

Access to the output prefix of this loader.

Reimplemented from T_Module_option_description< Dummy >.

load()

template<class PointD, class PointD_filler>

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

template<class PointD, class PointD_filler>

void statistics ( std::ostream & out ) const

inline

Print high level statistics on the loaded points.