/usr/include/openturns/PersistentObject.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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | // -*- C++ -*-
/**
* @file PersistentObject.hxx
* @brief Class PersistentObject saves and reloads the object's internal state
*
* (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: PersistentObject.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_PERSISTENTOBJECT_HXX
#define OPENTURNS_PERSISTENTOBJECT_HXX
#include "OSS.hxx"
#include "Object.hxx"
#include "StorageManager.hxx"
#include "IdFactory.hxx"
#include "Pointer.hxx"
namespace OpenTURNS
{
/**
* The default name of any object
*/
extern const String DefaultName;
namespace Base
{
namespace Common
{
class StorageManager;
class StorageManagerAdvocate;
template <class PERSISTENT> class Factory;
/**
* @class PersistentObject
*
* @brief This class defines load and save mechanisms.
*
* This is the base class of all objects that can be stored into
* and reloaded from the study.
*
* The class defines an unique Id for every object so they can be
* equal but not identical. This Id is an essential part for the management
* of objects in studies.
* @sa Study
*/
class PersistentObject
: public Object
{
CLASSNAME;
public:
/**
* Default constructor
*
* The constructor sets a new Id to the object,
* so it can be later referenced by a Study object.
* It is also declared visible if member of a study.
*
* The object has the default name but it does not
* use storage for it.
*/
PersistentObject()
: p_name_(),
id_(IdFactory::BuildId()),
shadowedId_(id_),
studyVisible_(true)
{}
/**
* Standard constructor
*
* The constructor sets a new Id to the object,
* so it can be later referenced by a Study object.
* It is also declared visible if member of a study.
*
* The \p name is used to set the name of the object.
* Setting the name implies storage space allocation.
* @param name The name of the object
*/
explicit PersistentObject(const String & name)
: p_name_(new String(name)),
id_(IdFactory::BuildId()),
shadowedId_(id_),
studyVisible_(true)
{}
/** Copy constructor */
PersistentObject(const PersistentObject & other)
: p_name_(other.p_name_),
id_(IdFactory::BuildId()),
shadowedId_(other.shadowedId_),
studyVisible_(other.studyVisible_)
{}
/**
* Virtual constructor
*
* @warning This method MUST be overloaded in derived classes.
* @return A pointer to a newly allocated object similar to this one
*/
virtual PersistentObject * clone() const = 0;
/** Destructor */
virtual ~PersistentObject() {}
/** Assignment */
inline
PersistentObject & operator =(const PersistentObject & other)
{
if (this != &other) { // Other is NOT me, so I can assign it to me
p_name_ = other.p_name_;
studyVisible_ = other.studyVisible_;
}
return *this;
}
/**
* Comparison operator
*
* This method compares objects based on their content.
*/
inline virtual
Bool operator ==(const PersistentObject & other) const { return true; }
/**
* Identity comparator
*
* This method compares objects based on their Id.
* @return True if objects are the same
*/
inline
Bool is(const PersistentObject & other) const { return (getId() == other.getId()); }
/* String converter */
inline virtual
String __repr__() const { return OSS() << "class=" << getClassName() << " name=" << getName(); }
/* String converter */
inline virtual
String __str__(const String & offset = "") const { return __repr__(); }
/**
* Id accessor
* @return The id of this object
*/
inline
Id getId() const { return id_; }
/**
* Shadowed id accessor
* @internal
*/
inline
void setShadowedId(Id id) { shadowedId_ = id; }
inline
Id getShadowedId() const { return shadowedId_; }
/** Visibility accessor */
inline
void setVisibility(Bool visible) { studyVisible_ = visible; }
inline
Bool getVisibility() const { return studyVisible_; }
/**
* %Object name query
*
* This methos returns true if a name was given to the object
* @return True if object has a name
*/
inline
Bool hasName() const { return p_name_; }
/**
* %Object name accessor
*
* This method returns the name of the object if it has been previously set
* or the default name. Accessing the default name does not cause storage
* allocation as a side effect.
* @return The name of this object
*/
inline
String getName() const { return ( hasName() ? *p_name_ : OT::DefaultName ); }
/**
* %Object name accessor
*
* This method sets \p name as the new name for the object. Setting the name
* may cause storage allocation for the new name, especially of the name was
* not defined so far.
* @param name The new name for this object
*/
inline
void setName(const String & name) { p_name_.reset(new String(name)); }
/** Method save() stores the object through the StorageManager
* @internal
*/
void save(StorageManager & mgr, const String & label, bool fromStudy = false) const;
/** Method save() stores the object through the StorageManager
* @internal
*/
void save(StorageManager & mgr, bool fromStudy = false) const;
/** Method save() stores the object through the StorageManager
*
* @warning This method MUST be overloaded in derived classes.
* @internal
*/
virtual void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager
*
* @warning This method MUST be overloaded in derived classes.
* @internal
*/
virtual void load(StorageManager::Advocate & adv);
protected:
private:
/** The name of the object */
mutable Pointer<String> p_name_;
/**
* The unique identifier of the object
*
* This identifier is needed when saving and reloading the object
* because it allows the chaining of objects even if they are
* relocated.
*/
const Id id_;
/**
* The shadowed id is used when object is reloaded. The object gets
* a new id that is almost always different from that stored in the study.
* So when we need to rebuild the objects dependency tree (ie, when
* object A embed object B), we have to make the id translation: the
* object holds the both ids, the new one (aka the Id as returned by getId)
* and the former one stored in the study (aka the shadowed id). This latter
* is never seen except by the object factory.
* @internal
*/
Id shadowedId_;
/**
* This flag is used by the Study to know if the object should be displayed
* even if it had been added to the study (in particular, when the object
* was rebuild from file)
*/
Bool studyVisible_;
}; /* class PersistentObject */
} /* namespace Common */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_PERSISTENTOBJECT_HXX */
|