Scippy

SCIP

Solving Constraint Integer Programs

Macros | Functions
pub_message.h File Reference
Public API of SCIP » Core API

Detailed Description

public methods for message output

Author
Tobias Achterberg
Stefan Heinz

Definition in file pub_message.h.

#include <stdarg.h>
#include <string.h>
#include "scip/def.h"
#include "scip/type_message.h"

Go to the source code of this file.

Macros

#define SCIP_THREADSAFE_MESSAGEHDLRS
 
#define SCIPerrorMessage
 
#define printErrorHeader   SCIPmessagePrintErrorHeader
 
#define printError   SCIPmessagePrintError
 
#define SCIPdebug(x)
 
#define SCIPdebugMessage   while( FALSE ) /*lint -e{530}*/ printf
 
#define SCIPdebugPrintf   while( FALSE ) /*lint -e{530}*/ printf
 
#define SCIPdebugPrintCons(x, y, z)
 
#define SCIPstatistic(x)
 
#define SCIPstatisticMessage   while( FALSE ) /*lint -e{530}*/ printf
 
#define SCIPstatisticPrintf   while( FALSE ) /*lint -e{530}*/ printf
 

Functions

SCIP_RETCODE SCIPmessagehdlrCreate (SCIP_MESSAGEHDLR **messagehdlr, SCIP_Bool bufferedoutput, const char *filename, SCIP_Bool quiet, SCIP_DECL_MESSAGEWARNING((*messagewarning)), SCIP_DECL_MESSAGEDIALOG((*messagedialog)), SCIP_DECL_MESSAGEINFO((*messageinfo)), SCIP_DECL_MESSAGEHDLRFREE((*messagehdlrfree)), SCIP_MESSAGEHDLRDATA *messagehdlrdata)
 
void SCIPmessagehdlrCapture (SCIP_MESSAGEHDLR *messagehdlr)
 
SCIP_RETCODE SCIPmessagehdlrRelease (SCIP_MESSAGEHDLR **messagehdlr)
 
SCIP_RETCODE SCIPmessagehdlrSetData (SCIP_MESSAGEHDLR *messagehdlr, SCIP_MESSAGEHDLRDATA *messagehdlrdata)
 
void SCIPmessagehdlrSetLogfile (SCIP_MESSAGEHDLR *messagehdlr, const char *filename)
 
void SCIPmessagehdlrSetQuiet (SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool quiet)
 
void SCIPmessagePrintInfo (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr,...)
 
void SCIPmessageVPrintInfo (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr, va_list ap)
 
void SCIPmessageFPrintInfo (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, const char *formatstr,...)
 
void SCIPmessageVFPrintInfo (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, const char *formatstr, va_list ap)
 
void SCIPmessagePrintWarning (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr,...)
 
void SCIPmessageVPrintWarning (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr, va_list ap)
 
void SCIPmessageFPrintWarning (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr,...)
 
void SCIPmessageVFPrintWarning (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr, va_list ap)
 
void SCIPmessagePrintDialog (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr,...)
 
void SCIPmessageVPrintDialog (SCIP_MESSAGEHDLR *messagehdlr, const char *formatstr, va_list ap)
 
void SCIPmessageFPrintDialog (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, const char *formatstr,...)
 
void SCIPmessageVFPrintDialog (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, const char *formatstr, va_list ap)
 
void SCIPmessagePrintVerbInfo (SCIP_MESSAGEHDLR *messagehdlr, SCIP_VERBLEVEL verblevel, SCIP_VERBLEVEL msgverblevel, const char *formatstr,...)
 
void SCIPmessageVPrintVerbInfo (SCIP_MESSAGEHDLR *messagehdlr, SCIP_VERBLEVEL verblevel, SCIP_VERBLEVEL msgverblevel, const char *formatstr, va_list ap)
 
void SCIPmessageFPrintVerbInfo (SCIP_MESSAGEHDLR *messagehdlr, SCIP_VERBLEVEL verblevel, SCIP_VERBLEVEL msgverblevel, FILE *file, const char *formatstr,...)
 
void SCIPmessageVFPrintVerbInfo (SCIP_MESSAGEHDLR *messagehdlr, SCIP_VERBLEVEL verblevel, SCIP_VERBLEVEL msgverblevel, FILE *file, const char *formatstr, va_list ap)
 
void SCIPmessagePrintErrorHeader (const char *sourcefile, int sourceline)
 
void SCIPmessagePrintError (const char *formatstr,...)
 
void SCIPmessageVPrintError (const char *formatstr, va_list ap)
 
void SCIPmessageSetErrorPrinting (SCIP_DECL_ERRORPRINTING((*errorPrinting)), void *data)
 
void SCIPmessageSetErrorPrintingDefault (void)
 
SCIP_MESSAGEHDLRDATA * SCIPmessagehdlrGetData (SCIP_MESSAGEHDLR *messagehdlr)
 
FILE * SCIPmessagehdlrGetLogfile (SCIP_MESSAGEHDLR *messagehdlr)
 
SCIP_Bool SCIPmessagehdlrIsQuiet (SCIP_MESSAGEHDLR *messagehdlr)
 

Macro Definition Documentation

◆ SCIP_THREADSAFE_MESSAGEHDLRS

#define SCIP_THREADSAFE_MESSAGEHDLRS

define to identify SCIP version with thread-safe version of message handlers

Definition at line 52 of file pub_message.h.

◆ SCIPerrorMessage

#define SCIPerrorMessage
Value:
SCIPmessagePrintErrorHeader(__FILENAME__, __LINE__), \
SCIPmessagePrintError
SCIPmessagePrintErrorHeader
void SCIPmessagePrintErrorHeader(const char *sourcefile, int sourceline)
Definition: message.c:777

prints an error message

Definition at line 64 of file pub_message.h.

◆ printErrorHeader

#define printErrorHeader   SCIPmessagePrintErrorHeader

define used in blockmemshell/memory.c

Definition at line 68 of file pub_message.h.

◆ printError

#define printError   SCIPmessagePrintError

Definition at line 69 of file pub_message.h.

◆ SCIPdebug

#define SCIPdebug (   x)

executes command only if SCIP_DEBUG flag is set

Definition at line 93 of file pub_message.h.

◆ SCIPdebugMessage

#define SCIPdebugMessage   while( FALSE ) /*lint -e{530}*/ printf

prints a debugging message if SCIP_DEBUG flag is set - also consider using SCIPdebugMsg/SCIPsetDebugMsg

Definition at line 96 of file pub_message.h.

◆ SCIPdebugPrintf

#define SCIPdebugPrintf   while( FALSE ) /*lint -e{530}*/ printf

executes printf command only if SCIP_DEBUG flag is set

Definition at line 99 of file pub_message.h.

◆ SCIPdebugPrintCons

#define SCIPdebugPrintCons (   x,
  y,
  z 
)

executes SCIPprintCons() and prints termination symbol ";\n" only if SCIP_DEBUG flag is set

Definition at line 102 of file pub_message.h.

◆ SCIPstatistic

#define SCIPstatistic (   x)

executes command only if SCIP_STATISTIC flag is set

Definition at line 120 of file pub_message.h.

◆ SCIPstatisticMessage

#define SCIPstatisticMessage   while( FALSE ) /*lint -e{530}*/ printf

prints a statistic message if SCIP_STATISTIC flag is set

Definition at line 123 of file pub_message.h.

◆ SCIPstatisticPrintf

#define SCIPstatisticPrintf   while( FALSE ) /*lint -e{530}*/ printf

executes printf command only if SCIP_STATISTIC flag is set

Definition at line 126 of file pub_message.h.

Function Documentation

◆ SCIPmessagehdlrCreate()

SCIP_RETCODE SCIPmessagehdlrCreate ( SCIP_MESSAGEHDLR **  messagehdlr,
SCIP_Bool  bufferedoutput,
const char *  filename,
SCIP_Bool  quiet,
SCIP_DECL_MESSAGEWARNING((*messagewarning))  ,
SCIP_DECL_MESSAGEDIALOG((*messagedialog))  ,
SCIP_DECL_MESSAGEINFO((*messageinfo))  ,
SCIP_DECL_MESSAGEHDLRFREE((*messagehdlrfree))  ,
SCIP_MESSAGEHDLRDATA *  messagehdlrdata 
)

Creates and captures a message handler which deals with warning, information, and dialog (interactive shell) methods.

Use SCIPsetMessagehdlr() to make SCIP aware of the created message handler.

Note
The message handler does not handle error messages. For that see SCIPmessageSetErrorPrinting()
Creating a message handler automatically captures it.

Creates and captures a message handler which deals with warning, information, and dialog (interactive shell) methods.

Note
The message handler does not handle error messages; see SCIPmessageSetErrorPrinting()
Parameters
messagehdlrpointer to store the message handler
bufferedoutputshould the output be buffered up to the next newline?
filenamename of log file, or NULL for no log
quietshould screen messages be suppressed?
messagehdlrdatamessage handler data

Definition at line 295 of file message.c.

References BMSallocMemory, BMSallocMemoryArray, messagehdlrOpenLogfile(), NULL, SCIP_ALLOC, SCIP_MAXSTRLEN, and SCIP_OKAY.

Referenced by SCIPcreateMessagehdlrDefault(), and SCIPcreateObjMessagehdlr().

◆ SCIPmessagehdlrCapture()

void SCIPmessagehdlrCapture ( SCIP_MESSAGEHDLR *  messagehdlr)

captures message handler

Parameters
messagehdlrmessage handler, or NULL

Definition at line 339 of file message.c.

References NULL, and SCIP_Messagehdlr::nuses.

Referenced by SCIPsetMessagehdlr().

◆ SCIPmessagehdlrRelease()

SCIP_RETCODE SCIPmessagehdlrRelease ( SCIP_MESSAGEHDLR **  messagehdlr)

releases message handler

Parameters
messagehdlrpointer to the message handler

Definition at line 348 of file message.c.

References messagehdlrFree(), NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPfree(), and SCIPsetMessagehdlr().

◆ SCIPmessagehdlrSetData()

SCIP_RETCODE SCIPmessagehdlrSetData ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_MESSAGEHDLRDATA *  messagehdlrdata 
)

sets the user data of the message handler

Parameters
messagehdlrmessage handler; must not be NULL
messagehdlrdatanew message handler data to attach to the handler

Definition at line 377 of file message.c.

References SCIP_Messagehdlr::messagehdlrdata, NULL, SCIP_INVALIDDATA, and SCIP_OKAY.

Referenced by SCIP_DECL_MESSAGEHDLRFREE().

◆ SCIPmessagehdlrSetLogfile()

void SCIPmessagehdlrSetLogfile ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  filename 
)

sets the log file name for the message handler

Parameters
messagehdlrmessage handler
filenamelog file name where to copy messages into, or NULL

Definition at line 393 of file message.c.

References SCIP_Messagehdlr::logfile, messagehdlrOpenLogfile(), and NULL.

Referenced by SCIPsetMessagehdlrLogfile().

◆ SCIPmessagehdlrSetQuiet()

void SCIPmessagehdlrSetQuiet ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_Bool  quiet 
)

sets the messages handler to be quiet

Parameters
messagehdlrmessage handler
quietshould screen messages be suppressed?

Definition at line 411 of file message.c.

References messagePrintDialog(), messagePrintInfo(), messagePrintWarning(), NULL, and SCIP_Messagehdlr::quiet.

Referenced by scipexamples::QueensSolver::QueensSolver(), SCIPparamsetWrite(), SCIPprintMIPStart(), SCIPprintSol(), and SCIPsetMessagehdlrQuiet().

◆ SCIPmessagePrintInfo()

void SCIPmessagePrintInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
  ... 
)

prints a message, acting like the printf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 594 of file message.c.

References NULL, and SCIPmessageVFPrintInfo().

Referenced by displayRelevantStats(), lpNumericalTroubleMessage(), printstr(), SCIP_DECL_CONSCHECK(), SCIPhashmapPrintStatistics(), SCIPhashsetPrintStatistics(), SCIPhashtablePrintStatistics(), SCIPmultihashPrintStatistics(), SCIPprintMemoryDiagnostic(), SCIPprobPrintPseudoSol(), SCIPsolCheck(), and SCIPsolCheckOrig().

◆ SCIPmessageVPrintInfo()

void SCIPmessageVPrintInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
va_list  ap 
)

prints a message, acting like the vprintf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
apvariable argument list

Definition at line 608 of file message.c.

References NULL, and SCIPmessageVFPrintInfo().

◆ SCIPmessageFPrintInfo()

void SCIPmessageFPrintInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
FILE *  file,
const char *  formatstr,
  ... 
)

prints a message into a file, acting like the fprintf() command

Parameters
messagehdlrmessage handler
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 618 of file message.c.

References SCIPmessageVFPrintInfo().

Referenced by consPrintConsSol(), paramWrite(), printBounds(), printDualSol(), printHolelist(), printTime(), runBenders(), SCIP_DECL_DIALOGEXEC(), SCIPaggrRowPrint(), SCIPcolPrint(), SCIPconsPrint(), SCIPdigraphPrint(), SCIPdigraphPrintComponents(), SCIPdispLongint(), SCIPdispPrintLine(), SCIPdispTime(), SCIPexprDismantle(), SCIPexprhdlrPrintExpr(), SCIPisDualSolAvailable(), SCIPlpWriteMip(), SCIPnlpWrite(), SCIPnlrowPrint(), SCIPparamsetSetToSubscipsOff(), SCIPparamsetWrite(), SCIPprintBendersStatistics(), SCIPprintBestSol(), SCIPprintBestTransSol(), SCIPprintBranchingStatistics(), SCIPprintBranchruleStatistics(), SCIPprintBuildOptions(), SCIPprintCompressionStatistics(), SCIPprintConcsolverStatistics(), SCIPprintConflictStatistics(), SCIPprintConstraintStatistics(), SCIPprintConstraintTimingStatistics(), SCIPprintCutselectorStatistics(), SCIPprintDebugMessage(), SCIPprintExpressionHandlerStatistics(), SCIPprintExternalCodes(), SCIPprintHeuristicStatistics(), SCIPprintLPSolutionQuality(), SCIPprintLPStatistics(), SCIPprintMIPStart(), SCIPprintNLPIStatistics(), SCIPprintNLPStatistics(), SCIPprintNodeRootPath(), SCIPprintOrigProblemStatistics(), SCIPprintPresolverStatistics(), SCIPprintPricerStatistics(), SCIPprintPropagatorStatistics(), SCIPprintReal(), SCIPprintRelaxatorStatistics(), SCIPprintReoptStatistics(), SCIPprintRootStatistics(), SCIPprintSeparatorStatistics(), SCIPprintSol(), SCIPprintSolutionStatistics(), SCIPprintStage(), SCIPprintStatus(), SCIPprintStatusStatistics(), SCIPprintTimingStatistics(), SCIPprintTransProblemStatistics(), SCIPprintTransSol(), SCIPprintTreeStatistics(), SCIPprintVersion(), SCIPprobPrintStatistics(), SCIPprofilePrint(), SCIPretcodePrint(), SCIProwPrint(), SCIPsolPrint(), SCIPsolPrintRay(), SCIPvarPrint(), SCIPvisualCutoffNode(), SCIPvisualFoundSolution(), SCIPvisualInit(), SCIPvisualLowerbound(), SCIPvisualNewChild(), SCIPvisualSolvedNode(), SCIPvisualUpdateChild(), SCIPvisualUpperbound(), SCIPwriteBnd(), and vbcSetColor().

◆ SCIPmessageVFPrintInfo()

void SCIPmessageVFPrintInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
FILE *  file,
const char *  formatstr,
va_list  ap 
)

prints a message into a file, acting like the vfprintf() command

Parameters
messagehdlrmessage handler
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
apvariable argument list

Definition at line 633 of file message.c.

References BMSallocMemorySize, BMSfreeMemory, messagePrintInfo(), NULL, SCIP_MAXSTRLEN, and va_copy.

Referenced by lpNumericalTroubleMessage(), SCIPdebugMessagePrint(), SCIPinfoMessage(), SCIPmessageFPrintInfo(), SCIPmessagePrintInfo(), SCIPmessageVPrintInfo(), and SCIPprintDebugMessage().

◆ SCIPmessagePrintWarning()

void SCIPmessagePrintWarning ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
  ... 
)

prints a warning message, acting like the printf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 427 of file message.c.

References SCIPmessageVFPrintWarning().

Referenced by adjustLPobjval(), computeRelIntPoint(), filterTRMrescode(), lpiGetBInvVec(), nlpSolve(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramSetReal(), primalAddSol(), restoreLPData(), SCIPconsParse(), SCIPexprComputeQuadraticCurvature(), SCIPlpiAddCols(), SCIPlpiAddRows(), SCIPlpiChgBounds(), SCIPlpiChgObj(), SCIPlpiChgSides(), SCIPlpiClearState(), SCIPlpiCreate(), SCIPlpiGetBInvRow(), SCIPlpiGetDualfarkas(), SCIPlpiGetPrimalRay(), SCIPlpiGetSol(), SCIPlpiLoadColLP(), SCIPlpiReadLP(), SCIPlpiScaleCol(), SCIPlpiScaleRow(), SCIPlpiSetNorms(), SCIPlpiSolveBarrier(), SCIPlpiStrongbranch(), SCIPlpiWriteLP(), SCIPlpiWriteState(), SCIPlpSolveAndEval(), SCIPlpWriteMip(), SCIPparamsetSet(), SCIPpriceLoop(), SolveWSimplex(), spxSolve(), varParse(), and writeProblem().

◆ SCIPmessageVPrintWarning()

void SCIPmessageVPrintWarning ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
va_list  ap 
)

prints a warning message, acting like the vprintf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
apvariable argument list

Definition at line 441 of file message.c.

References SCIPmessageVFPrintWarning().

◆ SCIPmessageFPrintWarning()

void SCIPmessageFPrintWarning ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
  ... 
)

prints a warning message into a file, acting like the fprintf() command

prints a warning message, acting like the fprintf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 451 of file message.c.

References SCIPmessageVFPrintWarning().

Referenced by SCIPprobFree().

◆ SCIPmessageVFPrintWarning()

void SCIPmessageVFPrintWarning ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
va_list  ap 
)

prints a warning message into a file, acting like the vfprintf() command

prints a warning message, acting like the vfprintf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
apvariable argument list

Definition at line 465 of file message.c.

References BMSallocMemorySize, BMSfreeMemory, messagePrintWarning(), NULL, SCIP_MAXSTRLEN, and va_copy.

Referenced by SCIPmessageFPrintWarning(), SCIPmessagePrintWarning(), SCIPmessageVPrintWarning(), and SCIPwarningMessage().

◆ SCIPmessagePrintDialog()

void SCIPmessagePrintDialog ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
  ... 
)

prints a dialog message that requests user interaction, acting like the printf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 510 of file message.c.

References NULL, and SCIPmessageVFPrintDialog().

◆ SCIPmessageVPrintDialog()

void SCIPmessageVPrintDialog ( SCIP_MESSAGEHDLR *  messagehdlr,
const char *  formatstr,
va_list  ap 
)

prints a dialog message that requests user interaction, acting like the vprintf() command

Parameters
messagehdlrmessage handler
formatstrformat string like in printf() function
apvariable argument list

Definition at line 524 of file message.c.

References NULL, and SCIPmessageVFPrintDialog().

◆ SCIPmessageFPrintDialog()

void SCIPmessageFPrintDialog ( SCIP_MESSAGEHDLR *  messagehdlr,
FILE *  file,
const char *  formatstr,
  ... 
)

prints a dialog message that requests user interaction into a file, acting like the fprintf() command

Parameters
messagehdlrmessage handler
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 534 of file message.c.

References SCIPmessageVFPrintDialog().

◆ SCIPmessageVFPrintDialog()

void SCIPmessageVFPrintDialog ( SCIP_MESSAGEHDLR *  messagehdlr,
FILE *  file,
const char *  formatstr,
va_list  ap 
)

prints a dialog message that requests user interaction into a file, acting like the vfprintf() command

Parameters
messagehdlrmessage handler
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
apvariable argument list

Definition at line 549 of file message.c.

References BMSallocMemorySize, BMSfreeMemory, messagePrintDialog(), NULL, SCIP_MAXSTRLEN, and va_copy.

Referenced by SCIPdialogMessage(), SCIPmessageFPrintDialog(), SCIPmessagePrintDialog(), and SCIPmessageVPrintDialog().

◆ SCIPmessagePrintVerbInfo()

void SCIPmessagePrintVerbInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_VERBLEVEL  verblevel,
SCIP_VERBLEVEL  msgverblevel,
const char *  formatstr,
  ... 
)

prints a message depending on the verbosity level, acting like the printf() command

Parameters
messagehdlrmessage handler
verblevelcurrent verbosity level
msgverblevelverbosity level of this message
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 678 of file message.c.

References NULL, and SCIPmessageVFPrintVerbInfo().

Referenced by compressReoptTree(), createMasterproblem(), createSubproblems(), enforceConstraints(), exitPresolve(), focusnodeToFork(), lpSolve(), presolve(), presolveRound(), priceAndCutLoop(), propAndSolve(), SCIPbendersExec(), SCIPlpCreate(), SCIPlpEndDive(), SCIPlpSolveAndEval(), SCIPpermuteProb(), SCIPpresolve(), SCIPreadProb(), SCIPsolve(), SCIPsolveCIP(), SCIPstatUpdateMemsaveMode(), SCIPtransformProb(), SCIPtreeEndProbing(), SCIPtreeSetNodesel(), SCIPvisualExit(), SCIPvisualInit(), and solveNode().

◆ SCIPmessageVPrintVerbInfo()

void SCIPmessageVPrintVerbInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_VERBLEVEL  verblevel,
SCIP_VERBLEVEL  msgverblevel,
const char *  formatstr,
va_list  ap 
)

prints a message depending on the verbosity level, acting like the vprintf() command

Parameters
messagehdlrmessage handler
verblevelcurrent verbosity level
msgverblevelverbosity level of this message
formatstrformat string like in printf() function
apvariable argument list

Definition at line 694 of file message.c.

References NULL, and SCIPmessageVFPrintVerbInfo().

◆ SCIPmessageFPrintVerbInfo()

void SCIPmessageFPrintVerbInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_VERBLEVEL  verblevel,
SCIP_VERBLEVEL  msgverblevel,
FILE *  file,
const char *  formatstr,
  ... 
)

prints a message into a file depending on the verbosity level, acting like the fprintf() command

Parameters
messagehdlrmessage handler
verblevelcurrent verbosity level
msgverblevelverbosity level of this message
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 706 of file message.c.

References SCIPmessageVFPrintVerbInfo().

Referenced by SCIPexprComputeQuadraticCurvature().

◆ SCIPmessageVFPrintVerbInfo()

void SCIPmessageVFPrintVerbInfo ( SCIP_MESSAGEHDLR *  messagehdlr,
SCIP_VERBLEVEL  verblevel,
SCIP_VERBLEVEL  msgverblevel,
FILE *  file,
const char *  formatstr,
va_list  ap 
)

prints a message into a file depending on the verbosity level, acting like the vfprintf() command

Parameters
messagehdlrmessage handler
verblevelcurrent verbosity level
msgverblevelverbosity level of this message
filefile stream to print into, or NULL for stdout
formatstrformat string like in printf() function
apvariable argument list

Definition at line 723 of file message.c.

References BMSallocMemorySize, BMSfreeMemory, messagePrintInfo(), NULL, SCIP_MAXSTRLEN, SCIP_VERBLEVEL_FULL, SCIP_VERBLEVEL_NONE, and va_copy.

Referenced by SCIPmessageFPrintVerbInfo(), SCIPmessagePrintVerbInfo(), SCIPmessageVPrintVerbInfo(), and SCIPverbMessage().

◆ SCIPmessagePrintErrorHeader()

void SCIPmessagePrintErrorHeader ( const char *  sourcefile,
int  sourceline 
)

prints the header with source file location for an error message using the static message handler

Parameters
sourcefilename of the source file that called the function
sourcelineline in the source file where the function was called

Definition at line 777 of file message.c.

References messagePrintError(), NULL, and SCIP_MAXSTRLEN.

◆ SCIPmessagePrintError()

void SCIPmessagePrintError ( const char *  formatstr,
  ... 
)

prints an error message, acting like the printf() command using the static message handler

prints a error message, acting like the printf() command

Parameters
formatstrformat string like in printf() function
...format arguments line in printf() function

Definition at line 791 of file message.c.

References SCIPmessageVPrintError().

Referenced by doConshdlrCreate(), doPresolCreate(), doPropCreate(), SCIPconshdlrSetPresol(), SCIPprintError(), SCIPprintSysError(), SCIPpropSetPresol(), and SCIPretcodePrintError().

◆ SCIPmessageVPrintError()

void SCIPmessageVPrintError ( const char *  formatstr,
va_list  ap 
)

prints an error message, acting like the vprintf() command using the static message handler

Parameters
formatstrformat string like in printf() function
apvariable argument list

Definition at line 804 of file message.c.

References BMSallocMemorySize, BMSfreeMemory, messagePrintError(), NULL, SCIP_MAXSTRLEN, and va_copy.

Referenced by SCIPmessagePrintError().

◆ SCIPmessageSetErrorPrinting()

void SCIPmessageSetErrorPrinting ( SCIP_DECL_ERRORPRINTING((*errorPrinting))  ,
void *  data 
)

Method to set the error printing method. Setting the error printing method to NULL will suspend all error methods.

Note
The error printing method is a static variable. This means that all occurring errors are handled via this method.

Method to set the error printing method. Setting the error printing method to NULL will suspend all error methods.

Note
The error printing method is static variable. That means all occurring errors are handled via that methods
Parameters
datadata pointer which will be passed to the error printing method, or NULL

Definition at line 851 of file message.c.

References staticErrorPrintingData.

Referenced by SCIPsetStaticErrorPrintingMessagehdlr().

◆ SCIPmessageSetErrorPrintingDefault()

void SCIPmessageSetErrorPrintingDefault ( void  )

Method to set the error printing method to default version prints everything the stderr.

Note
The error printing method is a static variable. This means that all occurring errors are handled via this method.

Definition at line 864 of file message.c.

References NULL, and staticErrorPrintingData.

◆ SCIPmessagehdlrGetData()

SCIP_MESSAGEHDLRDATA * SCIPmessagehdlrGetData ( SCIP_MESSAGEHDLR *  messagehdlr)

returns the user data of the message handler

Parameters
messagehdlrmessage handler

Definition at line 887 of file message.c.

References SCIP_Messagehdlr::messagehdlrdata, and NULL.

Referenced by SCIP_DECL_MESSAGEDIALOG(), SCIP_DECL_MESSAGEHDLRFREE(), SCIP_DECL_MESSAGEINFO(), SCIP_DECL_MESSAGEWARNING(), and SCIPgetObjMessagehdlr().

◆ SCIPmessagehdlrGetLogfile()

FILE * SCIPmessagehdlrGetLogfile ( SCIP_MESSAGEHDLR *  messagehdlr)

returns the log file or NULL for stdout

Parameters
messagehdlrmessage handler

Definition at line 899 of file message.c.

References SCIP_Messagehdlr::logfile, and NULL.

◆ SCIPmessagehdlrIsQuiet()

SCIP_Bool SCIPmessagehdlrIsQuiet ( SCIP_MESSAGEHDLR *  messagehdlr)

returns TRUE if the message handler is set to be quiet

Parameters
messagehdlrmessage handler

Definition at line 910 of file message.c.

References NULL, and SCIP_Messagehdlr::quiet.

Referenced by doCopy(), initConcsolver(), SCIPparamsetWrite(), SCIPprintMIPStart(), and SCIPprintSol().