Scippy

SCIP

Solving Constraint Integer Programs

scip::ObjMessagehdlr Class Reference

Detailed Description

C++ wrapper for message handlers.

This class defines the interface for message handlers implemented in C++. Note that all functions are pure virtual (these functions have to be implemented).

Definition at line 39 of file objmessagehdlr.h.

C++ wrapper for message handlers. More...

#include <objmessagehdlr.h>

Public Member Functions

 ObjMessagehdlr (SCIP_Bool bufferedoutput)
 
virtual ~ObjMessagehdlr ()
 
virtual void scip_error (SCIP_MESSAGEHDLR *messagehdlr, FILE *file, const char *msg)
 
virtual SCIP_DECL_MESSAGEWARNING (scip_warning)
 
virtual SCIP_DECL_MESSAGEDIALOG (scip_dialog)
 
virtual SCIP_DECL_MESSAGEINFO (scip_info)
 
virtual SCIP_DECL_MESSAGEHDLRFREE (scip_free)
 

Data Fields

const SCIP_Bool scip_bufferedoutput_
 

Constructor & Destructor Documentation

◆ ObjMessagehdlr()

scip::ObjMessagehdlr::ObjMessagehdlr ( SCIP_Bool  bufferedoutput)
inlineexplicit

default constructor

Parameters
bufferedoutputshould the output be buffered up to the next newline?

Definition at line 46 of file objmessagehdlr.h.

◆ ~ObjMessagehdlr()

virtual scip::ObjMessagehdlr::~ObjMessagehdlr ( )
inlinevirtual

destructor

Definition at line 54 of file objmessagehdlr.h.

Member Function Documentation

◆ scip_error()

virtual void scip::ObjMessagehdlr::scip_error ( SCIP_MESSAGEHDLR messagehdlr,
FILE *  file,
const char *  msg 
)
inlinevirtual

error message print method of message handler

Note
This function can be activated by calling SCIPsetStaticErrorPrintingMessagehdlr().
See also
SCIP_DECL_ERRORPRINTING(x) in type_message.h
Parameters
messagehdlrthe message handler itself
filefile stream to print into (NULL for stderr)
msgstring to output into the file (or NULL to flush)

Definition at line 64 of file objmessagehdlr.h.

Referenced by SCIP_DECL_ERRORPRINTING().

◆ SCIP_DECL_MESSAGEWARNING()

virtual scip::ObjMessagehdlr::SCIP_DECL_MESSAGEWARNING ( scip_warning  )
inlinevirtual

warning message print method of message handler

See also
SCIP_DECL_MESSAGEWARNING(x) in type_message.h

Definition at line 77 of file objmessagehdlr.h.

◆ SCIP_DECL_MESSAGEDIALOG()

virtual scip::ObjMessagehdlr::SCIP_DECL_MESSAGEDIALOG ( scip_dialog  )
inlinevirtual

dialog message print method of message handler

See also
SCIP_DECL_MESSAGEDIALOG(x) in type_message.h

Definition at line 86 of file objmessagehdlr.h.

◆ SCIP_DECL_MESSAGEINFO()

virtual scip::ObjMessagehdlr::SCIP_DECL_MESSAGEINFO ( scip_info  )
inlinevirtual

info message print method of message handler

See also
SCIP_DECL_MESSAGEINFO(x) in type_message.h

Definition at line 95 of file objmessagehdlr.h.

◆ SCIP_DECL_MESSAGEHDLRFREE()

virtual scip::ObjMessagehdlr::SCIP_DECL_MESSAGEHDLRFREE ( scip_free  )
inlinevirtual

destructor of message handler to free message handler data

See also
SCIP_DECL_MESSAGEHDLRFREE(x) in type_message.h

Definition at line 104 of file objmessagehdlr.h.

References SCIP_Bool, SCIP_OKAY, SCIPcreateObjMessagehdlr(), SCIPgetObjMessagehdlr(), and SCIPsetStaticErrorPrintingMessagehdlr().

Field Documentation

◆ scip_bufferedoutput_

const SCIP_Bool scip::ObjMessagehdlr::scip_bufferedoutput_

should the output be buffered up to the next newline?

Definition at line 43 of file objmessagehdlr.h.

Referenced by SCIPcreateObjMessagehdlr().