objdisp.cpp File Reference

Detailed Description

C++ wrapper for display column.

Author

Kati Wolter

Definition in file objdisp.cpp.

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

Go to the source code of this file.

Functions
static	SCIP_DECL_DISPCOPY (dispCopyObj)
static	SCIP_DECL_DISPFREE (dispFreeObj)
static	SCIP_DECL_DISPINIT (dispInitObj)
static	SCIP_DECL_DISPEXIT (dispExitObj)
static	SCIP_DECL_DISPINITSOL (dispInitsolObj)
static	SCIP_DECL_DISPEXITSOL (dispExitsolObj)
static	SCIP_DECL_DISPOUTPUT (dispOutputObj)
SCIP_RETCODE	SCIPincludeObjDisp (SCIP *scip, scip::ObjDisp *objdisp, SCIP_Bool deleteobject)
scip::ObjDisp *	SCIPfindObjDisp (SCIP *scip, const char *name)
scip::ObjDisp *	SCIPgetObjDisp (SCIP *scip, SCIP_DISP *disp)

Function Documentation

SCIP_DECL_DISPCOPY()

SCIP_DECL_DISPCOPY ( dispCopyObj )

static

copy method for display column plugins (called when SCIP copies plugins)

Definition at line 62 of file objdisp.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPdispGetData(), SCIPincludeObjDisp(), and TRUE.

SCIP_DECL_DISPFREE()

SCIP_DECL_DISPFREE ( dispFreeObj )

static

destructor of display column to free user data (called when SCIP is exiting)

Definition at line 87 of file objdisp.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPdispGetData(), and SCIPdispSetData().

SCIP_DECL_DISPINIT()

SCIP_DECL_DISPINIT ( dispInitObj )

static

initialization method of display column (called after problem was transformed)

Definition at line 113 of file objdisp.cpp.

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

SCIP_DECL_DISPEXIT()

SCIP_DECL_DISPEXIT ( dispExitObj )

static

deinitialization method of display column (called before transformed problem is freed)

Definition at line 131 of file objdisp.cpp.

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

SCIP_DECL_DISPINITSOL()

SCIP_DECL_DISPINITSOL ( dispInitsolObj )

static

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

Definition at line 148 of file objdisp.cpp.

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

SCIP_DECL_DISPEXITSOL()

SCIP_DECL_DISPEXITSOL ( dispExitsolObj )

static

solving process deinitialization method of display column (called before branch and bound process data is freed)

Definition at line 165 of file objdisp.cpp.

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

SCIP_DECL_DISPOUTPUT()

SCIP_DECL_DISPOUTPUT ( dispOutputObj )

static

output method of display column to output file stream 'file'

Definition at line 182 of file objdisp.cpp.

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

SCIPincludeObjDisp()

SCIP_RETCODE SCIPincludeObjDisp	(	SCIP *	scip,
		scip::ObjDisp *	objdisp,
		SCIP_Bool	deleteobject )

creates the display column for the given display column object and includes it in SCIP

creates the display column for the given display column 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) ); ... MyDisp* mydisp = new MyDisp(...); SCIP_CALL( SCIPincludeObjDisp(scip, &mydisp, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mydisp; // delete disp AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjDisp(scip, new MyDisp(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyDisp is called here

Parameters

scip	SCIP data structure
objdisp	display column object
deleteobject	should the display column object be deleted when display column is freed?

Definition at line 204 of file objdisp.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjDisp::scip_desc_, SCIP_DISPSTATUS_AUTO, scip::ObjDisp::scip_header_, scip::ObjDisp::scip_name_, SCIP_OKAY, scip::ObjDisp::scip_position_, scip::ObjDisp::scip_priority_, scip::ObjDisp::scip_stripline_, scip::ObjDisp::scip_width_, and SCIPincludeDisp().

Referenced by SCIP_DECL_DISPCOPY().

SCIPfindObjDisp()

scip::ObjDisp * SCIPfindObjDisp	(	SCIP *	scip,
		const char *	name )

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

Parameters

scip	SCIP data structure
name	name of display column

Definition at line 232 of file objdisp.cpp.

References assert(), NULL, SCIPdispGetData(), and SCIPfindDisp().

SCIPgetObjDisp()

scip::ObjDisp * SCIPgetObjDisp	(	SCIP *	scip,
		SCIP_DISP *	disp )

returns the display column object for the given display column

Parameters

scip	SCIP data structure
disp	display column

Definition at line 251 of file objdisp.cpp.

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