CbcUser Class Reference

A class to allow the use of unknown user functionality. More...

#include <CbcSolver.hpp>

Collaboration diagram for CbcUser:

Public Member Functions
import/export methods
virtual int	importData (CbcSolver *, int &, char **)
	Import - gets full command arguments. More...
virtual void	exportSolution (CbcSolver *, int, const char *=NULL)
	Export. More...
virtual void	exportData (CbcSolver *)
	Export Data (i.e. at very end) More...
virtual void	fillInformation (CbcSolver *, CbcSolverUsefulData &)
	Get useful stuff. More...
usage methods
CoinModel *	coinModel () const
	CoinModel if valid. More...
virtual void *	stuff ()
	Other info - needs expanding. More...
std::string	name () const
	Name. More...
virtual void	solve (CbcSolver *model, const char *options)=0
	Solve (whatever that means) More...
virtual bool	canDo (const char *options)=0
	Returns true if function knows about option. More...
Constructors and destructors etc
	CbcUser ()
	Default Constructor. More...
	CbcUser (const CbcUser &rhs)
	Copy constructor. More...
CbcUser &	operator= (const CbcUser &rhs)
	Assignment operator. More...
virtual CbcUser *	clone () const =0
	Clone. More...
virtual	~CbcUser ()
	Destructor. More...

Protected Attributes
Private member data
CoinModel *	coinModel_
	CoinModel. More...
std::string	userName_
	Name of user function. More...

Detailed Description

A class to allow the use of unknown user functionality.

For example, access to a modelling language (CbcAmpl).

Definition at line 314 of file CbcSolver.hpp.

Constructor & Destructor Documentation

CbcUser() [1/2]

CbcUser::CbcUser

(

)

Default Constructor.

CbcUser() [2/2]

CbcUser::CbcUser

(

const CbcUser &

rhs

)

Copy constructor.

~CbcUser()

virtual CbcUser::~CbcUser ( )

virtual

Destructor.

Member Function Documentation

importData()

virtual int CbcUser::importData ( CbcSolver *  , int &  , char **    )

inlinevirtual

Import - gets full command arguments.

Returns

• -1 - no action
• 0 - data read in without error
• 1 - errors

Definition at line 326 of file CbcSolver.hpp.

exportSolution()

virtual void CbcUser::exportSolution ( CbcSolver *  , int  , const char *  = NULL  )

inlinevirtual

Export.

Values for mode:

• 1 OsiClpSolver
• 2 CbcModel
• add 10 if infeasible from odd situation

Definition at line 338 of file CbcSolver.hpp.

exportData()

virtual void CbcUser::exportData ( CbcSolver *  )

inlinevirtual

Export Data (i.e. at very end)

Definition at line 342 of file CbcSolver.hpp.

fillInformation()

virtual void CbcUser::fillInformation ( CbcSolver *  , CbcSolverUsefulData &    )

inlinevirtual

Get useful stuff.

Definition at line 345 of file CbcSolver.hpp.

coinModel()

CoinModel* CbcUser::coinModel ( ) const

inline

CoinModel if valid.

Definition at line 352 of file CbcSolver.hpp.

stuff()

virtual void* CbcUser::stuff ( )

inlinevirtual

Other info - needs expanding.

Definition at line 357 of file CbcSolver.hpp.

name()

std::string CbcUser::name ( ) const

inline

Name.

Definition at line 362 of file CbcSolver.hpp.

solve()

virtual void CbcUser::solve ( CbcSolver *  model, const char *  options  )

pure virtual

Solve (whatever that means)

canDo()

virtual bool CbcUser::canDo ( const char *  options )

pure virtual

Returns true if function knows about option.

operator=()

CbcUser& CbcUser::operator=

(

const CbcUser &

rhs

)

Assignment operator.

clone()

virtual CbcUser* CbcUser::clone ( ) const

pure virtual

Clone.

Member Data Documentation

coinModel_

CoinModel* CbcUser::coinModel_

protected

CoinModel.

Definition at line 395 of file CbcSolver.hpp.

userName_

std::string CbcUser::userName_

protected

Name of user function.

Definition at line 398 of file CbcSolver.hpp.

---

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

• /home/ted/Projects/Cbc/Cbc/src/CbcSolver.hpp