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 53 of file objdisp.h.

C++ wrapper for display columns. More...

#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)
	ObjDisp (const ObjDisp &o)
	ObjDisp (ObjDisp &&o)
virtual	~ObjDisp ()
ObjDisp &	operator= (const ObjDisp &o)=delete
ObjDisp &	operator= (ObjDisp &&o)=delete
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 ()
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_
char *	scip_header_
const int	scip_width_
const int	scip_priority_
const int	scip_position_
const SCIP_Bool	scip_stripline_

Constructor & Destructor Documentation

ObjDisp() [1/3]

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 83 of file objdisp.h.

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

ObjDisp() [2/3]

scip::ObjDisp::ObjDisp ( const ObjDisp &  o )

inline

copy constructor

Definition at line 109 of file objdisp.h.

ObjDisp() [3/3]

scip::ObjDisp::ObjDisp ( ObjDisp &&  o )

inline

move constructor

Definition at line 116 of file objdisp.h.

References scip_desc_, scip_header_, and scip_name_.

~ObjDisp()

virtual scip::ObjDisp::~ObjDisp ( )

inlinevirtual

destructor

Definition at line 132 of file objdisp.h.

References scip_, scip_desc_, scip_header_, scip_name_, and SCIPfreeMemoryArray.

Member Function Documentation

operator=() [1/2]

ObjDisp & scip::ObjDisp::operator= ( const ObjDisp &  o )

delete

assignment of polymorphic classes causes slicing and is therefore disabled.

operator=() [2/2]

ObjDisp & scip::ObjDisp::operator= ( ObjDisp &&  o )

delete

assignment of polymorphic classes causes slicing and is therefore disabled.

SCIP_DECL_DISPFREE()

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 151 of file objdisp.h.

References SCIP_OKAY.

SCIP_DECL_DISPINIT()

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 160 of file objdisp.h.

References SCIP_OKAY.

SCIP_DECL_DISPEXIT()

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 169 of file objdisp.h.

References SCIP_OKAY.

SCIP_DECL_DISPINITSOL()

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 178 of file objdisp.h.

References SCIP_OKAY.

SCIP_DECL_DISPEXITSOL()

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 187 of file objdisp.h.

References SCIP_OKAY.

SCIP_DECL_DISPOUTPUT()

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

Field Documentation

scip_

SCIP* scip::ObjDisp::scip_

SCIP data structure

Definition at line 59 of file objdisp.h.

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

scip_name_

char* scip::ObjDisp::scip_name_

name of the display column

Definition at line 62 of file objdisp.h.

Referenced by ObjDisp(), SCIPincludeObjDisp(), and ~ObjDisp().

scip_desc_

char* scip::ObjDisp::scip_desc_

description of the display column

Definition at line 65 of file objdisp.h.

Referenced by ObjDisp(), SCIPincludeObjDisp(), and ~ObjDisp().

scip_header_

char* scip::ObjDisp::scip_header_

head line of the display column

Definition at line 68 of file objdisp.h.

Referenced by ObjDisp(), SCIPincludeObjDisp(), and ~ObjDisp().

scip_width_

const int scip::ObjDisp::scip_width_

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

Definition at line 71 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

scip_priority_

const int scip::ObjDisp::scip_priority_

priority of the display column

Definition at line 74 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

scip_position_

const int scip::ObjDisp::scip_position_

relative position of the display column

Definition at line 77 of file objdisp.h.

Referenced by SCIPincludeObjDisp().

scip_stripline_

const SCIP_Bool scip::ObjDisp::scip_stripline_

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

Definition at line 80 of file objdisp.h.

Referenced by SCIPincludeObjDisp().