src/TDataXtd/TDataXtd_Shape.hxx

   1 // Created on: 2009-04-06
   2 // Created by: Sergey ZARITCHNY
   3 // Copyright (c) 2009-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 #ifndef _TDataXtd_Shape_HeaderFile
  17 #define _TDataXtd_Shape_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <TDF_Attribute.hxx>
  23 #include <Standard_Boolean.hxx>
  24 #include <Standard_OStream.hxx>
  25 class TDF_Label;
  26 class TopoDS_Shape;
  27 class Standard_GUID;
  28 class TDF_Attribute;
  29 class TDF_RelocationTable;
  30 class TDF_DataSet;
  31
  32
  33 class TDataXtd_Shape;
  34 DEFINE_STANDARD_HANDLE(TDataXtd_Shape, TDF_Attribute)
  35
  36 //! A Shape is associated in the framework with :
  37 //! a NamedShape attribute
  38 class TDataXtd_Shape : public TDF_Attribute
  39 {
  40
  41 public:
  42
  43
  44   //! class methods
  45   //! =============
  46   //! try to retrieve a Shape attribute at <current> label
  47   //! or in  fathers  label of  <current>. Returns True  if
  48   //! found and set <S>.
  49   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataXtd_Shape)& S);
  50
  51   //! Find, or create, a Shape attribute.  the Shape attribute
  52   //! is returned. Raises if <label> has attribute.
  53   Standard_EXPORT static Handle(TDataXtd_Shape) New (const TDF_Label& label);
  54
  55   //! Create or update associated NamedShape attribute.  the
  56   //! Shape attribute is returned.
  57   Standard_EXPORT static Handle(TDataXtd_Shape) Set (const TDF_Label& label, const TopoDS_Shape& shape);
  58
  59   //! the Shape from  associated NamedShape attribute
  60   //! is returned.
  61   Standard_EXPORT static TopoDS_Shape Get (const TDF_Label& label);
  62
  63   //! Shape methods
  64   //! ============
  65   Standard_EXPORT static const Standard_GUID& GetID();
  66
  67   Standard_EXPORT TDataXtd_Shape();
  68
  69   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  70
  71   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
  72
  73   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  74
  75   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  76
  77   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
  78
  79   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  80
  81
  82
  83
  84   DEFINE_STANDARD_RTTIEXT(TDataXtd_Shape,TDF_Attribute)
  85
  86 protected:
  87
  88
  89
  90
  91 private:
  92
  93
  94
  95
  96 };
  97
  98
  99
 100
 101
 102
 103
 104 #endif // _TDataXtd_Shape_HeaderFile