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
0034 class TDataStd_NoteBook;
0035 DEFINE_STANDARD_HANDLE(TDataStd_NoteBook, TDataStd_GenericEmpty)
0036
0037 //! NoteBook Object attribute
0038 class TDataStd_NoteBook : public TDataStd_GenericEmpty
0039 {
0040
0041 public:
0042
0043
0044   //! class methods
0045   //! =============
0046   //! try to retrieve a NoteBook attribute at <current> label
0047   //! or in  fathers  label of  <current>. Returns True  if
0048   //! found and set <N>.
0049   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataStd_NoteBook)& N);
0050
0051   //! Create  an  enpty   NoteBook attribute,  located  at
0052   //! <label>. Raises if <label> has attribute
0053   Standard_EXPORT static Handle(TDataStd_NoteBook) New (const TDF_Label& label);
0054
0055   //! NoteBook methods
0056   //! ===============
0057   Standard_EXPORT static const Standard_GUID& GetID();
0058
0059   Standard_EXPORT TDataStd_NoteBook();
0060
0061   //! Tool to Create  an  Integer  attribute from  <value>,
0062   //! Insert it in   a  new son  label   of <me>. The   Real
0063   //! attribute is returned.
0064   Standard_EXPORT Handle(TDataStd_Real) Append (const Standard_Real value, const Standard_Boolean isExported = Standard_False);
0065
0066   //! Tool to Create  an Real attribute from <value>, Insert
0067   //! it  in a new son label  of <me>. The Integer attribute
0068   //! is returned.
0069   Standard_EXPORT Handle(TDataStd_Integer) Append (const Standard_Integer value, const Standard_Boolean isExported = Standard_False);
0070
0071   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0072
0073   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0074
0075
0076
0077   DEFINE_DERIVED_ATTRIBUTE(TDataStd_NoteBook, TDataStd_GenericEmpty)
0078
0079 protected:
0080
0081
0082
0083
0084 private:
0085
0086
0087
0088
0089 };
0090
0091
0092
0093
0094
0095
0096
0097 #endif // _TDataStd_NoteBook_HeaderFile