include/opencascade/TDF_TagSource.hxx

0001 // Created on: 1997-08-04
0002 // Created by: VAUTHIER Jean-Claude
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TDF_TagSource_HeaderFile
0018 #define _TDF_TagSource_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <TDF_Attribute.hxx>
0025 class Standard_GUID;
0026 class TDF_Label;
0027 class TDF_RelocationTable;
0028
0029 class TDF_TagSource;
0030 DEFINE_STANDARD_HANDLE(TDF_TagSource, TDF_Attribute)
0031
0032 //! This attribute manage   a tag provider   to create
0033 //! child labels of a given one.
0034 class TDF_TagSource : public TDF_Attribute
0035 {
0036
0037 public:
0038   //! class methods
0039   //! =============
0040   Standard_EXPORT static const Standard_GUID& GetID();
0041
0042   //! Find, or create, a  TagSource attribute. the TagSource
0043   //! attribute is returned.
0044   Standard_EXPORT static Handle(TDF_TagSource) Set(const TDF_Label& label);
0045
0046   //! Find (or create) a  tagSource attribute located at <L>
0047   //! and make a new child label.
0048   //! TagSource methods
0049   //! =================
0050   Standard_EXPORT static TDF_Label NewChild(const TDF_Label& L);
0051
0052   Standard_EXPORT TDF_TagSource();
0053
0054   Standard_EXPORT Standard_Integer NewTag();
0055
0056   Standard_EXPORT TDF_Label NewChild();
0057
0058   Standard_EXPORT Standard_Integer Get() const;
0059
0060   //! TDF_Attribute methods
0061   //! =====================
0062   Standard_EXPORT void Set(const Standard_Integer T);
0063
0064   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0065
0066   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0067
0068   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0069
0070   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       Into,
0071                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0072
0073   //! Dumps the content of me into the stream
0074   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0075                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0076
0077   DEFINE_STANDARD_RTTIEXT(TDF_TagSource, TDF_Attribute)
0078
0079 protected:
0080 private:
0081   Standard_Integer myTag;
0082 };
0083
0084 #endif // _TDF_TagSource_HeaderFile