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
0030 class TDataStd_Directory;
0031 DEFINE_STANDARD_HANDLE(TDataStd_Directory, TDataStd_GenericEmpty)
0032
0033 //! Associates a directory in the data framework with
0034 //! a TDataStd_TagSource attribute.
0035 //! You can create a new directory label and add
0036 //! sub-directory or object labels to it,
0037 class TDataStd_Directory : public TDataStd_GenericEmpty
0038 {
0039
0040 public:
0041
0042
0043   //! class methods
0044   //! =============
0045   //! Searches for a directory attribute on the label
0046   //! current, or on one of the father labels of current.
0047   //! If a directory attribute is found, true is returned,
0048   //! and the attribute found is set as D.
0049   Standard_EXPORT static Standard_Boolean Find (const TDF_Label& current, Handle(TDataStd_Directory)& D);
0050
0051   //! Creates  an  empty   Directory attribute,  located  at
0052   //! <label>. Raises if <label> has attribute
0053   Standard_EXPORT static Handle(TDataStd_Directory) New (const TDF_Label& label);
0054
0055   //! Creates a new sub-label and sets the
0056   //! sub-directory dir on that label.
0057   Standard_EXPORT static Handle(TDataStd_Directory) AddDirectory (const Handle(TDataStd_Directory)& dir);
0058
0059   //! Makes new label and returns it to insert
0060   //! other object attributes (sketch,part...etc...)
0061   Standard_EXPORT static TDF_Label MakeObjectLabel (const Handle(TDataStd_Directory)& dir);
0062
0063   //! Directory methods
0064   //! ===============
0065   Standard_EXPORT static const Standard_GUID& GetID();
0066
0067   Standard_EXPORT TDataStd_Directory();
0068
0069   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0070
0071   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0072
0073
0074   DEFINE_DERIVED_ATTRIBUTE(TDataStd_Directory,TDataStd_GenericEmpty)
0075
0076 protected:
0077
0078
0079
0080
0081 private:
0082
0083
0084
0085
0086 };
0087
0088
0089
0090
0091
0092
0093
0094 #endif // _TDataStd_Directory_HeaderFile