objdisp.h File Reference

Detailed Description

C++ wrapper for display columns.

Author

Kati Wolter

Definition in file objdisp.h.

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

Go to the source code of this file.

Data Structures
class	scip::ObjDisp
	C++ wrapper for display columns. More...

Namespaces
	scip

Functions
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

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

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

1. The user is resposible 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

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

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 195 of file objdisp.cpp.

References NULL, 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(), and scip::ObjDisp::SCIP_DECL_DISPEXITSOL().

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 223 of file objdisp.cpp.

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

Referenced by scip::ObjDisp::SCIP_DECL_DISPEXITSOL().

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 242 of file objdisp.cpp.

References NULL, and SCIPdispGetData().

Referenced by scip::ObjDisp::SCIP_DECL_DISPEXITSOL().