Scippy

SCIP

Solving Constraint Integer Programs

scip::ObjDialog Class Referenceabstract

Detailed Description

C++ wrapper for dialogs.

This class defines the interface for dialogs implemented in C++. Note that there is a pure virtual function (this function has to be implemented). This function is: scip_exec().

Definition at line 44 of file objdialog.h.

C++ wrapper for dialogs. More...

#include <objdialog.h>

Public Member Functions

 ObjDialog (SCIP *scip, const char *name, const char *desc, SCIP_Bool issubmenu)
 
virtual ~ObjDialog ()
 
virtual SCIP_DECL_DIALOGFREE (scip_free)
 
virtual SCIP_DECL_DIALOGDESC (scip_desc)
 
virtual SCIP_DECL_DIALOGEXEC (scip_exec)=0
 
- Public Member Functions inherited from scip::ObjCloneable
virtual ~ObjCloneable ()
 
virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
 
virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
 

Data Fields

SCIPscip_
 
char * scip_name_
 
char * scip_desc_
 
const SCIP_Bool scip_issubmenu_
 

Constructor & Destructor Documentation

◆ ObjDialog()

scip::ObjDialog::ObjDialog ( SCIP scip,
const char *  name,
const char *  desc,
SCIP_Bool  issubmenu 
)
inline

default constructor

Parameters
scipSCIP data structure
namename of the dialog
descdescription of the dialog
issubmenudefault for whether the dialog is a menu

Definition at line 62 of file objdialog.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

◆ ~ObjDialog()

virtual scip::ObjDialog::~ObjDialog ( )
inlinevirtual

destructor

Definition at line 79 of file objdialog.h.

References SCIPfreeMemoryArray.

Member Function Documentation

◆ SCIP_DECL_DIALOGFREE()

virtual scip::ObjDialog::SCIP_DECL_DIALOGFREE ( scip_free  )
inlinevirtual

destructor of dialog to free user data (called when SCIP is exiting)

See also
SCIP_DECL_DIALOGFREE(x) in type_dialog.h

Definition at line 91 of file objdialog.h.

References SCIP_OKAY.

◆ SCIP_DECL_DIALOGDESC()

virtual scip::ObjDialog::SCIP_DECL_DIALOGDESC ( scip_desc  )
inlinevirtual

description output method of dialog

See also
SCIP_DECL_DIALOGDESC(x) in type_dialog.h

Definition at line 100 of file objdialog.h.

References SCIP_Bool, SCIP_DECL_DIALOGEXEC(), SCIP_EXPORT, SCIP_OKAY, SCIPdialogMessage(), and SCIPincludeObjDialog().

◆ SCIP_DECL_DIALOGEXEC()

virtual scip::ObjDialog::SCIP_DECL_DIALOGEXEC ( scip_exec  )
pure virtual

execution method of dialog

See also
SCIP_DECL_DIALOGEXEC(x) in type_dialog.h

Referenced by SCIP_DECL_DIALOGDESC().

Field Documentation

◆ scip_

SCIP* scip::ObjDialog::scip_

SCIP data structure

Definition at line 50 of file objdialog.h.

◆ scip_name_

char* scip::ObjDialog::scip_name_

name of the dialog

Definition at line 53 of file objdialog.h.

Referenced by SCIPincludeObjDialog().

◆ scip_desc_

char* scip::ObjDialog::scip_desc_

description of the dialog

Definition at line 56 of file objdialog.h.

Referenced by SCIPincludeObjDialog().

◆ scip_issubmenu_

const SCIP_Bool scip::ObjDialog::scip_issubmenu_

default for whether the dialog is a menu

Definition at line 59 of file objdialog.h.

Referenced by SCIPincludeObjDialog().