Detailed Description

methods for the inclusion and access of display plugins

Functions
SCIP_DISPDATA *	SCIPdispGetData (SCIP_DISP *disp)

void	SCIPdispSetData (SCIP_DISP disp, SCIP_DISPDATA dispdata)

const char *	SCIPdispGetName (SCIP_DISP *disp)

const char *	SCIPdispGetDesc (SCIP_DISP *disp)

const char *	SCIPdispGetHeader (SCIP_DISP *disp)

int	SCIPdispGetWidth (SCIP_DISP *disp)

int	SCIPdispGetPriority (SCIP_DISP *disp)

int	SCIPdispGetPosition (SCIP_DISP *disp)

SCIP_DISPSTATUS	SCIPdispGetStatus (SCIP_DISP *disp)

SCIP_Bool	SCIPdispIsInitialized (SCIP_DISP *disp)

void	SCIPdispLongint (SCIP_MESSAGEHDLR messagehdlr, FILE file, SCIP_Longint val, int width)

void	SCIPdispInt (SCIP_MESSAGEHDLR messagehdlr, FILE file, int val, int width)

void	SCIPdispTime (SCIP_MESSAGEHDLR messagehdlr, FILE file, SCIP_Real val, int width)

SCIP_RETCODE	SCIPincludeDisp (SCIP scip, const char name, const char desc, const char header, SCIP_DISPSTATUS dispstatus, SCIP_DECL_DISPCOPY((dispcopy)), SCIP_DECL_DISPFREE((dispfree)), SCIP_DECL_DISPINIT((dispinit)), SCIP_DECL_DISPEXIT((dispexit)), SCIP_DECL_DISPINITSOL((dispinitsol)), SCIP_DECL_DISPEXITSOL((dispexitsol)), SCIP_DECL_DISPOUTPUT((dispoutput)), SCIP_DISPDATA dispdata, int width, int priority, int position, SCIP_Bool stripline)

SCIP_DISP *	SCIPfindDisp (SCIP scip, const char name)

SCIP_DISP **	SCIPgetDisps (SCIP *scip)

int	SCIPgetNDisps (SCIP *scip)

SCIP_RETCODE	SCIPautoselectDisps (SCIP *scip)

void	SCIPchgDispMode (SCIP_DISP *disp, SCIP_DISPMODE mode)

Function Documentation

◆ SCIPdispGetData()

SCIP_DISPDATA* SCIPdispGetData ( SCIP_DISP * disp )

gets user data of display column

Parameters

disp	display column

Definition at line 262 of file disp.c.

References SCIP_Disp::dispdata, and NULL.

Referenced by SCIP_DECL_DISPCOPY(), SCIP_DECL_DISPEXIT(), SCIP_DECL_DISPEXITSOL(), SCIP_DECL_DISPFREE(), SCIP_DECL_DISPINIT(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIPfindObjDisp(), and SCIPgetObjDisp().

◆ SCIPdispSetData()

void SCIPdispSetData	(	SCIP_DISP *	disp,
		SCIP_DISPDATA *	dispdata
	)

sets user data of display column; user has to free old data in advance!

Parameters

disp	display column
dispdata	new display column user data

Definition at line 272 of file disp.c.

References SCIP_Disp::dispdata, and NULL.

Referenced by SCIP_DECL_DISPFREE(), SCIP_DECL_DISPINITSOL(), and SCIP_DECL_DISPOUTPUT().

◆ SCIPdispGetName()

const char* SCIPdispGetName ( SCIP_DISP * disp )

gets name of display column

Parameters

disp	display column

Definition at line 283 of file disp.c.

References SCIP_Disp::name, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIPdispCopyInclude(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPdispGetDesc()

const char* SCIPdispGetDesc ( SCIP_DISP * disp )

gets description of display column

Parameters

disp	display column

Definition at line 293 of file disp.c.

References SCIP_Disp::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().

◆ SCIPdispGetHeader()

const char* SCIPdispGetHeader ( SCIP_DISP * disp )

gets head line of display column

Parameters

disp	display column

Definition at line 303 of file disp.c.

References SCIP_Disp::header, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetWidth()

int SCIPdispGetWidth ( SCIP_DISP * disp )

gets width of display column

Parameters

disp	display column

Definition at line 313 of file disp.c.

References NULL, and SCIP_Disp::width.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetPriority()

int SCIPdispGetPriority ( SCIP_DISP * disp )

gets priority of display column

Parameters

disp	display column

Definition at line 323 of file disp.c.

References NULL, and SCIP_Disp::priority.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispGetPosition()

int SCIPdispGetPosition ( SCIP_DISP * disp )

gets position of display column

Parameters

disp	display column

Definition at line 333 of file disp.c.

References NULL, and SCIP_Disp::position.

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPsetIncludeBranchrule().

◆ SCIPdispGetStatus()

SCIP_DISPSTATUS SCIPdispGetStatus ( SCIP_DISP * disp )

gets status of display column

Parameters

disp	display column

Definition at line 343 of file disp.c.

References SCIP_Disp::dispstatus, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

◆ SCIPdispIsInitialized()

SCIP_Bool SCIPdispIsInitialized ( SCIP_DISP * disp )

is display column initialized?

Parameters

disp	display column

Definition at line 353 of file disp.c.

References SCIP_Disp::initialized, and NULL.

Referenced by SCIPsetIncludeBranchrule().

◆ SCIPdispLongint()

void SCIPdispLongint	(	SCIP_MESSAGEHDLR *	messagehdlr,
		FILE *	file,
		SCIP_Longint	val,
		int	width
	)

displays a long integer in decimal form fitting in a given width

Parameters

messagehdlr	message handler
file	output stream
val	value to display
width	width to fit into

Definition at line 529 of file disp.c.

References MAXDECPOWER, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().

Referenced by SCIP_DECL_DISPOUTPUT(), and SCIPdispInt().

◆ SCIPdispInt()

void SCIPdispInt	(	SCIP_MESSAGEHDLR *	messagehdlr,
		FILE *	file,
		int	val,
		int	width
	)

displays an integer in decimal form fitting in a given width

Parameters

messagehdlr	message handler
file	output stream
val	value to display
width	width to fit into

Definition at line 575 of file disp.c.

References SCIP_Longint, and SCIPdispLongint().

Referenced by SCIP_DECL_DISPOUTPUT().

◆ SCIPdispTime()

void SCIPdispTime	(	SCIP_MESSAGEHDLR *	messagehdlr,
		FILE *	file,
		SCIP_Real	val,
		int	width
	)

displays a time value fitting in a given width

Parameters

messagehdlr	message handler
file	output stream
val	value in seconds to display
width	width to fit into

Definition at line 592 of file disp.c.

References MAXTIMEPOWER, REALABS, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().

Referenced by SCIP_DECL_DISPOUTPUT().

◆ SCIPincludeDisp()

SCIP_RETCODE SCIPincludeDisp	(	SCIP *	scip,
		const char *	name,
		const char *	desc,
		const char *	header,
		SCIP_DISPSTATUS	dispstatus,
		SCIP_DECL_DISPCOPY((*dispcopy))	,
		SCIP_DECL_DISPFREE((*dispfree))	,
		SCIP_DECL_DISPINIT((*dispinit))	,
		SCIP_DECL_DISPEXIT((*dispexit))	,
		SCIP_DECL_DISPINITSOL((*dispinitsol))	,
		SCIP_DECL_DISPEXITSOL((*dispexitsol))	,
		SCIP_DECL_DISPOUTPUT((*dispoutput))	,
		SCIP_DISPDATA *	dispdata,
		int	width,
		int	priority,
		int	position,
		SCIP_Bool	stripline
	)

creates a display column and includes it in SCIP

Parameters

scip	SCIP data structure
name	name of display column
desc	description of display column
header	head line of display column
dispstatus	display activation status of display column
dispdata	display column data
width	width of display column (no. of chars used)
priority	priority of display column
position	relative position of display column
stripline	should the column be separated with a line from its right neighbor?