gcg::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 53 of file objdialog.h.

#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 Attributes

SCIP * scip_
 
char * scip_name_
 
char * scip_desc_
 
const SCIP_Bool scip_issubmenu_
 

Constructor & Destructor Documentation

gcg::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 71 of file objdialog.h.

virtual gcg::ObjDialog::~ObjDialog ( )
inlinevirtual

destructor

Definition at line 88 of file objdialog.h.

Member Function Documentation

virtual gcg::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 110 of file objdialog.h.

References SCIP_DECL_DIALOGEXEC(), and SCIPincludeObjDialog().

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

execution method of dialog

See also
SCIP_DECL_DIALOGEXEC(x) in type_dialog.h

Implemented in gcg::DialogWriteGraphs< T, G >, gcg::DialogReadGraphs< T, G >, gcg::DialogReadPartition, gcg::DialogWriteGraph, and gcg::DialogGraph.

Referenced by SCIP_DECL_DIALOGDESC().

virtual gcg::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 101 of file objdialog.h.

Member Data Documentation

SCIP* gcg::ObjDialog::scip_

SCIP data structure

Definition at line 59 of file objdialog.h.

char* gcg::ObjDialog::scip_desc_

description of the dialog

Definition at line 65 of file objdialog.h.

Referenced by SCIPincludeObjDialog().

const SCIP_Bool gcg::ObjDialog::scip_issubmenu_

default for whether the dialog is a menu

Definition at line 68 of file objdialog.h.

Referenced by SCIPincludeObjDialog().

char* gcg::ObjDialog::scip_name_

name of the dialog

Definition at line 62 of file objdialog.h.

Referenced by SCIPincludeObjDialog().