objeventhdlr.h File Reference

Detailed Description

C++ wrapper for event handlers.

Author

Tobias Achterberg

Definition in file objeventhdlr.h.

#include <cstring>
#include <utility>
#include "scip/scip.h"
#include "objscip/objcloneable.h"

Go to the source code of this file.

Data Structures
class	scip::ObjEventhdlr
	C++ wrapper for event handlers. More...

Namespaces
namespace	scip

Functions
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

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

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

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

scip	SCIP data structure
name	name 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

scip	SCIP data structure
eventhdlr	event handler

Definition at line 267 of file objeventhdlr.cpp.

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