objdialog.cpp File Reference

Detailed Description

C++ wrapper for dialogs.

Author

Kati Wolter

Definition in file objdialog.cpp.

#include <cassert>
#include "objdialog.h"

Go to the source code of this file.

Functions
static	SCIP_DECL_DIALOGCOPY (dialogCopyObj)
static	SCIP_DECL_DIALOGFREE (dialogFreeObj)
static	SCIP_DECL_DIALOGDESC (dialogDescObj)
static	SCIP_DECL_DIALOGEXEC (dialogExecObj)
SCIP_RETCODE	SCIPincludeObjDialog (SCIP *scip, scip::ObjDialog *objdialog, SCIP_Bool deleteobject)

Function Documentation

SCIP_DECL_DIALOGCOPY()

SCIP_DECL_DIALOGCOPY ( dialogCopyObj )

static

copy method for dialog plugins (called when SCIP copies plugins)

Definition at line 62 of file objdialog.cpp.

References assert(), SCIP_CALL, SCIP_OKAY, SCIPdialogGetData(), SCIPincludeObjDialog(), and TRUE.

SCIP_DECL_DIALOGFREE()

SCIP_DECL_DIALOGFREE ( dialogFreeObj )

static

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

Definition at line 87 of file objdialog.cpp.

References assert(), SCIP_CALL, SCIP_OKAY, SCIPdialogGetData(), and SCIPdialogSetData().

SCIP_DECL_DIALOGDESC()

SCIP_DECL_DIALOGDESC ( dialogDescObj )

static

description output method of dialog

Definition at line 113 of file objdialog.cpp.

References assert(), SCIP_CALL, SCIP_OKAY, and SCIPdialogGetData().

SCIP_DECL_DIALOGEXEC()

SCIP_DECL_DIALOGEXEC ( dialogExecObj )

static

execution method of dialog

Definition at line 130 of file objdialog.cpp.

References assert(), SCIP_CALL, SCIP_OKAY, and SCIPdialogGetData().

SCIPincludeObjDialog()

SCIP_RETCODE SCIPincludeObjDialog	(	SCIP *	scip,
		scip::ObjDialog *	objdialog,
		SCIP_Bool	deleteobject )

creates the dialog for the given dialog object and includes it in SCIP

creates the dialog for the given dialog object and includes it in SCIP

The method should be called in one of the following ways:

1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyDialog* mydialog = new MyDialog(...); SCIP_CALL( SCIPincludeObjDialog(scip, &mydialog, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mydialog; // delete dialog AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjDialog(scip, new MyDialog(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyDialog is called here

Parameters

scip	SCIP data structure
objdialog	dialog object
deleteobject	should the dialog object be deleted when dialog is freed?

Definition at line 152 of file objdialog.cpp.

References assert(), SCIP_Bool, SCIP_CALL, scip::ObjDialog::scip_desc_, scip::ObjDialog::scip_issubmenu_, scip::ObjDialog::scip_name_, SCIP_OKAY, SCIPaddDialogEntry(), SCIPdialogHasEntry(), SCIPgetRootDialog(), SCIPincludeDialog(), and SCIPreleaseDialog().

Referenced by SCIP_DECL_DIALOGCOPY().