XMLStorageManager

class XMLStorageManager(*args)

Storage manager that drives a XML file.

Available constructors:

XMLStorageManager(filename)

XMLStorageManager(filename, compressionLevel)

Parameters:

fileName : str

Name of the file containing the study.

compressionLevel : int

Compression level of the resulting XML file, in the range 0,…,9 (0=no compression, 9=best compression). The compression is done only if the XML lib has been compiled with zlib support. The default value is given by ‘XMLStorageManager-DefaultCompressionLevel’ in ResourceMap.

See also

StorageManager

Notes

XMLStorageManager enables to read and write OPENTURNS’ objects from a XML file.

Examples

>>> import openturns as ot
>>> # Create a study:
>>> myStudy = ot.Study()
>>> myStudy.setStorageManager(ot.XMLStorageManager('myStudy.xml'))
>>> myStudy2 = ot.Study()
>>> myStudy2.setStorageManager(ot.XMLStorageManager('myStudy2.xml.gz', 5))
>>> # Add an object in the study:
>>> simulationResult = ot.SimulationResult(ot.Event(), 0.5, 0.01, 150, 4)
>>> myStudy.add('simulationResult', simulationResult)
>>> # Save the Study in the file myStudy.xml:
>>> myStudy.save()

Methods

finalize(*args) Do some administrative tasks after saving/reloading.
getClassName() Accessor to the object’s name.
getDefaultStudyVersion() Return the version of the study that the manager can read/write.
getFileName() Get the name of the file containing the study.
getStudy() Get the study bound to the manager.
getStudyVersion() Get the study version.
initialize(*args) Do some administrative tasks before saving/reloading.
isSavedObject(id) Tell if an object is already saved.
load(study) Reload the whole study from the medium.
markObjectAsSaved(id) Tell that an object is saved.
read() Read and create the internal representation.
save(obj, label[, fromStudy]) Save the object onto the medium.
setFileName(fileName) Set the name of the file containing the study.
setStudy(p_study) Set the study bound to the manager.
setStudyVersion(version) Set the study version.
write() Write the internal representation.
__init__(*args)

x.__init__(…) initializes x; see help(type(x)) for signature

finalize(*args)

Do some administrative tasks after saving/reloading.

Available usages:
 

finalize(ot.SaveAction())

finalize(ot.LoadAction())

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getDefaultStudyVersion()

Return the version of the study that the manager can read/write.

Returns:

version : positive int

Version of the study that the manager can read/write.

getFileName()

Get the name of the file containing the study.

Returns:

fileName : str

Name of the file containing the study.

getStudy()

Get the study bound to the manager.

Returns:

study : Study

Study bound to the manager.

getStudyVersion()

Get the study version.

Returns:

version : positive int

Study version.

initialize(*args)

Do some administrative tasks before saving/reloading.

Available usages:
 

initialize(ot.SaveAction())

initialize(ot.LoadAction())

isSavedObject(id)

Tell if an object is already saved.

Returns:

isSaved : bool

True if an object is already saved.

load(study)

Reload the whole study from the medium.

Parameters:

study : Study

The study to reload objects from.

markObjectAsSaved(id)

Tell that an object is saved.

Parameters:

Id : int

Internal identifier of the object.

read()

Read and create the internal representation.

save(obj, label, fromStudy=False)

Save the object onto the medium.

Parameters:

object : PersistentObject

Object to be saved.

label : str

Name associate with the object to be saved.

fromStudy : bool, optional

Flag telling if the object was explicitely put in the study or not. By default, it is equal to False.

setFileName(fileName)

Set the name of the file containing the study.

Parameters:

fileName : str

Name of the file containing the study.

setStudy(p_study)

Set the study bound to the manager.

Parameters:

study : Study

Study bound to the manager.

setStudyVersion(version)

Set the study version.

Parameters:

version : positive int

Study version.

write()

Write the internal representation.