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 <TDataStd_GenericEmpty.hxx>
  20 class TopoDS_Shape;
  21 class TDF_DataSet;
  22
  23
  24 class TDataXtd_Shape;
  25 DEFINE_STANDARD_HANDLE(TDataXtd_Shape, TDataStd_GenericEmpty)
  26
  27 //! A Shape is associated in the framework with :
  28 //! a NamedShape attribute
  29 class TDataXtd_Shape : public TDataStd_GenericEmpty
  30 {
  31
  32 public:
  33
  34
  35   //! class methods
  36   //! =============
  37   //! try to retrieve a Shape attribute at <current> label
  38   //! or in  fathers  label of  <current>. Returns True  if
  39   //! found and set <S>.
  40   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataXtd_Shape)& S);
  41
  42   //! Find, or create, a Shape attribute.  the Shape attribute
  43   //! is returned. Raises if <label> has attribute.
  44   Standard_EXPORT static Handle(TDataXtd_Shape) New (const TDF_Label& label);
  45
  46   //! Create or update associated NamedShape attribute.  the
  47   //! Shape attribute is returned.
  48   Standard_EXPORT static Handle(TDataXtd_Shape) Set (const TDF_Label& label, const TopoDS_Shape& shape);
  49
  50   //! the Shape from  associated NamedShape attribute
  51   //! is returned.
  52   Standard_EXPORT static TopoDS_Shape Get (const TDF_Label& label);
  53
  54   //! Shape methods
  55   //! ============
  56   Standard_EXPORT static const Standard_GUID& GetID();
  57
  58   Standard_EXPORT TDataXtd_Shape();
  59
  60   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  61
  62   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
  63
  64   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  65
  66
  67   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Shape, TDataStd_GenericEmpty)
  68
  69 protected:
  70
  71
  72
  73
  74 private:
  75
  76
  77
  78
  79 };
  80
  81
  82
  83
  84
  85
  86
  87 #endif // _TDataXtd_Shape_HeaderFile