include/opencascade/TDF_Reference.hxx

0001 // Created on: 2000-03-01
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 2000-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 _TDF_Reference_HeaderFile
0017 #define _TDF_Reference_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TDF_Label.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Standard_OStream.hxx>
0024 class Standard_GUID;
0025 class TDF_RelocationTable;
0026 class TDF_DataSet;
0027
0028 class TDF_Reference;
0029 DEFINE_STANDARD_HANDLE(TDF_Reference, TDF_Attribute)
0030
0031 //! This  attribute is  used to  store in the  framework a
0032 //! reference to an other label.
0033 class TDF_Reference : public TDF_Attribute
0034 {
0035
0036 public:
0037   Standard_EXPORT static const Standard_GUID& GetID();
0038
0039   Standard_EXPORT static Handle(TDF_Reference) Set(const TDF_Label& I, const TDF_Label& Origin);
0040
0041   Standard_EXPORT void Set(const TDF_Label& Origin);
0042
0043   Standard_EXPORT TDF_Label Get() const;
0044
0045   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0046
0047   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0048
0049   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0050
0051   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       Into,
0052                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0053
0054   Standard_EXPORT virtual void References(const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
0055
0056   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0057
0058   Standard_EXPORT TDF_Reference();
0059
0060   //! Dumps the content of me into the stream
0061   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0062                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0063
0064   DEFINE_STANDARD_RTTIEXT(TDF_Reference, TDF_Attribute)
0065
0066 protected:
0067 private:
0068   TDF_Label myOrigin;
0069 };
0070
0071 #endif // _TDF_Reference_HeaderFile