1 // Created on: 1997-07-29
2 // Created by: Denis PASCAL
3 // Copyright (c) 1997-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _TDataStd_NoteBook_HeaderFile
18 #define _TDataStd_NoteBook_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_OStream.hxx>
31 class TDataStd_Integer;
33 class TDF_RelocationTable;
36 class TDataStd_NoteBook;
37 DEFINE_STANDARD_HANDLE(TDataStd_NoteBook, TDF_Attribute)
39 //! NoteBook Object attribute
40 class TDataStd_NoteBook : public TDF_Attribute
48 //! try to retrieve a NoteBook attribute at <current> label
49 //! or in fathers label of <current>. Returns True if
50 //! found and set <N>.
51 Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataStd_NoteBook)& N);
53 //! Create an enpty NoteBook attribute, located at
54 //! <label>. Raises if <label> has attribute
55 Standard_EXPORT static Handle(TDataStd_NoteBook) New (const TDF_Label& label);
59 Standard_EXPORT static const Standard_GUID& GetID();
61 Standard_EXPORT TDataStd_NoteBook();
63 //! Tool to Create an Integer attribute from <value>,
64 //! Insert it in a new son label of <me>. The Real
65 //! attribute is returned.
66 Standard_EXPORT Handle(TDataStd_Real) Append (const Standard_Real value, const Standard_Boolean isExported = Standard_False);
68 //! Tool to Create an Real attribute from <value>, Insert
69 //! it in a new son label of <me>. The Integer attribute
71 Standard_EXPORT Handle(TDataStd_Integer) Append (const Standard_Integer value, const Standard_Boolean isExported = Standard_False);
73 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
75 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
77 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
79 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
81 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
83 //! Dumps the content of me into the stream
84 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
89 DEFINE_STANDARD_RTTIEXT(TDataStd_NoteBook,TDF_Attribute)
109 #endif // _TDataStd_NoteBook_HeaderFile