Detailed Description
methods for the inclusion and access of display plugins
Function Documentation
◆ SCIPdispGetData()
SCIP_EXPORT SCIP_DISPDATA* SCIPdispGetData | ( | SCIP_DISP * | disp | ) |
gets user data of display column
- Parameters
-
disp display column
Definition at line 305 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()
SCIP_EXPORT 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 315 of file disp.c.
References SCIP_Disp::dispdata, and NULL.
Referenced by SCIP_DECL_DISPFREE(), SCIP_DECL_DISPINITSOL(), and SCIP_DECL_DISPOUTPUT().
◆ SCIPdispGetName()
SCIP_EXPORT const char* SCIPdispGetName | ( | SCIP_DISP * | disp | ) |
gets name of display column
- Parameters
-
disp display column
Definition at line 326 of file disp.c.
References SCIP_Disp::name, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DISPCOPY(), SCIP_DECL_DISPINITSOL(), SCIP_DECL_DISPOUTPUT(), SCIPdispCopyInclude(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPsetFindBranchrule().
◆ SCIPdispGetDesc()
SCIP_EXPORT const char* SCIPdispGetDesc | ( | SCIP_DISP * | disp | ) |
gets description of display column
- Parameters
-
disp display column
Definition at line 336 of file disp.c.
References SCIP_Disp::desc, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPdispGetHeader()
SCIP_EXPORT const char* SCIPdispGetHeader | ( | SCIP_DISP * | disp | ) |
gets head line of display column
- Parameters
-
disp display column
Definition at line 346 of file disp.c.
References SCIP_Disp::header, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdispGetWidth()
SCIP_EXPORT int SCIPdispGetWidth | ( | SCIP_DISP * | disp | ) |
gets width of display column
- Parameters
-
disp display column
Definition at line 356 of file disp.c.
References NULL, and SCIP_Disp::width.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdispGetPriority()
SCIP_EXPORT int SCIPdispGetPriority | ( | SCIP_DISP * | disp | ) |
gets priority of display column
- Parameters
-
disp display column
Definition at line 366 of file disp.c.
References NULL, and SCIP_Disp::priority.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdispGetPosition()
SCIP_EXPORT int SCIPdispGetPosition | ( | SCIP_DISP * | disp | ) |
gets position of display column
- Parameters
-
disp display column
Definition at line 376 of file disp.c.
References NULL, and SCIP_Disp::position.
Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPsetIncludeBranchrule().
◆ SCIPdispGetStatus()
SCIP_EXPORT SCIP_DISPSTATUS SCIPdispGetStatus | ( | SCIP_DISP * | disp | ) |
gets status of display column
- Parameters
-
disp display column
Definition at line 386 of file disp.c.
References SCIP_Disp::dispstatus, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdispIsInitialized()
SCIP_EXPORT SCIP_Bool SCIPdispIsInitialized | ( | SCIP_DISP * | disp | ) |
is display column initialized?
- Parameters
-
disp display column
Definition at line 396 of file disp.c.
References SCIP_Disp::initialized, and NULL.
Referenced by SCIPsetIncludeBranchrule().
◆ SCIPdispLongint()
SCIP_EXPORT 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 572 of file disp.c.
References MAXDECPOWER, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().
Referenced by runBenders(), SCIP_DECL_DISPOUTPUT(), and SCIPdispInt().
◆ SCIPdispInt()
SCIP_EXPORT 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 618 of file disp.c.
References SCIP_Longint, and SCIPdispLongint().
Referenced by runBenders(), and SCIP_DECL_DISPOUTPUT().
◆ SCIPdispTime()
SCIP_EXPORT 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 635 of file disp.c.
References MAXTIMEPOWER, REALABS, SCIP_Longint, SCIP_MAXSTRLEN, SCIPmessageFPrintInfo(), and SCIPsnprintf().
Referenced by runBenders(), and SCIP_DECL_DISPOUTPUT().
◆ SCIPincludeDisp()
SCIP_EXPORT 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?
Definition at line 46 of file scip_disp.c.
References FALSE, Scip::mem, Scip::messagehdlr, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPcheckStage(), SCIPdispCreate(), SCIPerrorMessage, SCIPfindDisp(), SCIPsetIncludeDisp(), Scip::set, SCIP_Mem::setmem, and TRUE.
Referenced by includeConshdlrCountsols(), SCIPincludeDispDefault(), SCIPincludeEventHdlrSolvingphase(), and SCIPincludeObjDisp().
◆ SCIPfindDisp()
SCIP_EXPORT SCIP_DISP* SCIPfindDisp | ( | SCIP * | scip, |
const char * | name | ||
) |
returns the display column of the given name, or NULL if not existing
- Parameters
-
scip SCIP data structure name name of display column
Definition at line 88 of file scip_disp.c.
References NULL, SCIPsetFindDisp(), and Scip::set.
Referenced by SCIP_DECL_DISPCOPY(), SCIPfindObjDisp(), SCIPincludeDisp(), and SCIPincludeDispDefault().
◆ SCIPgetDisps()
SCIP_EXPORT SCIP_DISP** SCIPgetDisps | ( | SCIP * | scip | ) |
returns the array of currently available display columns
- Parameters
-
scip SCIP data structure
Definition at line 101 of file scip_disp.c.
References SCIP_Set::disps, NULL, and Scip::set.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPgetNDisps()
SCIP_EXPORT int SCIPgetNDisps | ( | SCIP * | scip | ) |
returns the number of currently available display columns
- Parameters
-
scip SCIP data structure
Definition at line 112 of file scip_disp.c.
References SCIP_Set::ndisps, NULL, and Scip::set.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPautoselectDisps()
SCIP_EXPORT SCIP_RETCODE SCIPautoselectDisps | ( | SCIP * | scip | ) |
automatically selects display columns for being shown w.r.t. the display width parameter
- Parameters
-
scip SCIP data structure
Definition at line 123 of file scip_disp.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPdispAutoActivate(), and Scip::set.
Referenced by SCIP_DECL_PARAMCHGD(), and SCIPsyncstoreInit().
◆ SCIPchgDispMode()
SCIP_EXPORT void SCIPchgDispMode | ( | SCIP_DISP * | disp, |
SCIP_DISPMODE | mode | ||
) |
changes the display column mode
- Parameters
-
disp display column mode the display column mode
Definition at line 136 of file scip_disp.c.
References NULL, and SCIPdispChgMode().
Referenced by SCIPincludeDispDefault().