/usr/include/openturns/Study.hxx is in libopenturns-dev 0.15-2.
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 231 232 233 234 235 236 237 238 239 240 | // -*- C++ -*-
/**
* @file Study.hxx
* @brief Study keeps all PersistentObjects in a file
*
* (C) Copyright 2005-2011 EDF-EADS-Phimeca
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: Study.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_STUDY_HXX
#define OPENTURNS_STUDY_HXX
#include <iostream> // for std::ostream
#include <map> // for std::map
#include "Object.hxx"
#include "Pointer.hxx"
#include "StorageManager.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Common
{
/* Forward declarations */
class InterfaceObject;
class StorageManager;
/**
* @class Study
* @brief Keeps all PersistentObjects in a file
*
* The study allows the user to save all its data to a structure looking like a map.
* Tha 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.
* @see PersistentObject
* @see StorageManager
*/
class Study
: public Object
{
CLASSNAME;
friend class StorageManager;
public:
/* Some typedefs for easy reading */
typedef Pointer<PersistentObject> MapElement;
typedef std::map<Id, MapElement> Map;
typedef std::map<String, Id> LabelMap;
typedef Pointer<StorageManager> StorageManagerImplementation;
/**
* Default constructor
*/
explicit Study();
/** @copydoc Object::__repr__() const */
virtual String __repr__() const;
/** @copydoc Object::__str__() const */
virtual String __str__(const String & offset = "") const;
/** This method saves the study through the storage manager */
void save();
/** This method reloads the study from the storage manager */
void load();
/** Defines which storage manager must be used to save and reload data */
void setStorageManager(const StorageManager & smgr);
/** Get the storage manager used by the study */
StorageManagerImplementation getStorageManager() const;
/** Add a PersistentObject to the study */
void add(const InterfaceObject & io);
/** Add a PersistentObject to the study */
void add(const String & label, const InterfaceObject & io, Bool force = false);
/** Add a PersistentObject to the study */
void add(const PersistentObject & po);
/** Add a PersistentObject to the study */
void add(const String & label, const PersistentObject & po, Bool force = false);
#ifndef SWIG
/** Add a PersistentObject to the study
* @throw InvalidArgumentException
*/
void add(const PersistentObject * po);
/** Add a PersistentObject to the study
* @throw InvalidArgumentException
*/
void add(const String & label, const PersistentObject * po, Bool force = false);
#endif
/** Remove a PersistentObject from the study */
void remove(const InterfaceObject & io);
/** Remove a PersistentObject from the study */
void remove(const String & label);
/** Query if object is stored in study
* @param id The Id of the object
* @return True if the object is stored in the study
*/
Bool hasObject(Id id) const;
/** Query if object is stored in study
* @param label The label of the object
* @return True if the object is stored in the study
*/
Bool hasObject(const String & label) const;
/** Get object whose id is given
* @param id The Id of the object
* @return The object saved in the study
*/
MapElement getObject(Id id) const;
/** Get object whose id is given
* @param label The label of the object
* @return The object saved in the study
*/
MapElement getObject(const String & label) const;
/** Fill an object with one got from study
* @param po An object to be refilled (may be empty, ie default constructed)
* @param name The name of the object stored in the study
* @throw InvalidArgumentException
*/
void fillObjectByName(PersistentObject & po, const String & name) const;
/** Fill an object with one got from study
* @param io An object to be refilled (may be empty, ie default constructed)
* @param name The name of the object stored in the study
* @throw InvalidArgumentException
*/
void fillObjectByName(InterfaceObject & io, const String & name) const;
/** Fill an object with one got from study
* @param id The Id of the object stored in the study
* @param po An object to be refilled (may be empty, ie default constructed)
* @throw InvalidArgumentException
*/
void fillObject(Id id, PersistentObject & po) const;
/** Fill an object with one got from study
* @param id The Id of the object stored in the study
* @param io An object to be refilled (may be empty, ie default constructed)
* @throw InvalidArgumentException
*/
void fillObject(Id id, InterfaceObject & io) const;
/** Fill an object with one got from study
* @param label The label of the object stored in the study
* @param po An object to be refilled (may be empty, ie default constructed)
* @throw InvalidArgumentException
*/
void fillObject(const String & name, PersistentObject & po) const;
/** Fill an object with one got from study
* @param label The label of the object stored in the study
* @param io An object to be refilled (may be empty, ie default constructed)
* @throw InvalidArgumentException
*/
void fillObject(const String & name, InterfaceObject & io) const;
protected:
/** Define a label for an object */
void defineLabel(Id id, const String & label);
/** Define the visibility of an object */
void defineVisibility(Id id, Bool visible);
/** Get object whose class and name are given */
MapElement getObjectByName(const String & className, const String & name) const;
/** This method purges the study from the reloaded objects that are tagged unvisible */
void cleanUnvisibleObject();
/** This method performs the translation of ids after a study load */
void translateId();
private:
/** Assignment */
Study & operator =(const Study & other);
/** The map storing the saved objects */
Map map_;
/** The map storing the saved objects */
LabelMap labelMap_;
/** The StorageManager that drives the load/store operations */
StorageManagerImplementation p_storageManager_;
}; /* class Study */
} /* namespace Common */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_STUDY_HXX */
|