scip::ObjDisp Class Reference

Detailed Description

C++ wrapper for display columns.

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

• Instructions for implementing a display column
• List of available display columns
  • Corresponding C interface

Definition at line 44 of file objdisp.h.

#include <objdisp.h>

Public Member Functions
	ObjDisp (SCIP *scip, const char *name, const char *desc, const char *header, int width, int priority, int position, SCIP_Bool stripline)
virtual	~ObjDisp ()
virtual	SCIP_DECL_DISPFREE (scip_free)
virtual	SCIP_DECL_DISPINIT (scip_init)
virtual	SCIP_DECL_DISPEXIT (scip_exit)
virtual	SCIP_DECL_DISPINITSOL (scip_initsol)
virtual	SCIP_DECL_DISPEXITSOL (scip_exitsol)
virtual	SCIP_DECL_DISPOUTPUT (scip_output)=0
Public Member Functions inherited from scip::ObjCloneable
virtual	~ObjCloneable ()
virtual	SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
virtual	SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)

Data Fields
SCIP *	scip_
char *	scip_name_
char *	scip_desc_
char *	scip_header_
const int	scip_width_
const int	scip_priority_
const int	scip_position_
const SCIP_Bool	scip_stripline_

Constructor & Destructor Documentation

scip::ObjDisp::ObjDisp ( SCIP *  scip, const char *  name, const char *  desc, const char *  header, int  width, int  priority, int  position, SCIP_Bool  stripline  )

inline

default constructor

Parameters

scip	SCIP data structure
name	name of display column
desc	description of display column
header	head line of display column
width	width of display column (no. of chars used)
priority	priority of display column
position	relative position of display column
stripline	should the column be separated with a line from its right neighbour?

Definition at line 74 of file objdisp.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

virtual scip::ObjDisp::~ObjDisp ( )

inlinevirtual

destructor

Definition at line 100 of file objdisp.h.

References SCIPfreeMemoryArray.

Member Function Documentation

virtual scip::ObjDisp::SCIP_DECL_DISPFREE ( scip_free  )

inlinevirtual

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

See also

SCIP_DECL_DISPFREE(x) in type_disp.h

Definition at line 113 of file objdisp.h.

References SCIP_OKAY.

virtual scip::ObjDisp::SCIP_DECL_DISPINIT ( scip_init  )

inlinevirtual

initialization method of display column (called after problem was transformed)

See also

SCIP_DECL_DISPINIT(x) in type_disp.h

Definition at line 122 of file objdisp.h.

References SCIP_OKAY.

virtual scip::ObjDisp::SCIP_DECL_DISPEXIT ( scip_exit  )

inlinevirtual

deinitialization method of display column (called before transformed problem is freed)

See also

SCIP_DECL_DISPEXIT(x) in type_disp.h

Definition at line 131 of file objdisp.h.

References SCIP_OKAY.

virtual scip::ObjDisp::SCIP_DECL_DISPINITSOL ( scip_initsol  )

inlinevirtual

solving process initialization method of display column (called when branch and bound process is about to begin)

See also

SCIP_DECL_DISPINITSOL(x) in type_disp.h

Definition at line 140 of file objdisp.h.

References SCIP_OKAY.

virtual scip::ObjDisp::SCIP_DECL_DISPEXITSOL ( scip_exitsol  )

inlinevirtual

solving process deinitialization method of display column (called before branch and bound process data is freed)

See also

SCIP_DECL_DISPEXITSOL(x) in type_disp.h

Definition at line 149 of file objdisp.h.

References SCIP_Bool, SCIP_DECL_DISPOUTPUT(), SCIP_OKAY, SCIPfindObjDisp(), SCIPgetObjDisp(), and SCIPincludeObjDisp().

virtual scip::ObjDisp::SCIP_DECL_DISPOUTPUT ( scip_output  )

pure virtual

output method of display column to output file stream 'file'

See also

SCIP_DECL_DISPOUTPUT(x) in type_disp.h

Referenced by SCIP_DECL_DISPEXITSOL().

Field Documentation

SCIP* scip::ObjDisp::scip_

SCIP data structure

Definition at line 50 of file objdisp.h.

char* scip::ObjDisp::scip_name_

name of the display column

Definition at line 53 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

char* scip::ObjDisp::scip_desc_

description of the display column

Definition at line 56 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

char* scip::ObjDisp::scip_header_

head line of the display column

Definition at line 59 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

const int scip::ObjDisp::scip_width_

width of the display column (no. of chars used)

Definition at line 62 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

const int scip::ObjDisp::scip_priority_

priority of the display column

Definition at line 65 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

const int scip::ObjDisp::scip_position_

relative position of the display column

Definition at line 68 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

const SCIP_Bool scip::ObjDisp::scip_stripline_

should the column be separated with a line from its right neighbour?

Definition at line 71 of file objdisp.h.

Referenced by SCIPincludeObjDisp().