include/opencascade/XCAFDoc_Location.hxx

0001 // Created on: 2000-08-15
0002 // Created by: data exchange team
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 _XCAFDoc_Location_HeaderFile
0017 #define _XCAFDoc_Location_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TopLoc_Location.hxx>
0022 #include <TDF_Attribute.hxx>
0023 class Standard_GUID;
0024 class TDF_Label;
0025 class TDF_RelocationTable;
0026
0027 //! attribute to store TopLoc_Location
0028 class XCAFDoc_Location : public TDF_Attribute
0029 {
0030
0031 public:
0032   //! class methods
0033   //! =============
0034   Standard_EXPORT XCAFDoc_Location();
0035
0036   Standard_EXPORT static const Standard_GUID& GetID();
0037
0038   //! Find, or create, a Location attribute and set it's value
0039   //! the Location attribute is returned.
0040   //! Location methods
0041   //! ===============
0042   Standard_EXPORT static occ::handle<XCAFDoc_Location> Set(const TDF_Label&       label,
0043                                                            const TopLoc_Location& Loc);
0044
0045   Standard_EXPORT void Set(const TopLoc_Location& Loc);
0046
0047   //! Returns True if there is a reference on the same label
0048   Standard_EXPORT const TopLoc_Location& Get() const;
0049
0050   Standard_EXPORT const Standard_GUID& ID() const override;
0051
0052   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& With) override;
0053
0054   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0055
0056   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       Into,
0057                              const occ::handle<TDF_RelocationTable>& RT) const override;
0058
0059   //! Dumps the content of me into the stream
0060   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0061
0062   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Location, TDF_Attribute)
0063
0064 private:
0065   TopLoc_Location myLocation;
0066 };
0067
0068 #endif // _XCAFDoc_Location_HeaderFile