Scippy

SCIP

Solving Constraint Integer Programs

pub_reader.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2016 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_reader.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for input file readers
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_READER_H__
25 #define __SCIP_PUB_READER_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_reader.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /** gets user data of reader */
36 extern
38  SCIP_READER* reader /**< reader */
39  );
40 
41 /** sets user data of reader; user has to free old data in advance! */
42 extern
44  SCIP_READER* reader, /**< reader */
45  SCIP_READERDATA* readerdata /**< new reader user data */
46  );
47 
48 /** gets name of reader */
49 extern
50 const char* SCIPreaderGetName(
51  SCIP_READER* reader /**< reader */
52  );
53 
54 /** gets description of reader */
55 extern
56 const char* SCIPreaderGetDesc(
57  SCIP_READER* reader /**< reader */
58  );
59 
60 /** gets file extension of reader */
61 extern
62 const char* SCIPreaderGetExtension(
63  SCIP_READER* reader /**< reader */
64  );
65 
66 /** return whether the reader can read files */
67 extern
69  SCIP_READER* reader /**< reader */
70  );
71 
72 /** return whether the reader can write files */
73 extern
75  SCIP_READER* reader /**< reader */
76  );
77 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif
SCIP_Bool SCIPreaderCanWrite(SCIP_READER *reader)
Definition: reader.c:550
const char * SCIPreaderGetName(SCIP_READER *reader)
Definition: reader.c:510
const char * SCIPreaderGetDesc(SCIP_READER *reader)
Definition: reader.c:520
void SCIPreaderSetData(SCIP_READER *reader, SCIP_READERDATA *readerdata)
Definition: reader.c:455
struct SCIP_ReaderData SCIP_READERDATA
Definition: type_reader.h:37
#define SCIP_Bool
Definition: def.h:53
type definitions for input file readers
SCIP_READERDATA * SCIPreaderGetData(SCIP_READER *reader)
Definition: reader.c:445
common defines and data types used in all packages of SCIP
SCIP_Bool SCIPreaderCanRead(SCIP_READER *reader)
Definition: reader.c:540
const char * SCIPreaderGetExtension(SCIP_READER *reader)
Definition: reader.c:530