src/TDataStd/TDataStd_Current.hxx

   1 // Created on: 1999-08-02
   2 // Created by: Denis PASCAL
   3 // Copyright (c) 1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _TDataStd_Current_HeaderFile
  18 #define _TDataStd_Current_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <TDF_Label.hxx>
  23 #include <TDF_Attribute.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_OStream.hxx>
  26 class Standard_GUID;
  27 class TDF_RelocationTable;
  28
  29
  30 class TDataStd_Current;
  31 DEFINE_STANDARD_HANDLE(TDataStd_Current, TDF_Attribute)
  32
  33 //! this attribute,  located at root label,  manage an
  34 //! access to a current label.
  35 class TDataStd_Current : public TDF_Attribute
  36 {
  37
  38 public:
  39
  40
  41   //! class methods
  42   //! =============
  43   Standard_EXPORT static const Standard_GUID& GetID();
  44
  45   //! Set <L> as current of <L> Framework.
  46   Standard_EXPORT static void Set (const TDF_Label& L);
  47
  48   //! returns current of <acces> Framework. raise if (!Has)
  49   Standard_EXPORT static TDF_Label Get (const TDF_Label& acces);
  50
  51   //! returns True if a  current label is managed in <acces>
  52   //! Framework.
  53   //! class methods
  54   //! =============
  55   Standard_EXPORT static Standard_Boolean Has (const TDF_Label& acces);
  56
  57   Standard_EXPORT TDataStd_Current();
  58
  59   Standard_EXPORT void SetLabel (const TDF_Label& current);
  60
  61   Standard_EXPORT TDF_Label GetLabel() const;
  62
  63   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  64
  65   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  66
  67   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  68
  69   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  70
  71   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  72
  73   //! Dumps the content of me into the stream
  74   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
  75
  76
  77
  78
  79   DEFINE_STANDARD_RTTIEXT(TDataStd_Current,TDF_Attribute)
  80
  81 protected:
  82
  83
  84
  85
  86 private:
  87
  88
  89   TDF_Label myLabel;
  90
  91
  92 };
  93
  94
  95
  96
  97
  98
  99
 100 #endif // _TDataStd_Current_HeaderFile