Scippy

SCIP

Solving Constraint Integer Programs

Macros | Typedefs | Enumerations
type_message.h File Reference
Type Definitions

Detailed Description

type definitions for message output methods

Author
Tobias Achterberg

This file defines the interface for message handlers implemented in C.

Definition in file type_message.h.

#include <stdio.h>

Go to the source code of this file.

Macros

#define SCIP_DECL_MESSAGEOUTPUTFUNC(x)   void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)
 
#define SCIP_DECL_ERRORPRINTING(x)   void x (const char* msg, void* data)
 
#define SCIP_DECL_MESSAGEWARNING(x)   void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)
 
#define SCIP_DECL_MESSAGEDIALOG(x)   void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)
 
#define SCIP_DECL_MESSAGEINFO(x)   void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)
 
#define SCIP_DECL_MESSAGEHDLRFREE(x)   SCIP_RETCODE x (SCIP_MESSAGEHDLR* messagehdlr)
 

Typedefs

typedef enum SCIP_VerbLevel SCIP_VERBLEVEL
 
typedef struct SCIP_Messagehdlr SCIP_MESSAGEHDLR
 
typedef struct SCIP_MessagehdlrData SCIP_MESSAGEHDLRDATA
 

Enumerations

enum  SCIP_VerbLevel {
  SCIP_VERBLEVEL_NONE = 0,
  SCIP_VERBLEVEL_DIALOG = 1,
  SCIP_VERBLEVEL_MINIMAL = 2,
  SCIP_VERBLEVEL_NORMAL = 3,
  SCIP_VERBLEVEL_HIGH = 4,
  SCIP_VERBLEVEL_FULL = 5
}
 

Macro Definition Documentation

#define SCIP_DECL_MESSAGEOUTPUTFUNC (   x)    void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)

generic messagehandler output function

Should be equal to SCIP_DECL_MESSAGEWARNING, SCIP_DECL_MESSAGEDIALOG, and SCIP_DECL_MESSAGEINFO

Definition at line 57 of file type_message.h.

#define SCIP_DECL_ERRORPRINTING (   x)    void x (const char* msg, void* data)

error message print method

This method is invoked, if SCIP wants to display an error message to the screen or a file

Note
This function is independent of any message handler

input:

  • msg : string to output into the file (or NULL to flush)
  • data : data pointer

Definition at line 70 of file type_message.h.

#define SCIP_DECL_MESSAGEWARNING (   x)    void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)

warning message print method of message handler

This method is invoked, if SCIP wants to display a warning message to the screen or a file

input:

  • messagehdlr : the message handler itself
  • file : file stream to print into
  • msg : string to output into the file (or NULL to flush)

Definition at line 81 of file type_message.h.

#define SCIP_DECL_MESSAGEDIALOG (   x)    void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)

dialog message print method of message handler

This method is invoked, if SCIP wants to display a dialog message to the screen or a file

input:

  • messagehdlr : the message handler itself
  • file : file stream to print into
  • msg : string to output into the file (or NULL to flush)

Definition at line 92 of file type_message.h.

#define SCIP_DECL_MESSAGEINFO (   x)    void x (SCIP_MESSAGEHDLR* messagehdlr, FILE* file, const char* msg)

info message print method of message handler

This method is invoked, if SCIP wants to display an information message to the screen or a file

input:

  • messagehdlr : the message handler itself
  • file : file stream to print into
  • msg : string to output into the file (or NULL to flush)

Definition at line 103 of file type_message.h.

#define SCIP_DECL_MESSAGEHDLRFREE (   x)    SCIP_RETCODE x (SCIP_MESSAGEHDLR* messagehdlr)

destructor of message handler to free message handler data

This method is invoked, if SCIP wants to display an information message to the screen or a file

input:

  • messagehdlr : the message handler itself

Definition at line 112 of file type_message.h.

Typedef Documentation

typedef enum SCIP_VerbLevel SCIP_VERBLEVEL

Definition at line 48 of file type_message.h.

typedef struct SCIP_Messagehdlr SCIP_MESSAGEHDLR

message handler

Definition at line 50 of file type_message.h.

typedef struct SCIP_MessagehdlrData SCIP_MESSAGEHDLRDATA

message handler data

Definition at line 51 of file type_message.h.

Enumeration Type Documentation

enum SCIP_VerbLevel

verbosity levels of output

Enumerator:
SCIP_VERBLEVEL_NONE 

only error and warning messages are displayed

SCIP_VERBLEVEL_DIALOG 

only interactive dialogs, errors, and warnings are displayed

SCIP_VERBLEVEL_MINIMAL 

only important messages are displayed

SCIP_VERBLEVEL_NORMAL 

standard messages are displayed

SCIP_VERBLEVEL_HIGH 

a lot of information is displayed

SCIP_VERBLEVEL_FULL 

all messages are displayed

Definition at line 39 of file type_message.h.