OCCT

// Created on: 1997-07-29
// Created by: Denis PASCAL
// Copyright (c) 1997-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _TDataStd_NoteBook_HeaderFile
#define _TDataStd_NoteBook_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <TDataStd_GenericEmpty.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_Real.hxx>
#include <Standard_Integer.hxx>
#include <Standard_OStream.hxx>
class TDF_Label;
class Standard_GUID;
class TDataStd_Real;
class TDataStd_Integer;

//! NoteBook Object attribute
class TDataStd_NoteBook : public TDataStd_GenericEmpty
{

public:
  //! class methods
  //! =============
  //! try to retrieve a NoteBook attribute at <current> label
  //! or in fathers label of <current>. Returns True if
  //! found and set <N>.
  Standard_EXPORT static bool Find(const TDF_Label& current, occ::handle<TDataStd_NoteBook>& N);

  //! Create an enpty NoteBook attribute, located at
  //! <label>. Raises if <label> has attribute
  Standard_EXPORT static occ::handle<TDataStd_NoteBook> New(const TDF_Label& label);

  //! NoteBook methods
  //! ===============
  Standard_EXPORT static const Standard_GUID& GetID();

  Standard_EXPORT TDataStd_NoteBook();

  //! Tool to Create an Integer attribute from <value>,
  //! Insert it in a new son label of <me>. The Real
  //! attribute is returned.
  Standard_EXPORT occ::handle<TDataStd_Real> Append(const double value,
                                                    const bool   isExported = false);

  //! Tool to Create an Real attribute from <value>, Insert
  //! it in a new son label of <me>. The Integer attribute
  //! is returned.
  Standard_EXPORT occ::handle<TDataStd_Integer> Append(const int  value,
                                                       const bool isExported = false);

  Standard_EXPORT const Standard_GUID& ID() const override;

  Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;

  DEFINE_DERIVED_ATTRIBUTE(TDataStd_NoteBook, TDataStd_GenericEmpty)
};

#endif // _TDataStd_NoteBook_HeaderFile