Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ClpEventHandler Class Reference

Base class for Clp event handling. More...

#include <ClpEventHandler.hpp>

Inheritance diagram for ClpEventHandler:

MyEventHandler List of all members.

Public Types

enum  Event { endOfIteration = 100, endOfFactorization, endOfValuesPass }
 enums for what sort of event. More...


Public Methods

Virtual method that the derived classe should provide.
The base class instance does nothing and as event() is only useful method it would not be very useful NOT providing one!

virtual int event (Event whichEvent)
 This can do whatever it likes.

Constructors, destructor
 ClpEventHandler (ClpSimplex *model=NULL)
 Default constructor.

virtual ~ClpEventHandler ()
 Destructor.

 ClpEventHandler (const ClpEventHandler &)
 Default constructor.

ClpEventHandler & operator= (const ClpEventHandler &)
 Default constructor.

virtual ClpEventHandler * clone () const
 Clone.

Sets/gets
void setSimplex (ClpSimplex *model)
 set model.

ClpSimplexsimplex () const
 Get model.


Protected Attributes

Data members
The data members are protected to allow access for derived classes.

ClpSimplexmodel_
 Pointer to simplex.


Detailed Description

Base class for Clp event handling.

This is just here to allow for event handling. By event I mean a Clp event e.g. end of values pass.

One use would be to let a user handle a system event e.g. Control-C. This could be done by deriving a class MyEventHandler which knows about such events. If one occurs MyEventHandler::event() could clear event status and return 3 (stopped).

Clp would then return to user code.

As it is called every iteration this should be fine grained enough.

Definition at line 23 of file ClpEventHandler.hpp.


Member Enumeration Documentation

enum ClpEventHandler::Event
 

enums for what sort of event.

These will also be returned in ClpModel::secondaryStatus() as int

Enumeration values:
endOfIteration 
endOfFactorization 
endOfValuesPass 

Definition at line 30 of file ClpEventHandler.hpp.


Constructor & Destructor Documentation

ClpEventHandler::ClpEventHandler ClpSimplex   model = NULL
 

Default constructor.

virtual ClpEventHandler::~ClpEventHandler   [virtual]
 

Destructor.

ClpEventHandler::ClpEventHandler const ClpEventHandler &   
 

Default constructor.


Member Function Documentation

virtual int ClpEventHandler::event Event    whichEvent [virtual]
 

This can do whatever it likes.

If return code -1 then carries on if 0 sets ClpModel::status() to 5 (stopped by event) and will return to user. At present if <-1 carries on and if >0 acts as if 0 - this may change

Reimplemented in MyEventHandler.

ClpEventHandler& ClpEventHandler::operator= const ClpEventHandler &   
 

Default constructor.

virtual ClpEventHandler* ClpEventHandler::clone   const [virtual]
 

Clone.

Reimplemented in MyEventHandler.

void ClpEventHandler::setSimplex ClpSimplex   model
 

set model.

ClpSimplex* ClpEventHandler::simplex   const [inline]
 

Get model.

Definition at line 70 of file ClpEventHandler.hpp.

References model_.


Member Data Documentation

ClpSimplex* ClpEventHandler::model_ [protected]
 

Pointer to simplex.

Definition at line 80 of file ClpEventHandler.hpp.

Referenced by simplex().


The documentation for this class was generated from the following file:
Generated on Fri Aug 6 02:01:33 2004 by doxygen1.3-rc2