BCP_USER.hpp

Go to the documentation of this file.

// Copyright (C) 2000, International Business Machines
// Corporation and others.  All Rights Reserved.
#ifndef _BCP_USER_H
#define _BCP_USER_H

// This file is prepared for doxygen.

#include "CoinSmartPtr.hpp"
#include "BCP_error.hpp"
#include "BCP_message_single.hpp"
#include "BCP_functions.hpp"

class BCP_var_algo;
class BCP_cut_algo;
class BCP_warmstart;

//#############################################################################

class BCP_user_data : public Coin::ReferencedObject {
public:
    virtual ~BCP_user_data() {}
};

//#############################################################################

class BCP_user_class {
public:
    virtual ~BCP_user_class() {}
};

//#############################################################################

class BCP_user_pack {
public:
    BCP_user_class* user_class;

public:
    virtual ~BCP_user_pack() {}

    //-------------------------------------------------------------------------
    virtual void
    pack_warmstart(const BCP_warmstart* ws, BCP_buffer& buf,
                   bool report_if_default = false)
    {
        if (report_if_default) {
            printf("BCP_user_pack : default pack_warmstart() executed.\n");
        }
        BCP_pack_warmstart(ws, buf);
    }

    virtual BCP_warmstart*
    unpack_warmstart(BCP_buffer& buf,
                     bool report_if_default = false)
    {
        if (report_if_default) {
            printf("BCP_user_pack : default unpack_warmstart() executed.\n");
        }
        return BCP_unpack_warmstart(buf);
    }
    
    //-------------------------------------------------------------------------
    virtual void
    pack_var_algo(const BCP_var_algo* var, BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::pack_var_algo() invoked but not overridden!\n");
    }

    virtual BCP_var_algo* unpack_var_algo(BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::unpack_var_algo() invoked but not overridden!\n");
        return 0; // to satisfy aCC on HP-UX
    }
      
    //-------------------------------------------------------------------------
    virtual void pack_cut_algo(const BCP_cut_algo* cut, BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::pack_cut_algo() invoked but not overridden!\n");
    }

    virtual BCP_cut_algo* unpack_cut_algo(BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::unpack_cut_algo() invoked but not overridden!\n");
        return 0; // to satisfy aCC on HP-UX
    }

    //-------------------------------------------------------------------------
    virtual void
    pack_user_data(const BCP_user_data* ud, BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::pack_user_data() invoked but not overridden!\n");
    }

    virtual BCP_user_data* unpack_user_data(BCP_buffer& buf)
    {
        throw BCP_fatal_error("\
BCP_user_pack::unpack_user_data() invoked but not overridden!\n");
    }
};

//#############################################################################

class BCP_tm_user;
class BCP_ts_user;
class BCP_lp_user;
class BCP_vg_user;
class BCP_cg_user;
class BCP_vp_user;
class BCP_cp_user;

class BCP_tm_prob;
class BCP_ts_prob;
class BCP_lp_prob;
class BCP_vg_prob;
class BCP_cg_prob;
class BCP_vp_prob;
class BCP_cp_prob;

class BCP_proc_id;
class BCP_message_environment;

class USER_initialize {
public:
   virtual ~USER_initialize() {}
   //--------------------------------------------------------------------------
   virtual BCP_message_environment * msgenv_init(int argc, char* argv[]);
   //--------------------------------------------------------------------------
   virtual BCP_tm_user * tm_init(BCP_tm_prob& p,
                                 const int argnum,
                                 const char * const * arglist) {
      throw BCP_fatal_error("USER_initialize::tm_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_ts_user * ts_init(BCP_ts_prob& p) {
     // If the user does not need any info in the TS for (un)packing
     // cuts/vars/user_data, then a NULL is fine
      return 0;
   }
   virtual BCP_lp_user * lp_init(BCP_lp_prob& p) {
      throw BCP_fatal_error("USER_initialize::lp_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_vg_user * vg_init(BCP_vg_prob& p) {
      throw BCP_fatal_error("USER_initialize::vg_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_cg_user * cg_init(BCP_cg_prob& p) {
      throw BCP_fatal_error("USER_initialize::cg_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_vp_user * vp_init(BCP_vp_prob& p) {
      throw BCP_fatal_error("USER_initialize::vp_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_cp_user * cp_init(BCP_cp_prob& p) {
      throw BCP_fatal_error("USER_initialize::cp_init() missing.\n");
      return 0; // to satisfy aCC on HP-UX
   }
   virtual BCP_user_pack* packer_init(BCP_user_class* p) {
       return NULL;
   }
};

//#############################################################################

int bcp_main(int argc, char* argv[], USER_initialize* user_init);

#endif