Scippy

SCIP

Solving Constraint Integer Programs

Data Structure Index

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

Detailed Description

C++ wrapper for event handlers.

This class defines the interface for eventt 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 42 of file objeventhdlr.h.

#include <objeventhdlr.h>

Public Member Functions
	ObjEventhdlr (SCIP scip, const char name, const char *desc)

virtual	~ObjEventhdlr ()

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

virtual	SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)

virtual	SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)

Data Fields
SCIP *	scip_

char *	scip_name_

char *	scip_desc_

Constructor & Destructor Documentation

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

inline

default constructor

Parameters

scip	SCIP data structure
name	name of event handler
desc	description of event handler

Definition at line 57 of file objeventhdlr.h.

References scip_, SCIP_CALL_ABORT, scip_desc_, scip_name_, and SCIPduplicateMemoryArray.

virtual scip::ObjEventhdlr::~ObjEventhdlr ( )

inlinevirtual

destructor

Definition at line 72 of file objeventhdlr.h.

References scip_, scip_desc_, scip_name_, and SCIPfreeMemoryArray.

Member Function Documentation

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTFREE ( scip_free )

inlinevirtual

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

See Also: SCIP_DECL_EVENTFREE(x) in type_event.h

Definition at line 84 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTINIT ( scip_init )

inlinevirtual

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

See Also: SCIP_DECL_EVENTINIT(x) in type_event.h

Definition at line 93 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTEXIT ( scip_exit )

inlinevirtual

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

See Also: SCIP_DECL_EVENTEXIT(x) in type_event.h

Definition at line 102 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTINITSOL ( scip_initsol )

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

Definition at line 111 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTEXITSOL ( scip_exitsol )

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

Definition at line 120 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTDELETE ( scip_delete )

inlinevirtual

frees specific constraint data

See Also: SCIP_DECL_EVENTDELETE(x) in type_event.h

Definition at line 129 of file objeventhdlr.h.

References SCIP_OKAY.

virtual scip::ObjEventhdlr::SCIP_DECL_EVENTEXEC ( scip_exec )

pure virtual

execution method of event handler

See Also: SCIP_DECL_EVENTEXEC(x) in type_event.h

Field Documentation

SCIP* scip::ObjEventhdlr::scip_

SCIP data structure

Definition at line 48 of file objeventhdlr.h.

Referenced by ObjEventhdlr(), and ~ObjEventhdlr().

char* scip::ObjEventhdlr::scip_name_

name of the event handler

Definition at line 51 of file objeventhdlr.h.

Referenced by ObjEventhdlr(), SCIPincludeObjEventhdlr(), and ~ObjEventhdlr().

char* scip::ObjEventhdlr::scip_desc_

description of the event handler

Definition at line 54 of file objeventhdlr.h.

Referenced by ObjEventhdlr(), SCIPincludeObjEventhdlr(), and ~ObjEventhdlr().