Free cookie consent management tool by TermsFeed Policy Generator

source: stable/HeuristicLab.Common/3.3/DeepCloneable.cs @ 17097

Last change on this file since 17097 was 17097, checked in by mkommend, 5 years ago

#2520: Merged 16565 - 16579 into stable.

File size: 2.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using HEAL.Attic;
23
24namespace HeuristicLab.Common {
25  [StorableType("8ed3dd0c-1cb8-4b42-8053-05bd1fcf48ef")]
26  /// <summary>
27  /// Represents a base class for all deeply cloneable objects.
28  /// </summary>
29  public abstract class DeepCloneable : IDeepCloneable {
30    [StorableConstructor]
31    protected DeepCloneable(StorableConstructorFlag _) { }
32
33    protected DeepCloneable(DeepCloneable original, Cloner cloner) {
34      cloner.RegisterClonedObject(original, this);
35    }
36    protected DeepCloneable() { }
37
38    /// <summary>
39    /// Creates a deep clone of this instance.
40    /// </summary>
41    /// <remarks>
42    /// This method is the entry point for creating a deep clone of a whole object graph.
43    /// </remarks>
44    /// <returns>A clone of this instance.</returns>
45    public object Clone() {
46      return Clone(new Cloner());
47    }
48
49    /// <summary>
50    /// Creates a deep clone of this instance.
51    /// </summary>
52    /// <remarks>This method should not be called directly. It is used for creating clones of
53    /// objects which are contained in the object that is currently cloned.</remarks>
54    /// <param name="cloner">The cloner which is responsible for keeping track of all already
55    /// cloned objects.</param>
56    /// <returns>A clone of this instance.</returns>
57    public abstract IDeepCloneable Clone(Cloner cloner);
58  }
59}
Note: See TracBrowser for help on using the repository browser.