src/TObj/TObj_TModel.hxx

   1 // Created on: 2004-11-23
   2 // Created by: Pavel TELKOV
   3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 // The original implementation Copyright: (C) RINA S.p.A
  17
  18 #ifndef TObj_TModel_HeaderFile
  19 #define TObj_TModel_HeaderFile
  20
  21 #include <TDF_Attribute.hxx>
  22
  23 class TObj_Model;
  24
  25 /**
  26 * Attribute to store OCAF-based models in OCAF tree
  27 * The persistency mechanism of the TObj_TModel allowes to save
  28 * and restore various types of models without recompilation of the schema
  29 */
  30
  31 class TObj_TModel : public TDF_Attribute
  32 {
  33  public:
  34   /**
  35   * Standard methods of attribute
  36   */
  37
  38   //! Empty constructor
  39   Standard_EXPORT TObj_TModel();
  40
  41   //! This method is used in implementation of ID()
  42   static Standard_EXPORT const Standard_GUID& GetID();
  43
  44   //! Returns the ID of TObj_TModel attribute.
  45   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  46
  47  public:
  48   //! Methods for setting and obtaining the Model object
  49
  50   //! Sets the Model object
  51   Standard_EXPORT void Set(const Handle(TObj_Model)& theModel);
  52
  53   //! Returns the Model object
  54   Standard_EXPORT Handle(TObj_Model) Model() const;
  55
  56  public:
  57   //! Redefined OCAF abstract methods
  58
  59   //! Returns an new empty TObj_TModel attribute. It is used by the
  60   //! copy algorithm.
  61   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  62
  63   //! Restores the backuped contents from <theWith> into this one. It is used
  64   //! when aborting a transaction.
  65   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& theWith) Standard_OVERRIDE;
  66
  67   //! This method is used when copying an attribute from a source structure
  68   //! into a target structure.
  69   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& theInto,
  70                               const Handle(TDF_RelocationTable)& theRT) const Standard_OVERRIDE;
  71
  72  private:
  73   //! Fields
  74   Handle(TObj_Model) myModel; //!< The Model object stored by the attribute
  75
  76  public:
  77   //! CASCADE RTTI
  78   DEFINE_STANDARD_RTTIEXT(TObj_TModel,TDF_Attribute)
  79 };
  80
  81 //! Define handle class for TObj_TModel
  82 DEFINE_STANDARD_HANDLE(TObj_TModel,TDF_Attribute)
  83
  84 #endif
  85
  86 #ifdef _MSC_VER
  87 #pragma once
  88 #endif