0030773: Application Framework - To allow to inherit existing attributes to reuse...
[occt.git] / src / TDataStd / TDataStd_NoteBook.hxx
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
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_NoteBook_HeaderFile
18 #define _TDataStd_NoteBook_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <TDataStd_GenericEmpty.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Standard_OStream.hxx>
28 class TDF_Label;
29 class Standard_GUID;
30 class TDataStd_Real;
31 class TDataStd_Integer;
32 class TDF_Attribute;
33 class TDF_RelocationTable;
34
35
36 class TDataStd_NoteBook;
37 DEFINE_STANDARD_HANDLE(TDataStd_NoteBook, TDataStd_GenericEmpty)
38
39 //! NoteBook Object attribute
40 class TDataStd_NoteBook : public TDataStd_GenericEmpty
41 {
42
43 public:
44
45   
46   //! class methods
47   //! =============
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);
52   
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);
56   
57   //! NoteBook methods
58   //! ===============
59   Standard_EXPORT static const Standard_GUID& GetID();
60   
61   Standard_EXPORT TDataStd_NoteBook();
62   
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);
67   
68   //! Tool to Create  an Real attribute from <value>, Insert
69   //! it  in a new son label  of <me>. The Integer attribute
70   //! is returned.
71   Standard_EXPORT Handle(TDataStd_Integer) Append (const Standard_Integer value, const Standard_Boolean isExported = Standard_False);
72   
73   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
74   
75   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
76   
77
78
79   DEFINE_DERIVED_ATTRIBUTE(TDataStd_NoteBook, TDataStd_GenericEmpty)
80
81 protected:
82
83
84
85
86 private:
87
88
89
90
91 };
92
93
94
95
96
97
98
99 #endif // _TDataStd_NoteBook_HeaderFile