T_Sequences_loader< FT > Class Template Reference

Loader for exactly two sequences. More...

#include <Sequences_loader.hpp>

Public Types
typedef T_Sequences_loader< FT >	Self
typedef SBL::IO::Loader_base	Base
typedef std::vector< std::string >	Clonotype
typedef std::vector< Clonotype >	Clonotype_ensemble

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_Sequences_loader (void)
	Default constructor. More...

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

Output Prefix
std::string	get_name (void) const
	Access to the output prefix of this loader. More...
std::string	get_output_prefix (void) const
	Access to the output prefix of this loader. More...

Data Management
const std::string &	get_sequence_type (void)
unsigned	get_number_of_loaded_ensembles (void)
Clonotype_ensemble &	get_clonotype_ensemble (unsigned i)
const FT &	get_total_weight (unsigned i)
const std::vector< FT > &	get_weights (unsigned i)
boost::program_options::options_description	add_options (void) const
	Virtual method for adding options to the module. More...
bool	load (unsigned verbose, std::ostream &out, unsigned i)
	Once the command line options were parsed, build the containers of weights from the input files. More...
bool	load (unsigned verbose=false, std::ostream &out=std::cout)
	Once the command line options were parsed, build the containers of weights from the input files. More...
void	statistics (std::ostream &out) const
	Print high level statistics on the loaded weights. 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 FT>
class SBL::IO::T_Sequences_loader< FT >

Loader for exactly two sequences.

Template Parameters

FT	Representation of a weight.

Member Typedef Documentation

Base

typedef SBL::IO::Loader_base Base

Clonotype

typedef std::vector<std::string> Clonotype

Clonotype_ensemble

typedef std::vector<Clonotype> Clonotype_ensemble

Self

typedef T_Sequences_loader<FT> Self

Constructor & Destructor Documentation

T_Sequences_loader()

T_Sequences_loader ( void  )

inline

Default constructor.

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

T_Sequences_loader< FT >::Clonotype_ensemble & get_clonotype_ensemble ( unsigned  i )

inline

get_loader_instance_name()

const std::string& get_loader_instance_name ( void  ) const

inlineinherited

get_name()

std::string get_name ( void  ) const

inlinevirtual

Access to the output prefix of this loader.

Reimplemented from Loader_base.

get_number_of_loaded_ensembles()

unsigned get_number_of_loaded_ensembles ( void  )

inline

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

get_sequence_type()

const std::string & get_sequence_type ( void  )

inline

get_total_weight()

const FT & get_total_weight ( unsigned  i )

inline

get_weights()

const std::vector< FT > & get_weights ( unsigned  i )

inline

has_options()

static bool has_options ( void  )

inlinestaticinherited

initialize_options()

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

inlinestaticinherited

load() [1/2]

bool load ( unsigned  verbose, std::ostream &  out, unsigned  i  )

inline

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

load() [2/2]

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

inlinevirtual

Once the command line options were parsed, build the containers of weights 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 ) const

inline

Print high level statistics on the loaded weights.