SCIP Doxygen Documentation
Loading...
Searching...
No Matches
objeventhdlr.cpp File Reference

Detailed Description

C++ wrapper for event handlers.

Author
Tobias Achterberg

Definition in file objeventhdlr.cpp.

#include <cassert>
#include "objeventhdlr.h"

Go to the source code of this file.

Functions

static SCIP_DECL_EVENTCOPY (eventhdlrCopyObj)
static SCIP_DECL_EVENTFREE (eventhdlrFreeObj)
static SCIP_DECL_EVENTINIT (eventhdlrInitObj)
static SCIP_DECL_EVENTEXIT (eventhdlrExitObj)
static SCIP_DECL_EVENTINITSOL (eventhdlrInitsolObj)
static SCIP_DECL_EVENTEXITSOL (eventhdlrExitsolObj)
static SCIP_DECL_EVENTDELETE (eventhdlrDeleteObj)
static SCIP_DECL_EVENTEXEC (eventhdlrExecObj)
SCIP_RETCODE SCIPincludeObjEventhdlr (SCIP *scip, scip::ObjEventhdlr *objeventhdlr, SCIP_Bool deleteobject)
scip::ObjEventhdlr * SCIPfindObjEventhdlr (SCIP *scip, const char *name)
scip::ObjEventhdlr * SCIPgetObjEventhdlr (SCIP *scip, SCIP_EVENTHDLR *eventhdlr)

Function Documentation

◆ SCIP_DECL_EVENTCOPY()

SCIP_DECL_EVENTCOPY ( eventhdlrCopyObj )
static

copy method for event handler plugins (called when SCIP copies plugins)

Definition at line 62 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrGetData(), SCIPincludeObjEventhdlr(), and TRUE.

◆ SCIP_DECL_EVENTFREE()

SCIP_DECL_EVENTFREE ( eventhdlrFreeObj )
static

destructor of event handler to free user data (called when SCIP is exiting)

Definition at line 87 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPeventhdlrGetData(), and SCIPeventhdlrSetData().

◆ SCIP_DECL_EVENTINIT()

SCIP_DECL_EVENTINIT ( eventhdlrInitObj )
static

initialization method of event handler (called after problem was transformed)

Definition at line 113 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIP_DECL_EVENTEXIT()

SCIP_DECL_EVENTEXIT ( eventhdlrExitObj )
static

deinitialization method of event handler (called before transformed problem is freed)

Definition at line 131 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIP_DECL_EVENTINITSOL()

SCIP_DECL_EVENTINITSOL ( eventhdlrInitsolObj )
static

solving process initialization method of event handler (called when branch and bound process is about to begin)

Definition at line 148 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIP_DECL_EVENTEXITSOL()

SCIP_DECL_EVENTEXITSOL ( eventhdlrExitsolObj )
static

solving process deinitialization method of event handler (called before branch and bound process data is freed)

Definition at line 165 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIP_DECL_EVENTDELETE()

SCIP_DECL_EVENTDELETE ( eventhdlrDeleteObj )
static

frees specific constraint data

Definition at line 182 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIP_DECL_EVENTEXEC()

SCIP_DECL_EVENTEXEC ( eventhdlrExecObj )
static

execution method of event handler

Definition at line 199 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPeventhdlrGetData().

◆ SCIPincludeObjEventhdlr()

SCIP_RETCODE SCIPincludeObjEventhdlr ( SCIP * scip,
scip::ObjEventhdlr * objeventhdlr,
SCIP_Bool deleteobject )

creates the event handler for the given event handler object and includes it in SCIP

creates the event handler for the given event handler object and includes it in SCIP

The method should be called in one of the following ways:

  1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyEventhdlr* myeventhdlr = new MyEventhdlr(...); SCIP_CALL( SCIPincludeObjEventhdlr(scip, &myeventhdlr, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete myeventhdlr; // delete eventhdlr AFTER SCIPfree() !
  2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjEventhdlr(scip, new MyEventhdlr(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyEventhdlr is called here
Parameters
scipSCIP data structure
objeventhdlrevent handler object
deleteobjectshould the event handler object be deleted when eventhdlr is freed?

Definition at line 221 of file objeventhdlr.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjEventhdlr::scip_desc_, scip::ObjEventhdlr::scip_name_, SCIP_OKAY, and SCIPincludeEventhdlr().

Referenced by runSCIP(), and SCIP_DECL_EVENTCOPY().

◆ SCIPfindObjEventhdlr()

scip::ObjEventhdlr * SCIPfindObjEventhdlr ( SCIP * scip,
const char * name )

returns the eventhdlr object of the given name, or 0 if not existing

Parameters
scipSCIP data structure
namename of event handler

Definition at line 248 of file objeventhdlr.cpp.

References assert(), NULL, SCIPeventhdlrGetData(), and SCIPfindEventhdlr().

◆ SCIPgetObjEventhdlr()

scip::ObjEventhdlr * SCIPgetObjEventhdlr ( SCIP * scip,
SCIP_EVENTHDLR * eventhdlr )

returns the eventhdlr object for the given event handler

Parameters
scipSCIP data structure
eventhdlrevent handler

Definition at line 267 of file objeventhdlr.cpp.

References assert(), NULL, and SCIPeventhdlrGetData().