1%feature("docstring") OT::StorageManager
2"Define the way OpenTURNS' objects are saved and reloaded.
3
4Available constructors:
5    StorageManager(*defaultVersion=1*)
6
7Parameters
8----------
9defaultVersion : positive int
10    Argument interpreted as the name of the object in a user point of view.
11    This name is never used in another way than for user information. This name
12    has no meaning to the platform.
13
14Notes
15-----
16A StorageManager object can be used only through its derived class
17:class:`~openturns.XMLStorageManager`.
18
19See also
20--------
21XMLStorageManager"
22
23// ---------------------------------------------------------------------
24
25%feature("docstring") OT::StorageManager::finalize
26"Do some administrative tasks after saving/reloading.
27
28:Available usages:
29    finalize(*ot.SaveAction()*)
30
31    finalize(*ot.LoadAction()*)"
32
33// ---------------------------------------------------------------------
34
35%feature("docstring") OT::StorageManager::getDefaultStudyVersion
36"Return the version of the study that the manager can read/write.
37
38Returns
39-------
40version : positive int
41    Version of the study that the manager can read/write."
42
43// ---------------------------------------------------------------------
44
45%feature("docstring") OT::StorageManager::getStudyVersion
46"Get the study version.
47
48Returns
49-------
50version : positive int
51    Study version."
52
53// ---------------------------------------------------------------------
54
55%feature("docstring") OT::StorageManager::setStudyVersion
56"Set the study version.
57
58Parameters
59----------
60version : positive int
61    Study version."
62
63// ---------------------------------------------------------------------
64
65%feature("docstring") OT::StorageManager::getStudy
66"Get the study bound to the manager.
67
68Returns
69-------
70study : :class:`~openturns.Study`
71    Study bound to the manager."
72
73// ---------------------------------------------------------------------
74
75%feature("docstring") OT::StorageManager::setStudy
76"Set the study bound to the manager.
77
78Parameters
79----------
80study : :class:`~openturns.Study`
81    Study bound to the manager."
82
83// ---------------------------------------------------------------------
84
85%feature("docstring") OT::StorageManager::initialize
86"Do some administrative tasks before saving/reloading.
87
88:Available usages:
89    initialize(*ot.SaveAction()*)
90
91    initialize(*ot.LoadAction()*)"
92
93// ---------------------------------------------------------------------
94
95%feature("docstring") OT::StorageManager::isSavedObject
96"Tell if an object is already saved.
97
98Returns
99-------
100isSaved : bool
101    *True* if an object is already saved."
102
103// ---------------------------------------------------------------------
104
105%feature("docstring") OT::StorageManager::load
106"Reload the whole study from the medium.
107
108Parameters
109----------
110study : :class:`~openturns.Study`
111    The study to reload objects from."
112
113// ---------------------------------------------------------------------
114
115%feature("docstring") OT::StorageManager::markObjectAsSaved
116"Tell that an object is saved.
117
118Parameters
119----------
120Id : int
121    Internal identifier of the object."
122
123// ---------------------------------------------------------------------
124
125%feature("docstring") OT::StorageManager::read
126"Read and create the internal representation."
127
128// ---------------------------------------------------------------------
129
130%feature("docstring") OT::StorageManager::save
131"Save the object onto the medium.
132
133Parameters
134----------
135object : :class:`~openturns.PersistentObject`
136    Object to be saved.
137label : str
138    Name associate with the object to be saved.
139fromStudy : bool, optional
140    Flag telling if the object was explicitely put in the study or not. By
141    default, it is equal to *False*."
142
143// ---------------------------------------------------------------------
144
145%feature("docstring") OT::StorageManager::write
146"Write the internal representation."