include/opencascade/TDataStd_Directory.hxx

0001 // Created on: 1999-06-25
0002 // Created by: Sergey RUIN
0003 // Copyright (c) 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_Directory_HeaderFile
0018 #define _TDataStd_Directory_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_OStream.hxx>
0026 class TDF_Label;
0027 class Standard_GUID;
0028
0029 //! Associates a directory in the data framework with
0030 //! a TDataStd_TagSource attribute.
0031 //! You can create a new directory label and add
0032 //! sub-directory or object labels to it,
0033 class TDataStd_Directory : public TDataStd_GenericEmpty
0034 {
0035
0036 public:
0037   //! class methods
0038   //! =============
0039   //! Searches for a directory attribute on the label
0040   //! current, or on one of the father labels of current.
0041   //! If a directory attribute is found, true is returned,
0042   //! and the attribute found is set as D.
0043   Standard_EXPORT static bool Find(const TDF_Label& current, occ::handle<TDataStd_Directory>& D);
0044
0045   //! Creates an empty Directory attribute, located at
0046   //! <label>. Raises if <label> has attribute
0047   Standard_EXPORT static occ::handle<TDataStd_Directory> New(const TDF_Label& label);
0048
0049   //! Creates a new sub-label and sets the
0050   //! sub-directory dir on that label.
0051   Standard_EXPORT static occ::handle<TDataStd_Directory> AddDirectory(
0052     const occ::handle<TDataStd_Directory>& dir);
0053
0054   //! Makes new label and returns it to insert
0055   //! other object attributes (sketch,part...etc...)
0056   Standard_EXPORT static TDF_Label MakeObjectLabel(const occ::handle<TDataStd_Directory>& dir);
0057
0058   //! Directory methods
0059   //! ===============
0060   Standard_EXPORT static const Standard_GUID& GetID();
0061
0062   Standard_EXPORT TDataStd_Directory();
0063
0064   Standard_EXPORT const Standard_GUID& ID() const override;
0065
0066   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0067
0068   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Directory, TDataStd_GenericEmpty)
0069 };
0070
0071 #endif // _TDataStd_Directory_HeaderFile