Detailed Description
C++ wrapper for event handlers.
This class defines the interface for event handlers implemented in C++. Note that there is a pure virtual function (this function has to be implemented). This function is: scip_exec().
Definition at line 52 of file objeventhdlr.h.
C++ wrapper for event handlers. More...
#include <objeventhdlr.h>
Public Member Functions | |
ObjEventhdlr (SCIP *scip, const char *name, const char *desc) | |
ObjEventhdlr (const ObjEventhdlr &o) | |
ObjEventhdlr (ObjEventhdlr &&o) | |
virtual | ~ObjEventhdlr () |
ObjEventhdlr & | operator= (const ObjEventhdlr &o)=delete |
ObjEventhdlr & | operator= (ObjEventhdlr &&o)=delete |
virtual | SCIP_DECL_EVENTFREE (scip_free) |
virtual | SCIP_DECL_EVENTINIT (scip_init) |
virtual | SCIP_DECL_EVENTEXIT (scip_exit) |
virtual | SCIP_DECL_EVENTINITSOL (scip_initsol) |
virtual | SCIP_DECL_EVENTEXITSOL (scip_exitsol) |
virtual | SCIP_DECL_EVENTDELETE (scip_delete) |
virtual | SCIP_DECL_EVENTEXEC (scip_exec)=0 |
Public Member Functions inherited from scip::ObjCloneable | |
virtual | ~ObjCloneable () |
ObjCloneable & | operator= (const ObjCloneable &o)=delete |
ObjCloneable & | operator= (ObjCloneable &&o)=delete |
virtual | SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone) |
virtual | SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable) |
Data Fields | |
SCIP * | scip_ |
char * | scip_name_ |
char * | scip_desc_ |
Constructor & Destructor Documentation
◆ ObjEventhdlr() [1/3]
|
inline |
default constructor
- Parameters
-
scip SCIP data structure name name of event handler desc description of event handler
Definition at line 67 of file objeventhdlr.h.
References scip_, SCIP_CALL_ABORT, scip_desc_, scip_name_, and SCIPduplicateMemoryArray.
◆ ObjEventhdlr() [2/3]
|
inline |
copy constructor
Definition at line 82 of file objeventhdlr.h.
◆ ObjEventhdlr() [3/3]
|
inline |
move constructor
Definition at line 85 of file objeventhdlr.h.
References scip_desc_, and scip_name_.
◆ ~ObjEventhdlr()
|
inlinevirtual |
destructor
Definition at line 92 of file objeventhdlr.h.
References scip_, scip_desc_, scip_name_, and SCIPfreeMemoryArray.
Member Function Documentation
◆ operator=() [1/2]
|
delete |
assignment of polymorphic classes causes slicing and is therefore disabled.
◆ operator=() [2/2]
|
delete |
assignment of polymorphic classes causes slicing and is therefore disabled.
◆ SCIP_DECL_EVENTFREE()
|
inlinevirtual |
destructor of event handler to free user data (called when SCIP is exiting)
- See also
- SCIP_DECL_EVENTFREE(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 110 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTINIT()
|
inlinevirtual |
initialization method of event handler (called after problem was transformed)
- See also
- SCIP_DECL_EVENTINIT(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 119 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTEXIT()
|
inlinevirtual |
deinitialization method of event handler (called before transformed problem is freed)
- See also
- SCIP_DECL_EVENTEXIT(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 128 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTINITSOL()
|
inlinevirtual |
solving process initialization method of event handler (called when branch and bound process is about to begin)
- See also
- SCIP_DECL_EVENTINITSOL(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 137 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTEXITSOL()
|
inlinevirtual |
solving process deinitialization method of event handler (called before branch and bound process data is freed)
- See also
- SCIP_DECL_EVENTEXITSOL(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 146 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTDELETE()
|
inlinevirtual |
frees specific constraint data
- See also
- SCIP_DECL_EVENTDELETE(x) in type_event.h
Reimplemented in tsp::EventhdlrNewSol.
Definition at line 155 of file objeventhdlr.h.
References SCIP_OKAY.
◆ SCIP_DECL_EVENTEXEC()
|
pure virtual |
execution method of event handler
- See also
- SCIP_DECL_EVENTEXEC(x) in type_event.h
Implemented in tsp::EventhdlrNewSol.
Field Documentation
◆ scip_
SCIP* scip::ObjEventhdlr::scip_ |
SCIP data structure
Definition at line 58 of file objeventhdlr.h.
Referenced by ObjEventhdlr(), and ~ObjEventhdlr().
◆ scip_name_
char* scip::ObjEventhdlr::scip_name_ |
name of the event handler
Definition at line 61 of file objeventhdlr.h.
Referenced by ObjEventhdlr(), SCIPincludeObjEventhdlr(), and ~ObjEventhdlr().
◆ scip_desc_
char* scip::ObjEventhdlr::scip_desc_ |
description of the event handler
Definition at line 64 of file objeventhdlr.h.
Referenced by ObjEventhdlr(), SCIPincludeObjEventhdlr(), and ~ObjEventhdlr().