include/opencascade/CDF_Directory.hxx

0001 // Created on: 1997-08-07
0002 // Created by: Jean-Louis Frenkel
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 _CDF_Directory_HeaderFile
0018 #define _CDF_Directory_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <CDM_Document.hxx>
0023 #include <NCollection_List.hxx>
0024 #include <Standard_Transient.hxx>
0025 #include <Standard_Integer.hxx>
0026 class CDM_Document;
0027
0028 //! A directory is a collection of documents. There is only one instance
0029 //! of a given document in a directory.
0030 //! put.
0031 class CDF_Directory : public Standard_Transient
0032 {
0033
0034 public:
0035   //! Creates an empty directory.
0036   Standard_EXPORT CDF_Directory();
0037
0038   //! adds a document into the directory.
0039   Standard_EXPORT void Add(const occ::handle<CDM_Document>& aDocument);
0040
0041   //! removes the document.
0042   Standard_EXPORT void Remove(const occ::handle<CDM_Document>& aDocument);
0043
0044   //! Returns true if the document aDocument is in the directory
0045   Standard_EXPORT bool Contains(const occ::handle<CDM_Document>& aDocument) const;
0046
0047   //! returns the last document (if any) which has been added
0048   //! in the directory.
0049   Standard_EXPORT occ::handle<CDM_Document> Last();
0050
0051   //! returns the number of documents of the directory.
0052   Standard_EXPORT int Length() const;
0053
0054   //! returns true if the directory is empty.
0055   Standard_EXPORT bool IsEmpty() const;
0056
0057   friend class CDF_DirectoryIterator;
0058
0059   DEFINE_STANDARD_RTTIEXT(CDF_Directory, Standard_Transient)
0060
0061 private:
0062   Standard_EXPORT const NCollection_List<occ::handle<CDM_Document>>& List() const;
0063
0064   NCollection_List<occ::handle<CDM_Document>> myDocuments;
0065 };
0066
0067 #endif // _CDF_Directory_HeaderFile