SUIT_AutoSaveResetter.h

Go to the documentation of this file.

// Copyright (C) 2007-2026  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// 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, or (at your option) any later version.
//
// 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
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef SUIT_AUTOSAVERESETTER_H
#define SUIT_AUTOSAVERESETTER_H
 
// A helper class to automatically set/unset the "isAutoSaving" flag of a class T.
// The class T must have the following methods:
//   void setIsAutoSaving(const bool on = true);
//   bool isAutoSaving() const;
// Usage example:
// { 
//   SUIT_AutoSaveResetter<SUIT_Study> aResetter(study);
//   ... // here study->isAutoSaving() returns true
// }
// // when aResetter goes out of scope, study->isAutoSaving() returns false
 
template <typename T>
class SUIT_AutoSaveResetter {
public:
  SUIT_AutoSaveResetter(T *theObject)
    :myObject(theObject)
  {
    if (myObject)
    {
      myObject->setIsAutoSaving(true);
    }
  }
  SUIT_AutoSaveResetter() = delete;
  ~SUIT_AutoSaveResetter()
  {
    if (myObject)
    {
      myObject->setIsAutoSaving(false);
      myObject = nullptr;
    }
  }
private:
  T *myObject;
};
 
 
#endif