42cf5bc1 |
1 | // Created on: 1997-08-07 |
2 | // Created by: Jean-Louis Frenkel |
3 | // Copyright (c) 1997-1999 Matra Datavision |
4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
5 | // |
6 | // This file is part of Open CASCADE Technology software library. |
7 | // |
8 | // This library is free software; you can redistribute it and/or modify it under |
9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
10 | // by the Free Software Foundation, with special exception defined in the file |
11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | // distribution for complete text of the license and disclaimer of any warranty. |
13 | // |
14 | // Alternatively, this file may be used under the terms of Open CASCADE |
15 | // commercial license or contractual agreement. |
16 | |
17 | #ifndef _CDF_Directory_HeaderFile |
18 | #define _CDF_Directory_HeaderFile |
19 | |
20 | #include <Standard.hxx> |
21 | #include <Standard_Type.hxx> |
22 | |
23 | #include <CDM_ListOfDocument.hxx> |
24 | #include <Standard_Transient.hxx> |
25 | #include <Standard_Boolean.hxx> |
26 | #include <Standard_Integer.hxx> |
27 | class Standard_NoSuchObject; |
28 | class CDF_DirectoryIterator; |
29 | class CDM_Document; |
30 | |
31 | |
32 | class CDF_Directory; |
33 | DEFINE_STANDARD_HANDLE(CDF_Directory, Standard_Transient) |
34 | |
35 | //! A directory is a collection of documents. There is only one instance |
36 | //! of a given document in a directory. |
37 | //! put. |
38 | class CDF_Directory : public Standard_Transient |
39 | { |
40 | |
41 | public: |
42 | |
43 | |
44 | //! Creates an empty directory. |
45 | Standard_EXPORT CDF_Directory(); |
46 | |
47 | //! adds a document into the directory. |
48 | Standard_EXPORT void Add (const Handle(CDM_Document)& aDocument); |
49 | |
50 | //! removes the document. |
51 | Standard_EXPORT void Remove (const Handle(CDM_Document)& aDocument); |
52 | |
53 | //! Returns true if the document aDocument is in the directory |
54 | Standard_EXPORT Standard_Boolean Contains (const Handle(CDM_Document)& aDocument) const; |
55 | |
56 | //! returns the last document (if any) which has been added |
57 | //! in the directory. |
58 | Standard_EXPORT Handle(CDM_Document) Last(); |
59 | |
60 | //! returns the number of documents of the directory. |
61 | Standard_EXPORT Standard_Integer Length() const; |
62 | |
63 | //! returns true if the directory is empty. |
64 | Standard_EXPORT Standard_Boolean IsEmpty() const; |
65 | |
66 | |
67 | friend class CDF_DirectoryIterator; |
68 | |
69 | |
92efcf78 |
70 | DEFINE_STANDARD_RTTIEXT(CDF_Directory,Standard_Transient) |
42cf5bc1 |
71 | |
72 | protected: |
73 | |
74 | |
75 | |
76 | |
77 | private: |
78 | |
79 | |
80 | Standard_EXPORT const CDM_ListOfDocument& List() const; |
81 | |
82 | CDM_ListOfDocument myDocuments; |
83 | |
84 | |
85 | }; |
86 | |
87 | |
88 | |
89 | |
90 | |
91 | |
92 | |
93 | #endif // _CDF_Directory_HeaderFile |