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 scip_disp.h 26 * @ingroup PUBLICCOREAPI 27 * @brief public methods for display handler plugins 28 * @author Tobias Achterberg 29 * @author Timo Berthold 30 * @author Thorsten Koch 31 * @author Alexander Martin 32 * @author Marc Pfetsch 33 * @author Kati Wolter 34 * @author Gregor Hendel 35 * @author Leona Gottwald 36 */ 37 38 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/ 39 40 #ifndef __SCIP_SCIP_DISP_H__ 41 #define __SCIP_SCIP_DISP_H__ 42 43 44 #include "scip/def.h" 45 #include "scip/type_disp.h" 46 #include "scip/type_retcode.h" 47 #include "scip/type_scip.h" 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /**@addtogroup PublicDisplayMethods 54 * 55 * @{ 56 */ 57 58 /** creates a display column and includes it in SCIP */ 59 SCIP_EXPORT 60 SCIP_RETCODE SCIPincludeDisp( 61 SCIP* scip, /**< SCIP data structure */ 62 const char* name, /**< name of display column */ 63 const char* desc, /**< description of display column */ 64 const char* header, /**< head line of display column */ 65 SCIP_DISPSTATUS dispstatus, /**< display activation status of display column */ 66 SCIP_DECL_DISPCOPY ((*dispcopy)), /**< copy method of display column or NULL if you don't want to copy your plugin into sub-SCIPs */ 67 SCIP_DECL_DISPFREE ((*dispfree)), /**< destructor of display column */ 68 SCIP_DECL_DISPINIT ((*dispinit)), /**< initialize display column */ 69 SCIP_DECL_DISPEXIT ((*dispexit)), /**< deinitialize display column */ 70 SCIP_DECL_DISPINITSOL ((*dispinitsol)), /**< solving process initialization method of display column */ 71 SCIP_DECL_DISPEXITSOL ((*dispexitsol)), /**< solving process deinitialization method of display column */ 72 SCIP_DECL_DISPOUTPUT ((*dispoutput)), /**< output method */ 73 SCIP_DISPDATA* dispdata, /**< display column data */ 74 int width, /**< width of display column (no. of chars used) */ 75 int priority, /**< priority of display column */ 76 int position, /**< relative position of display column */ 77 SCIP_Bool stripline /**< should the column be separated with a line from its right neighbor? */ 78 ); 79 80 /** returns the display column of the given name, or NULL if not existing */ 81 SCIP_EXPORT 82 SCIP_DISP* SCIPfindDisp( 83 SCIP* scip, /**< SCIP data structure */ 84 const char* name /**< name of display column */ 85 ); 86 87 /** returns the array of currently available display columns */ 88 SCIP_EXPORT 89 SCIP_DISP** SCIPgetDisps( 90 SCIP* scip /**< SCIP data structure */ 91 ); 92 93 /** returns the number of currently available display columns */ 94 SCIP_EXPORT 95 int SCIPgetNDisps( 96 SCIP* scip /**< SCIP data structure */ 97 ); 98 99 /** automatically selects display columns for being shown w.r.t. the display width parameter */ 100 SCIP_EXPORT 101 SCIP_RETCODE SCIPautoselectDisps( 102 SCIP* scip /**< SCIP data structure */ 103 ); 104 105 /** changes the display column mode */ 106 SCIP_EXPORT 107 void SCIPchgDispMode( 108 SCIP_DISP* disp, /**< display column */ 109 SCIP_DISPMODE mode /**< the display column mode */ 110 ); 111 112 /** @} */ 113 114 #ifdef __cplusplus 115 } 116 #endif 117 118 #endif 119