USER_initialize Class Reference

This class is an abstract base class for the initializer class the user has to provide. More...

#include <BCP_USER.hpp>

Inheritance diagram for USER_initialize:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Destructor
virtual ~USER_initialize ()
 virtual destructor
Message passing environment
virtual BCP_message_environmentmsgenv_init (int argc, char *argv[])
 Create a message passing environment.
User object initialization in the processes
These methods are invoked when the appropriate process starts. They have to return pointers to user objects, i.e., objects derived from the return value of each init method. Those objects can be used by the user to store information about the problem; information that will be used in the member methods of the user objects.

virtual BCP_tm_usertm_init (BCP_tm_prob &p, const int argnum, const char *const *arglist)
virtual BCP_ts_userts_init (BCP_ts_prob &p)
virtual BCP_lp_userlp_init (BCP_lp_prob &p)
virtual BCP_vg_uservg_init (BCP_vg_prob &p)
virtual BCP_cg_usercg_init (BCP_cg_prob &p)
virtual BCP_vp_user * vp_init (BCP_vp_prob &p)
virtual BCP_cp_user * cp_init (BCP_cp_prob &p)
virtual BCP_user_packpacker_init (BCP_user_class *p)

Detailed Description

This class is an abstract base class for the initializer class the user has to provide.

The user will have to return an instance of the initializer class when the BCP_user_init() function is invoked. The member methods of that instance will be invoked to create the various objects (well, pointers to them) that are used/controlled by the user during the course of a run.

Definition at line 160 of file BCP_USER.hpp.


Constructor & Destructor Documentation

virtual USER_initialize::~USER_initialize (  )  [inline, virtual]

virtual destructor

Definition at line 165 of file BCP_USER.hpp.


Member Function Documentation

virtual BCP_message_environment* USER_initialize::msgenv_init ( int  argc,
char *  argv[] 
) [virtual]

Create a message passing environment.

Currently implemented environments are single and PVM, the default is single. To use PVM, the user has to override this method and return a pointer to a new BCP_pvm_environment object.

virtual BCP_tm_user* USER_initialize::tm_init ( BCP_tm_prob p,
const int  argnum,
const char *const *  arglist 
) [inline, virtual]

Reimplemented in CSP_initialize, MC_initialize, MKC_initialize, BB_init, MC_initialize, MCF1_init, MCF2_init, and MCF3_init.

Definition at line 187 of file BCP_USER.hpp.

virtual BCP_ts_user* USER_initialize::ts_init ( BCP_ts_prob p  )  [inline, virtual]

Definition at line 194 of file BCP_USER.hpp.

virtual BCP_lp_user* USER_initialize::lp_init ( BCP_lp_prob p  )  [inline, virtual]

Reimplemented in CSP_initialize, MC_initialize, MKC_initialize, BB_init, MC_initialize, MCF1_init, MCF2_init, and MCF3_init.

Definition at line 200 of file BCP_USER.hpp.

virtual BCP_vg_user* USER_initialize::vg_init ( BCP_vg_prob p  )  [inline, virtual]

Definition at line 205 of file BCP_USER.hpp.

virtual BCP_cg_user* USER_initialize::cg_init ( BCP_cg_prob p  )  [inline, virtual]

Definition at line 210 of file BCP_USER.hpp.

virtual BCP_vp_user* USER_initialize::vp_init ( BCP_vp_prob &  p  )  [inline, virtual]

Definition at line 215 of file BCP_USER.hpp.

virtual BCP_cp_user* USER_initialize::cp_init ( BCP_cp_prob &  p  )  [inline, virtual]

Definition at line 220 of file BCP_USER.hpp.

virtual BCP_user_pack* USER_initialize::packer_init ( BCP_user_class p  )  [inline, virtual]

Reimplemented in BB_init.

Definition at line 225 of file BCP_USER.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Jan 15 03:03:43 2009 for coin-Bcp by  doxygen 1.4.7