include/opencascade/TDocStd_Modified.hxx

0001 // Created on: 1999-07-12
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 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 _TDocStd_Modified_HeaderFile
0018 #define _TDocStd_Modified_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TDF_LabelMap.hxx>
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_Boolean.hxx>
0025 #include <Standard_OStream.hxx>
0026 class TDF_Label;
0027 class Standard_GUID;
0028 class TDF_RelocationTable;
0029
0030
0031 class TDocStd_Modified;
0032 DEFINE_STANDARD_HANDLE(TDocStd_Modified, TDF_Attribute)
0033
0034 //! Transient attribute which register modified labels.
0035 //! This attribute is attached to root label.
0036 class TDocStd_Modified : public TDF_Attribute
0037 {
0038
0039 public:
0040
0041
0042   //! API class methods
0043   //! =================
0044   Standard_EXPORT static Standard_Boolean IsEmpty (const TDF_Label& access);
0045
0046   Standard_EXPORT static Standard_Boolean Add (const TDF_Label& alabel);
0047
0048   Standard_EXPORT static Standard_Boolean Remove (const TDF_Label& alabel);
0049
0050   Standard_EXPORT static Standard_Boolean Contains (const TDF_Label& alabel);
0051
0052   //! if <IsEmpty> raise an exception.
0053   Standard_EXPORT static const TDF_LabelMap& Get (const TDF_Label& access);
0054
0055   //! remove all modified labels. becomes empty
0056   Standard_EXPORT static void Clear (const TDF_Label& access);
0057
0058   //! Modified methods
0059   //! ================
0060   Standard_EXPORT static const Standard_GUID& GetID();
0061
0062   Standard_EXPORT TDocStd_Modified();
0063
0064   Standard_EXPORT Standard_Boolean IsEmpty() const;
0065
0066   Standard_EXPORT void Clear();
0067
0068   //! add <L> as modified
0069   Standard_EXPORT Standard_Boolean AddLabel (const TDF_Label& L);
0070
0071   //! remove  <L> as modified
0072   Standard_EXPORT Standard_Boolean RemoveLabel (const TDF_Label& L);
0073
0074   //! returns modified label map
0075   Standard_EXPORT const TDF_LabelMap& Get() const;
0076
0077   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0078
0079   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0080
0081   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0082
0083   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0084
0085   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0086
0087
0088
0089
0090   DEFINE_STANDARD_RTTIEXT(TDocStd_Modified,TDF_Attribute)
0091
0092 protected:
0093
0094
0095
0096
0097 private:
0098
0099
0100   TDF_LabelMap myModified;
0101
0102
0103 };
0104
0105
0106
0107
0108
0109
0110
0111 #endif // _TDocStd_Modified_HeaderFile