Scippy

SCIP

Solving Constraint Integer Programs

scip::ObjReader Class Reference

Detailed Description

C++ wrapper for file readers and writers.

This class defines the interface for file readers and writers implemented in C++.

Definition at line 52 of file objreader.h.

C++ wrapper for file readers and writers. More...

#include <objreader.h>

Public Member Functions

 ObjReader (SCIP *scip, const char *name, const char *desc, const char *extension)
 
 ObjReader (const ObjReader &o)
 
 ObjReader (ObjReader &&o)
 
virtual ~ObjReader ()
 
ObjReaderoperator= (const ObjReader &o)=delete
 
ObjReaderoperator= (ObjReader &&o)=delete
 
virtual SCIP_DECL_READERFREE (scip_free)
 
virtual SCIP_DECL_READERREAD (scip_read)
 
virtual SCIP_DECL_READERWRITE (scip_write)
 
- Public Member Functions inherited from scip::ObjCloneable
virtual ~ObjCloneable ()
 
ObjCloneableoperator= (const ObjCloneable &o)=delete
 
ObjCloneableoperator= (ObjCloneable &&o)=delete
 
virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
 
virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
 

Data Fields

SCIPscip_
 
char * scip_name_
 
char * scip_desc_
 
char * scip_extension_
 

Constructor & Destructor Documentation

◆ ObjReader() [1/3]

scip::ObjReader::ObjReader ( SCIP scip,
const char *  name,
const char *  desc,
const char *  extension 
)
inline

default constructor

Parameters
scipSCIP data structure
namename of file reader
descdescription of file reader
extensionfile extension that reader processes

Definition at line 70 of file objreader.h.

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

◆ ObjReader() [2/3]

scip::ObjReader::ObjReader ( const ObjReader o)
inline

copy constructor

Definition at line 88 of file objreader.h.

◆ ObjReader() [3/3]

scip::ObjReader::ObjReader ( ObjReader &&  o)
inline

move constructor

Definition at line 91 of file objreader.h.

References scip_desc_, scip_extension_, and scip_name_.

◆ ~ObjReader()

virtual scip::ObjReader::~ObjReader ( )
inlinevirtual

destructor

Definition at line 99 of file objreader.h.

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

Member Function Documentation

◆ operator=() [1/2]

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

assignment of polymorphic classes causes slicing and is therefore disabled.

◆ operator=() [2/2]

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

assignment of polymorphic classes causes slicing and is therefore disabled.

◆ SCIP_DECL_READERFREE()

virtual scip::ObjReader::SCIP_DECL_READERFREE ( scip_free  )
inlinevirtual

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

See also
SCIP_DECL_READERFREE(x) in type_reader.h

Reimplemented in tsp::ReaderTSP.

Definition at line 118 of file objreader.h.

References SCIP_OKAY.

◆ SCIP_DECL_READERREAD()

virtual scip::ObjReader::SCIP_DECL_READERREAD ( scip_read  )
inlinevirtual

problem reading method of reader

See also
SCIP_DECL_READERREAD(x) in type_reader.h

Reimplemented in tsp::ReaderTSP.

Definition at line 127 of file objreader.h.

References NULL, SCIP_DIDNOTRUN, and SCIP_OKAY.

◆ SCIP_DECL_READERWRITE()

virtual scip::ObjReader::SCIP_DECL_READERWRITE ( scip_write  )
inlinevirtual

problem writing method of reader; NOTE: if the parameter "genericnames" is TRUE, then SCIP already set all variable and constraint names to generic names; therefore, this method should always use SCIPvarGetName() and SCIPconsGetName();

See also
SCIP_DECL_READERWRITE(x) in type_reader.h

Reimplemented in tsp::ReaderTSP.

Definition at line 143 of file objreader.h.

References NULL, SCIP_DIDNOTRUN, and SCIP_OKAY.

Field Documentation

◆ scip_

SCIP* scip::ObjReader::scip_

SCIP data structure

Definition at line 58 of file objreader.h.

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

◆ scip_name_

char* scip::ObjReader::scip_name_

name of the file reader

Definition at line 61 of file objreader.h.

Referenced by ObjReader(), SCIPincludeObjReader(), and ~ObjReader().

◆ scip_desc_

char* scip::ObjReader::scip_desc_

description of the file reader

Definition at line 64 of file objreader.h.

Referenced by ObjReader(), SCIPincludeObjReader(), and ~ObjReader().

◆ scip_extension_

char* scip::ObjReader::scip_extension_

file extension that reader processes

Definition at line 67 of file objreader.h.

Referenced by ObjReader(), SCIPincludeObjReader(), and ~ObjReader().