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-2022 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 visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_reader.h
17  * @ingroup PUBLICCOREAPI
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 /**@addtogroup PublicReaderMethods
36  *
37  * @{
38  */
39 
40 /** gets user data of reader */
41 SCIP_EXPORT
43  SCIP_READER* reader /**< reader */
44  );
45 
46 /** sets user data of reader; user has to free old data in advance! */
47 SCIP_EXPORT
49  SCIP_READER* reader, /**< reader */
50  SCIP_READERDATA* readerdata /**< new reader user data */
51  );
52 
53 /** gets name of reader */
54 SCIP_EXPORT
55 const char* SCIPreaderGetName(
56  SCIP_READER* reader /**< reader */
57  );
58 
59 /** gets description of reader */
60 SCIP_EXPORT
61 const char* SCIPreaderGetDesc(
62  SCIP_READER* reader /**< reader */
63  );
64 
65 /** gets file extension of reader */
66 SCIP_EXPORT
67 const char* SCIPreaderGetExtension(
68  SCIP_READER* reader /**< reader */
69  );
70 
71 /** return whether the reader can read files */
72 SCIP_EXPORT
74  SCIP_READER* reader /**< reader */
75  );
76 
77 /** return whether the reader can write files */
78 SCIP_EXPORT
80  SCIP_READER* reader /**< reader */
81  );
82 
83 /** @} */
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif
SCIP_Bool SCIPreaderCanWrite(SCIP_READER *reader)
Definition: reader.c:588
const char * SCIPreaderGetName(SCIP_READER *reader)
Definition: reader.c:548
void SCIPreaderSetData(SCIP_READER *reader, SCIP_READERDATA *readerdata)
Definition: reader.c:493
SCIP_READERDATA * SCIPreaderGetData(SCIP_READER *reader)
Definition: reader.c:483
SCIP_Bool SCIPreaderCanRead(SCIP_READER *reader)
Definition: reader.c:578
struct SCIP_ReaderData SCIP_READERDATA
Definition: type_reader.h:44
#define SCIP_Bool
Definition: def.h:84
type definitions for input file readers
const char * SCIPreaderGetDesc(SCIP_READER *reader)
Definition: reader.c:558
common defines and data types used in all packages of SCIP
const char * SCIPreaderGetExtension(SCIP_READER *reader)
Definition: reader.c:568