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++.

• Instructions for implementing a file reader and writer
• List of available file readers and writers
• Corresponding C interface

Definition at line 42 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)
virtual	~ObjReader ()
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 ()
virtual	SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
virtual	SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)

Data Fields
SCIP *	scip_
char *	scip_name_
char *	scip_desc_
char *	scip_extension_

Constructor & Destructor Documentation

ObjReader()

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

inline

default constructor

Parameters

scip	SCIP data structure
name	name of file reader
desc	description of file reader
extension	file extension that reader processes

Definition at line 60 of file objreader.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

~ObjReader()

virtual scip::ObjReader::~ObjReader ( )

inlinevirtual

destructor

Definition at line 78 of file objreader.h.

References SCIPfreeMemoryArray.

Member Function Documentation

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, and ReaderMOP.

Definition at line 91 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, and ReaderMOP.

Definition at line 100 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 116 of file objreader.h.

References NULL, SCIP_Bool, SCIP_DIDNOTRUN, SCIP_EXPORT, SCIP_OKAY, SCIPfindObjReader(), SCIPgetObjReader(), and SCIPincludeObjReader().

Field Documentation

scip_

SCIP* scip::ObjReader::scip_

SCIP data structure

Definition at line 48 of file objreader.h.

scip_name_

char* scip::ObjReader::scip_name_

name of the file reader

Definition at line 51 of file objreader.h.

Referenced by SCIPincludeObjReader().

scip_desc_

char* scip::ObjReader::scip_desc_

description of the file reader

Definition at line 54 of file objreader.h.

Referenced by SCIPincludeObjReader().

scip_extension_

char* scip::ObjReader::scip_extension_

file extension that reader processes

Definition at line 57 of file objreader.h.

Referenced by SCIPincludeObjReader().