1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 2 /* */ 3 /* This file is part of the program and library */ 4 /* SCIP --- Solving Constraint Integer Programs */ 5 /* */ 6 /* Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB) */ 7 /* */ 8 /* Licensed under the Apache License, Version 2.0 (the "License"); */ 9 /* you may not use this file except in compliance with the License. */ 10 /* You may obtain a copy of the License at */ 11 /* */ 12 /* http://www.apache.org/licenses/LICENSE-2.0 */ 13 /* */ 14 /* Unless required by applicable law or agreed to in writing, software */ 15 /* distributed under the License is distributed on an "AS IS" BASIS, */ 16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */ 17 /* See the License for the specific language governing permissions and */ 18 /* limitations under the License. */ 19 /* */ 20 /* You should have received a copy of the Apache-2.0 license */ 21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */ 22 /* */ 23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 24 25 /**@file pub_reader.h 26 * @ingroup PUBLICCOREAPI 27 * @brief public methods for input file readers 28 * @author Tobias Achterberg 29 */ 30 31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 32 33 #ifndef __SCIP_PUB_READER_H__ 34 #define __SCIP_PUB_READER_H__ 35 36 37 #include "scip/def.h" 38 #include "scip/type_reader.h" 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /**@addtogroup PublicReaderMethods 45 * 46 * @{ 47 */ 48 49 /** gets user data of reader */ 50 SCIP_EXPORT 51 SCIP_READERDATA* SCIPreaderGetData( 52 SCIP_READER* reader /**< reader */ 53 ); 54 55 /** sets user data of reader; user has to free old data in advance! */ 56 SCIP_EXPORT 57 void SCIPreaderSetData( 58 SCIP_READER* reader, /**< reader */ 59 SCIP_READERDATA* readerdata /**< new reader user data */ 60 ); 61 62 /** gets name of reader */ 63 SCIP_EXPORT 64 const char* SCIPreaderGetName( 65 SCIP_READER* reader /**< reader */ 66 ); 67 68 /** gets description of reader */ 69 SCIP_EXPORT 70 const char* SCIPreaderGetDesc( 71 SCIP_READER* reader /**< reader */ 72 ); 73 74 /** gets file extension of reader */ 75 SCIP_EXPORT 76 const char* SCIPreaderGetExtension( 77 SCIP_READER* reader /**< reader */ 78 ); 79 80 /** return whether the reader can read files */ 81 SCIP_EXPORT 82 SCIP_Bool SCIPreaderCanRead( 83 SCIP_READER* reader /**< reader */ 84 ); 85 86 /** return whether the reader can write files */ 87 SCIP_EXPORT 88 SCIP_Bool SCIPreaderCanWrite( 89 SCIP_READER* reader /**< reader */ 90 ); 91 92 /** @} */ 93 94 #ifdef __cplusplus 95 } 96 #endif 97 98 #endif 99