#include <BCP_tmstorage.hpp>

Inheritance diagram for BCP_ts_user:

Collaboration diagram for BCP_ts_user:

Public Member Functions
virtual void	unpack_module_data (BCP_buffer &buf)
	Unpack the initial information sent to the LP process by the Tree Manager. More...

Methods to set and get the pointer to the BCP_ts_prob
object. It is unlikely that the users would want to muck around with these (especially with the set method!) but they are here to provide total control.
void	setTsProblemPointer (BCP_ts_prob *ptr)
	Set the pointer. More...

BCP_ts_prob *	getTsProblemPointer ()
	Get the pointer. More...

Methods to get/set BCP parameters on the fly
char	get_param (const BCP_ts_par::chr_params key) const

int	get_param (const BCP_ts_par::int_params key) const

double	get_param (const BCP_ts_par::dbl_params key) const

const BCP_string &	get_param (const BCP_ts_par::str_params key) const

void	set_param (const BCP_ts_par::chr_params key, const bool val)

void	set_param (const BCP_ts_par::chr_params key, const char val)

void	set_param (const BCP_ts_par::int_params key, const int val)

void	set_param (const BCP_ts_par::dbl_params key, const double val)

void	set_param (const BCP_ts_par::str_params key, const char *val)

Constructor, Destructor
	BCP_ts_user ()
	Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More...

virtual	~BCP_ts_user ()
	Being virtual, the destructor invokes the destructor for the real type of the object being deleted. More...

Public Member Functions inherited from BCP_user_class
virtual	~BCP_user_class ()

Private Attributes
BCP_ts_prob *	p

Detailed Description

Definition at line 125 of file BCP_tmstorage.hpp.

Constructor & Destructor Documentation

BCP_ts_user::BCP_ts_user ( )

inline

Being virtual, the destructor invokes the destructor for the real type of the object being deleted.

Definition at line 166 of file BCP_tmstorage.hpp.

virtual BCP_ts_user::~BCP_ts_user ( )

inlinevirtual

Being virtual, the destructor invokes the destructor for the real type of the object being deleted.

Definition at line 169 of file BCP_tmstorage.hpp.

Member Function Documentation

void BCP_ts_user::setTsProblemPointer ( BCP_ts_prob * ptr )

inline

Set the pointer.

Definition at line 136 of file BCP_tmstorage.hpp.

BCP_ts_prob* BCP_ts_user::getTsProblemPointer ( )

inline

Get the pointer.

Definition at line 138 of file BCP_tmstorage.hpp.

References p.

char BCP_ts_user::get_param ( const BCP_ts_par::chr_params key ) const

inline

Definition at line 143 of file BCP_tmstorage.hpp.

References BCP_parameter_set< Par >::entry(), p, and BCP_ts_prob::par.

int BCP_ts_user::get_param ( const BCP_ts_par::int_params key ) const

inline

Definition at line 145 of file BCP_tmstorage.hpp.

References BCP_parameter_set< Par >::entry(), p, and BCP_ts_prob::par.

double BCP_ts_user::get_param ( const BCP_ts_par::dbl_params key ) const

inline

Definition at line 147 of file BCP_tmstorage.hpp.

References BCP_parameter_set< Par >::entry(), p, and BCP_ts_prob::par.

const BCP_string& BCP_ts_user::get_param ( const BCP_ts_par::str_params key ) const

inline

Definition at line 149 of file BCP_tmstorage.hpp.

References BCP_parameter_set< Par >::entry(), p, and BCP_ts_prob::par.

void BCP_ts_user::set_param	(	const BCP_ts_par::chr_params	key,
		const bool	val
	)

inline

Definition at line 152 of file BCP_tmstorage.hpp.

References p, BCP_ts_prob::par, and BCP_parameter_set< Par >::set_entry().

void BCP_ts_user::set_param	(	const BCP_ts_par::chr_params	key,
		const char	val
	)

inline

Definition at line 154 of file BCP_tmstorage.hpp.

References p, BCP_ts_prob::par, and BCP_parameter_set< Par >::set_entry().

void BCP_ts_user::set_param	(	const BCP_ts_par::int_params	key,
		const int	val
	)

inline

Definition at line 156 of file BCP_tmstorage.hpp.

References p, BCP_ts_prob::par, and BCP_parameter_set< Par >::set_entry().

void BCP_ts_user::set_param	(	const BCP_ts_par::dbl_params	key,
		const double	val
	)

inline

Definition at line 158 of file BCP_tmstorage.hpp.

References p, BCP_ts_prob::par, and BCP_parameter_set< Par >::set_entry().

void BCP_ts_user::set_param	(	const BCP_ts_par::str_params	key,
		const char *	val
	)

inline

Definition at line 160 of file BCP_tmstorage.hpp.

References p, BCP_ts_prob::par, and BCP_parameter_set< Par >::set_entry().

virtual void BCP_ts_user::unpack_module_data ( BCP_buffer & buf )

virtual

Unpack the initial information sent to the LP process by the Tree Manager.

This information was packed by the method BCP_ts_user::pack_module_data() invoked with BCP_ProcessType_TS as the third (target process type) argument.

Default: empty method.

Member Data Documentation

BCP_ts_prob* BCP_ts_user::p

private

Definition at line 127 of file BCP_tmstorage.hpp.

Referenced by get_param(), getTsProblemPointer(), and set_param().

The documentation for this class was generated from the following file:

/tmp/Bcp-1.4.4/Bcp/src/include/BCP_tmstorage.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation