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_ListOfDocument.hxx>
0023 #include <Standard_Transient.hxx>
0024 #include <Standard_Integer.hxx>
0025 class CDM_Document;
0026
0027
0028 class CDF_Directory;
0029 DEFINE_STANDARD_HANDLE(CDF_Directory, Standard_Transient)
0030
0031 //! A directory is a collection of documents. There is only one instance
0032 //! of a given document in a directory.
0033 //! put.
0034 class CDF_Directory : public Standard_Transient
0035 {
0036
0037 public:
0038
0039
0040   //! Creates an empty directory.
0041   Standard_EXPORT CDF_Directory();
0042
0043   //! adds a document into the directory.
0044   Standard_EXPORT void Add (const Handle(CDM_Document)& aDocument);
0045
0046   //! removes the document.
0047   Standard_EXPORT void Remove (const Handle(CDM_Document)& aDocument);
0048
0049   //! Returns true if the document aDocument is in the directory
0050   Standard_EXPORT Standard_Boolean Contains (const Handle(CDM_Document)& aDocument) const;
0051
0052   //! returns the last document (if any) which has been added
0053   //! in the directory.
0054   Standard_EXPORT Handle(CDM_Document) Last();
0055
0056   //! returns the number of documents of the directory.
0057   Standard_EXPORT Standard_Integer Length() const;
0058
0059   //! returns true if the directory is empty.
0060   Standard_EXPORT Standard_Boolean IsEmpty() const;
0061
0062
0063 friend class CDF_DirectoryIterator;
0064
0065
0066   DEFINE_STANDARD_RTTIEXT(CDF_Directory,Standard_Transient)
0067
0068 protected:
0069
0070
0071
0072
0073 private:
0074
0075
0076   Standard_EXPORT const CDM_ListOfDocument& List() const;
0077
0078   CDM_ListOfDocument myDocuments;
0079
0080
0081 };
0082
0083
0084
0085
0086
0087
0088
0089 #endif // _CDF_Directory_HeaderFile