Cbc  2.10.5
CbcEventHandler.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2006, International Business Machines Corporation and others.
3  All Rights Reserved.
4 
5  This code is licensed under the terms of the Eclipse Public License (EPL).
6 
7  $Id$
8 */
9 
10 #ifndef CbcEventHandler_H
11 #define CbcEventHandler_H
12 
49 #include <cstddef>
50 #include <map>
51 
52 /* May well already be declared, but can't hurt. */
53 
54 class CbcModel;
55 
56 /*
57  cvs/svn: $Id$
58 */
59 
83 
84 public:
87  enum CbcEvent {
88  node = 200,
110  endSearch
111  };
112 
118  enum CbcAction {
119  noAction = -1,
121  stop = 0,
133  takeAction
134 
135  };
136 
139  typedef std::map< CbcEvent, CbcAction > eaMapPair;
140 
143 
150  virtual CbcAction event(CbcEvent whichEvent);
151 
158  virtual CbcAction event(CbcEvent whichEvent, void *data);
159 
161 
164 
167  CbcEventHandler(CbcModel *model = 0 /* was NULL but 4.6 complains */);
168 
172 
176 
179  virtual CbcEventHandler *clone() const;
180 
183  virtual ~CbcEventHandler();
184 
186 
189 
192  inline void setModel(CbcModel *model)
193  {
194  model_ = model;
195  }
196 
199  inline const CbcModel *getModel() const
200  {
201  return model_;
202  }
203 
206  inline void setDfltAction(CbcAction action)
207  {
208  dfltAction_ = action;
209  }
210 
213  inline void setAction(CbcEvent event, CbcAction action)
214  {
215  if (eaMap_ == 0) {
216  eaMap_ = new eaMapPair;
217  }
218  (*eaMap_)[event] = action;
219  }
220 
222 
223 protected:
229 
233 
237 
241 
243 };
244 
245 #endif
246 
247 /* vi: softtabstop=2 shiftwidth=2 expandtab tabstop=2
248 */
Base class for Cbc event handling.
void setDfltAction(CbcAction action)
Set the default action.
CbcAction
Action codes returned by the event handler.
@ restartRoot
RestartRoot — undo root node and start branch-and-cut afresh.
@ noAction
Continue — no action required.
@ takeAction
Take action on modified data.
@ restart
Restart — restart branch-and-cut search; do not undo root node processing.
@ killSolution
Pretend solution never happened.
@ stop
Stop — abort the current run at the next opportunity.
@ addCuts
Add special cuts.
void setAction(CbcEvent event, CbcAction action)
Set the action code associated with an event.
virtual CbcEventHandler * clone() const
Clone (virtual) constructor.
virtual ~CbcEventHandler()
Destructor.
CbcEventHandler(CbcModel *model=0)
Default constructor.
CbcEventHandler & operator=(const CbcEventHandler &rhs)
Assignment.
const CbcModel * getModel() const
Get model.
virtual CbcAction event(CbcEvent whichEvent, void *data)
Return the action to be taken for an event - and modify data.
CbcEventHandler(const CbcEventHandler &orig)
Copy constructor.
std::map< CbcEvent, CbcAction > eaMapPair
Data type for event/action pairs.
void setModel(CbcModel *model)
Set model.
CbcEvent
Events known to cbc.
@ beforeSolution1
A solution will be found unless user takes action (first check).
@ afterHeuristic
After failed heuristic.
@ smallBranchAndBound
On entry to small branch and bound.
@ node
Processing of the current node is complete.
@ solution
A solution has been found.
@ convertToCuts
When converting constraints to cuts.
@ beforeSolution2
A solution will be found unless user takes action (thorough check).
@ endSearch
End of search.
@ treeStatus
A tree status interval has arrived.
@ heuristicSolution
A heuristic solution has been found.
@ generatedCuts
Having generated cuts, allows user to think.
@ heuristicPass
After a pass of heuristic.
virtual CbcAction event(CbcEvent whichEvent)
Return the action to be taken for an event.
CbcAction dfltAction_
Default action.
eaMapPair * eaMap_
Pointer to a map that holds non-default event/action pairs.
CbcModel * model_
Pointer to associated CbcModel.
Simple Branch and bound class.
Definition: CbcModel.hpp:100