include/opencascade/TDataXtd_Shape.hxx

0001 // Created on: 2009-04-06
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 2009-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDataXtd_Shape_HeaderFile
0017 #define _TDataXtd_Shape_HeaderFile
0018
0019 #include <TDataStd_GenericEmpty.hxx>
0020 class TopoDS_Shape;
0021 class TDF_DataSet;
0022
0023 //! A Shape is associated in the framework with :
0024 //! a NamedShape attribute
0025 class TDataXtd_Shape : public TDataStd_GenericEmpty
0026 {
0027
0028 public:
0029   //! class methods
0030   //! =============
0031   //! try to retrieve a Shape attribute at <current> label
0032   //! or in fathers label of <current>. Returns True if
0033   //! found and set <S>.
0034   Standard_EXPORT static bool Find(const TDF_Label& current, occ::handle<TDataXtd_Shape>& S);
0035
0036   //! Find, or create, a Shape attribute. the Shape attribute
0037   //! is returned. Raises if <label> has attribute.
0038   Standard_EXPORT static occ::handle<TDataXtd_Shape> New(const TDF_Label& label);
0039
0040   //! Create or update associated NamedShape attribute. the
0041   //! Shape attribute is returned.
0042   Standard_EXPORT static occ::handle<TDataXtd_Shape> Set(const TDF_Label&    label,
0043                                                          const TopoDS_Shape& shape);
0044
0045   //! the Shape from associated NamedShape attribute
0046   //! is returned.
0047   Standard_EXPORT static TopoDS_Shape Get(const TDF_Label& label);
0048
0049   //! Shape methods
0050   //! =============
0051   Standard_EXPORT static const Standard_GUID& GetID();
0052
0053   Standard_EXPORT TDataXtd_Shape();
0054
0055   Standard_EXPORT const Standard_GUID& ID() const override;
0056
0057   Standard_EXPORT void References(const occ::handle<TDF_DataSet>& DS) const override;
0058
0059   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0060
0061   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Shape, TDataStd_GenericEmpty)
0062 };
0063
0064 #endif // _TDataXtd_Shape_HeaderFile