Scippy

SCIP

Solving Constraint Integer Programs

objcloneable.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-2024 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 objcloneable.h
26  * @brief definition of base class for all clonable classes
27  * @author Michael Winkler
28  */
29 
30 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
31 
32 #ifndef __SCIP_OBJCLONEABLE_H__
33 #define __SCIP_OBJCLONEABLE_H__
34 
35 #include "scip/def.h"
36 #include "scip/scip.h"
38 
39 
40 namespace scip
41 {
42  /** @brief Definition of base class for all clonable classes
43  *
44  * All C++ wrapper object plugins should extend this class, except constraint handlers and variable pricers. This is
45  * needed to be able to copy (clone) a SCIP instance.
46  */
47  struct ObjCloneable
48  {
49  virtual ~ObjCloneable() {}
50 
51  /** assignment of polymorphic classes causes slicing and is therefore disabled. */
52  ObjCloneable& operator=(const ObjCloneable& o) = delete;
53 
54  /** assignment of polymorphic classes causes slicing and is therefore disabled. */
55  ObjCloneable& operator=(ObjCloneable&& o) = delete;
56 
57  /** clone method, used to copy plugins which are not constraint handlers or variable pricer plugins */
59  {
60  return 0;
61  }
62 
63  /** returns whether the plugin object is copyable */
64  virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE(iscloneable)
65  {
66  return false;
67  }
68  };
69 }
70 
71 #endif
virtual ~ObjCloneable()
Definition: objcloneable.h:49
function type definitions for clonable classes
ObjCloneable & operator=(const ObjCloneable &o)=delete
virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE(iscloneable)
Definition: objcloneable.h:64
virtual SCIP_DECL_OBJCLONEABLECLONE(ObjCloneable *clone)
Definition: objcloneable.h:58
Definition of base class for all clonable classes.
Definition: objcloneable.h:47
common defines and data types used in all packages of SCIP
SCIP callable library.