include/opencascade/TDataStd_NoteBook.hxx

0001 // Created on: 1997-07-29
0002 // Created by: Denis PASCAL
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 _TDataStd_NoteBook_HeaderFile
0018 #define _TDataStd_NoteBook_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TDataStd_GenericEmpty.hxx>
0024 #include <Standard_Boolean.hxx>
0025 #include <Standard_Real.hxx>
0026 #include <Standard_Integer.hxx>
0027 #include <Standard_OStream.hxx>
0028 class TDF_Label;
0029 class Standard_GUID;
0030 class TDataStd_Real;
0031 class TDataStd_Integer;
0032
0033 class TDataStd_NoteBook;
0034 DEFINE_STANDARD_HANDLE(TDataStd_NoteBook, TDataStd_GenericEmpty)
0035
0036 //! NoteBook Object attribute
0037 class TDataStd_NoteBook : public TDataStd_GenericEmpty
0038 {
0039
0040 public:
0041   //! class methods
0042   //! =============
0043   //! try to retrieve a NoteBook attribute at <current> label
0044   //! or in  fathers  label of  <current>. Returns True  if
0045   //! found and set <N>.
0046   Standard_EXPORT static Standard_Boolean Find(const TDF_Label&           current,
0047                                                Handle(TDataStd_NoteBook)& N);
0048
0049   //! Create  an  enpty   NoteBook attribute,  located  at
0050   //! <label>. Raises if <label> has attribute
0051   Standard_EXPORT static Handle(TDataStd_NoteBook) New(const TDF_Label& label);
0052
0053   //! NoteBook methods
0054   //! ===============
0055   Standard_EXPORT static const Standard_GUID& GetID();
0056
0057   Standard_EXPORT TDataStd_NoteBook();
0058
0059   //! Tool to Create  an  Integer  attribute from  <value>,
0060   //! Insert it in   a  new son  label   of <me>. The   Real
0061   //! attribute is returned.
0062   Standard_EXPORT Handle(TDataStd_Real) Append(const Standard_Real    value,
0063                                                const Standard_Boolean isExported = Standard_False);
0064
0065   //! Tool to Create  an Real attribute from <value>, Insert
0066   //! it  in a new son label  of <me>. The Integer attribute
0067   //! is returned.
0068   Standard_EXPORT Handle(TDataStd_Integer) Append(
0069     const Standard_Integer value,
0070     const Standard_Boolean isExported = Standard_False);
0071
0072   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0073
0074   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0075
0076   DEFINE_DERIVED_ATTRIBUTE(TDataStd_NoteBook, TDataStd_GenericEmpty)
0077
0078 protected:
0079 private:
0080 };
0081
0082 #endif // _TDataStd_NoteBook_HeaderFile