Scippy

    SCIP

    Solving Constraint Integer Programs

    Public Member Functions | Data Fields
    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 53 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)
     
     ObjDialog (const ObjDialog &o)
     
     ObjDialog (ObjDialog &&o)
     
    virtual ~ObjDialog ()
     
    ObjDialog & operator= (const ObjDialog &o)=delete
     
    ObjDialog & operator= (ObjDialog &&o)=delete
     
    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 ()
     
    ObjCloneable & operator= (const ObjCloneable &o)=delete
     
    ObjCloneable & operator= (ObjCloneable &&o)=delete
     
    virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
     
    virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
     

    Data Fields

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

    Constructor & Destructor Documentation

    ◆ ObjDialog() [1/3]

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

    References scip_, SCIP_CALL_ABORT, scip_desc_, scip_name_, and SCIPduplicateMemoryArray.

    ◆ ObjDialog() [2/3]

    scip::ObjDialog::ObjDialog ( const ObjDialog &  o)
    		inline

    copy constructor

    Definition at line 88 of file objdialog.h.

    ◆ ObjDialog() [3/3]

    scip::ObjDialog::ObjDialog ( ObjDialog &&  o)
    		inline

    move constructor

    Definition at line 91 of file objdialog.h.

    References scip_desc_, and scip_name_.

    ◆ ~ObjDialog()

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

    destructor

    Definition at line 98 of file objdialog.h.

    References scip_, scip_desc_, scip_name_, and SCIPfreeMemoryArray.

    Member Function Documentation

    ◆ operator=() [1/2]

    ObjDialog & scip::ObjDialog::operator= ( const ObjDialog &  o)
    		delete

    assignment of polymorphic classes causes slicing and is therefore disabled.

    ◆ operator=() [2/2]

    ObjDialog & scip::ObjDialog::operator= ( ObjDialog &&  o)
    		delete

    assignment of polymorphic classes causes slicing and is therefore disabled.

    ◆ 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 116 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 125 of file objdialog.h.

    References scip_desc_, SCIP_OKAY, and SCIPdialogMessage().

    ◆ 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

    Field Documentation

    ◆ scip_

    SCIP* scip::ObjDialog::scip_

    SCIP data structure

    Definition at line 59 of file objdialog.h.

    Referenced by ObjDialog(), and ~ObjDialog().

    ◆ scip_name_

    char* scip::ObjDialog::scip_name_

    name of the dialog

    Definition at line 62 of file objdialog.h.

    Referenced by ObjDialog(), SCIPincludeObjDialog(), and ~ObjDialog().

    ◆ scip_desc_

    char* scip::ObjDialog::scip_desc_

    description of the dialog

    Definition at line 65 of file objdialog.h.

    Referenced by ObjDialog(), SCIP_DECL_DIALOGDESC(), SCIPincludeObjDialog(), and ~ObjDialog().

    ◆ scip_issubmenu_

    const SCIP_Bool scip::ObjDialog::scip_issubmenu_

    default for whether the dialog is a menu

    Definition at line 68 of file objdialog.h.

    Referenced by SCIPincludeObjDialog().