Scippy

SCIP

Solving Constraint Integer Programs

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()

static SCIP_DECL_EVENTCOPY ( eventhdlrCopyObj )

static

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

Definition at line 53 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTFREE()

static SCIP_DECL_EVENTFREE ( eventhdlrFreeObj )

static

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

Definition at line 78 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTINIT()

static SCIP_DECL_EVENTINIT ( eventhdlrInitObj )

static

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

Definition at line 104 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTEXIT()

static SCIP_DECL_EVENTEXIT ( eventhdlrExitObj )

static

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

Definition at line 122 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTINITSOL()

static 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 139 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTEXITSOL()

static SCIP_DECL_EVENTEXITSOL ( eventhdlrExitsolObj )

static

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

Definition at line 156 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTDELETE()

static SCIP_DECL_EVENTDELETE ( eventhdlrDeleteObj )

static

frees specific constraint data

Definition at line 173 of file objeventhdlr.cpp.

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

◆ SCIP_DECL_EVENTEXEC()

static SCIP_DECL_EVENTEXEC ( eventhdlrExecObj )

static

execution method of event handler

Definition at line 190 of file objeventhdlr.cpp.

References 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

Parameters

scip	SCIP data structure
objeventhdlr	event handler object
deleteobject	should the event handler object be deleted when eventhdlristic is freed?

Definition at line 212 of file objeventhdlr.cpp.

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

Referenced by runSCIP(), SCIP_DECL_EVENTCOPY(), and scip::ObjEventhdlr::SCIP_DECL_EVENTDELETE().

◆ SCIPfindObjEventhdlr()

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

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

Parameters

scip	SCIP data structure
name	name of event handler

Definition at line 239 of file objeventhdlr.cpp.

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

Referenced by scip::ObjEventhdlr::SCIP_DECL_EVENTDELETE().

◆ SCIPgetObjEventhdlr()

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

returns the eventhdlr object for the given event handler

Parameters

scip	SCIP data structure
eventhdlr	event handler

Definition at line 258 of file objeventhdlr.cpp.

References NULL, and SCIPeventhdlrGetData().

Referenced by scip::ObjEventhdlr::SCIP_DECL_EVENTDELETE().