Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Core/3.2/Interfaces/IStorable.cs @ 2077

Last change on this file since 2077 was 776, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.Core namespace (#331)

File size: 2.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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 System;
23using System.Collections.Generic;
24using System.Text;
25using System.Xml;
26
27namespace HeuristicLab.Core {
28  /// <summary>
29  /// Interface to represent objects that are de- and serializeable.
30  /// </summary>
31  public interface IStorable {
32    /// <summary>
33    /// Gets the objects unique identifier.
34    /// </summary>
35    Guid Guid { get; }
36
37    /// <summary>
38    /// Clones the current instance (deep clone).
39    /// </summary>
40    /// <returns>The cloned object.</returns>
41    object Clone();
42    /// <summary>
43    /// Clones the current instance, considering already cloned objects.
44    /// </summary>
45    /// <param name="clonedObjects">All already cloned objects. (Needed to avoid cycles.)</param>
46    /// <returns>The cloned object.</returns>
47    object Clone(IDictionary<Guid, object> clonedObjects);
48
49    /// <summary>
50    /// Saves the current instance as <see cref="XmlNode"/> in the specified
51    /// <typeparamref name="document"/>.
52    /// </summary>
53    /// <param name="name">The (tag)name of the <see cref="XmlNode"/>.</param>
54    /// <param name="document">The <see cref="XmlDocument"/> where to save the data.</param>
55    /// <param name="persistedObjects">The dictionary of all already persisted objects.
56    /// (Needed to avoid cycles.)</param>
57    /// <returns>The saved <see cref="XmlNode"/>.</returns>
58    XmlNode GetXmlNode(string name, XmlDocument document, IDictionary<Guid, IStorable> persistedObjects);
59    /// <summary>
60    /// Loads the persisted object from the specified <paramref name="node"/>.
61    /// </summary>
62    /// <param name="node">The <see cref="XmlNode"/> where the object is saved.</param>
63    /// <param name="restoredObjects">A dictionary of all already restored objects. (Needed to avoid
64    /// cycles.)</param>
65    void Populate(XmlNode node, IDictionary<Guid, IStorable> restoredObjects);
66  }
67}
Note: See TracBrowser for help on using the repository browser.