/usr/include/openturns/swig/Study_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | %feature("docstring") OT::Study
"Study.
The study allows the user to save all its data to a structure looking like a
map. The data are copied verbatim to the study. This is not a link, so future
modification of the original won't affect the data saved in the study. To
update the data saved in the study, the user has to explicitely save it again.
Study allows the user to retrieve previously saved objects either by their name
if a name was defined for the object or by their Id.
Examples
--------
>>> import openturns as ot
Create a Study object:
>>> myStudy = ot.Study()
>>> myStudy.setStorageManager(ot.XMLStorageManager('myStudy.xml'))
Add PersistentObjects to the study:
>>> # a NumericalPoint:
>>> point = ot.NumericalPoint(3, 0.)
>>> point[0] = 10.
>>> point[1] = 11.
>>> point[2] = 12.
>>> myStudy.add('point', point)
>>> # a Simulation::Result:
>>> simulationResult = ot.SimulationResult(ot.Event(), 0.5, 0.01, 150, 4)
>>> myStudy.add('simulationResult', simulationResult)
Get objects from the study:
>>> print(myStudy.getObject('point'))
[10,11,12]
Save the Study:
>>> myStudy.save()
Create a new Study object:
>>> myStudy = ot.Study()
>>> myStudy.setStorageManager(ot.XMLStorageManager('myStudy.xml'))
Load data from the study:
>>> myStudy.load()
Create data from the ones stored in the study:
>>> # a NumericalPoint:
>>> otherPoint = ot.NumericalPoint()
>>> myStudy.fillObject('point', otherPoint)
>>> # a Simulation::Result:
>>> otherSimulationResult = ot.SimulationResult()
>>> myStudy.fillObject('simulationResult', otherSimulationResult)
Get information from the study:
>>> myStudy.printLabels()
'point;simulationResult'
Remove data:
>>> myStudy.hasObject(otherSimulationResult.getId())
True
>>> myStudy.remove(otherSimulationResult)
>>> myStudy.hasObject('simulationResult')
False"
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::add
"Add an object to the study.
:Available usages:
add(*object*)
add(*name, object, force=False*)
Parameters
----------
object : :class:`~openturns.InterfaceObject`, :class:`~openturns.PersistentObject`
Object to add in the study.
name : str
Name to associate with the object.
force : bool
If *force=True* and *name* is already defined in the study, the previous
object associated with this name is removed. A error message is emitted
otherwise."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::fillObject
"Fill an object with one got from study.
:Available usages:
fillObject(*name, object*)
fillObject(*id, object*)
Parameters
----------
object : :class:`~openturns.InterfaceObject`, :class:`~openturns.PersistentObject`
An object to be refilled (may be empty, i.e. default constructed).
name : str
Name of the object stored in the study.
id : int
Internal identifier of the object stored in the study."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::fillObjectByName
"Fill an object with one got from study.
:Available usages:
fillObjectByName(*object, name*)
fillObjectByName(*id, object*)
Parameters
----------
object : :class:`~openturns.InterfaceObject`, :class:`~openturns.PersistentObject`
An object to be refilled (may be empty, i.e. default constructed).
name : str
Name of the object stored in the study.
id : int
Internal identifier of the object stored in the study."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::getObject
"Get object from the study.
:Available usages:
getObject(*id*)
getObject(*name*)
Parameters
----------
name : str
Name of the object stored in the study.
id : int
Internal identifier of the object stored in the study.
Returns
-------
object : :class:`~openturns.PersistentObject`
The object saved in the study."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::getStorageManager
"Get the storage manager used by the study.
Parameters
----------
manager : :class:`~openturns.StorageManager`
Storage manager used by the study to save and reload data."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::setStorageManager
"Set the storage manager used by the study.
Returns
-------
manager : :class:`~openturns.StorageManager`
Storage manager used by the study to save and reload data."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::hasObject
"Query if object is stored in study.
:Available usages:
hasObject(*id*)
hasObject(*name*)
Parameters
----------
name : str
Name of the object stored in the study.
id : int
Internal identifier of the object stored in the study.
Returns
-------
hasObject : bool
*True* if the object is stored in the study."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::load
"Reload the study from the storage manager."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::printLabels
"Print all the names of the objects stored in the study.
Returns
-------
names : str
Names of the objects stored in the study."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::remove
"Remove an object from the study.
:Available usages:
remove(*object*)
remove(*name*)
Parameters
----------
object : :class:`~openturns.InterfaceObject`
An object to be removed.
name : str
Name of the object to be removed."
// ---------------------------------------------------------------------
%feature("docstring") OT::Study::save
"Save the study through the storage manager."
|