42cf5bc1 |
1 | // Created on: 2007-05-29 |
2 | // Created by: Vlad Romashko |
3 | // Copyright (c) 2007-2014 OPEN CASCADE SAS |
4 | // |
5 | // This file is part of Open CASCADE Technology software library. |
6 | // |
7 | // This library is free software; you can redistribute it and/or modify it under |
8 | // the terms of the GNU Lesser General Public License version 2.1 as published |
9 | // by the Free Software Foundation, with special exception defined in the file |
10 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
11 | // distribution for complete text of the license and disclaimer of any warranty. |
12 | // |
13 | // Alternatively, this file may be used under the terms of Open CASCADE |
14 | // commercial license or contractual agreement. |
15 | |
16 | #ifndef _TDataStd_ReferenceList_HeaderFile |
17 | #define _TDataStd_ReferenceList_HeaderFile |
18 | |
19 | #include <Standard.hxx> |
20 | #include <Standard_Type.hxx> |
21 | |
22 | #include <TDF_LabelList.hxx> |
23 | #include <TDF_Attribute.hxx> |
24 | #include <Standard_Boolean.hxx> |
25 | #include <Standard_Integer.hxx> |
26 | #include <Standard_OStream.hxx> |
5a1271c8 |
27 | #include <Standard_GUID.hxx> |
28 | |
42cf5bc1 |
29 | class Standard_GUID; |
30 | class TDF_Label; |
31 | class TDF_Attribute; |
32 | class TDF_RelocationTable; |
33 | class TDF_DataSet; |
34 | |
35 | |
36 | class TDataStd_ReferenceList; |
37 | DEFINE_STANDARD_HANDLE(TDataStd_ReferenceList, TDF_Attribute) |
38 | |
39 | //! Contains a list of references. |
40 | class TDataStd_ReferenceList : public TDF_Attribute |
41 | { |
42 | |
43 | public: |
44 | |
45 | |
46 | //! Static methods |
47 | //! ============== |
48 | //! Returns the ID of the list of references (labels) attribute. |
49 | Standard_EXPORT static const Standard_GUID& GetID(); |
50 | |
51 | //! Finds or creates a list of reference values (labels) attribute. |
52 | Standard_EXPORT static Handle(TDataStd_ReferenceList) Set (const TDF_Label& label); |
5a1271c8 |
53 | |
54 | //! Finds or creates a list of reference values (labels) attribute with explicit user defined <guid>. |
55 | Standard_EXPORT static Handle(TDataStd_ReferenceList) Set (const TDF_Label& label, const Standard_GUID& theGuid); |
42cf5bc1 |
56 | |
57 | Standard_EXPORT TDataStd_ReferenceList(); |
58 | |
59 | Standard_EXPORT Standard_Boolean IsEmpty() const; |
60 | |
61 | Standard_EXPORT Standard_Integer Extent() const; |
62 | |
63 | Standard_EXPORT void Prepend (const TDF_Label& value); |
64 | |
65 | Standard_EXPORT void Append (const TDF_Label& value); |
5a1271c8 |
66 | |
67 | //! Sets the explicit GUID (user defined) for the attribute. |
68 | Standard_EXPORT void SetID( const Standard_GUID& theGuid) Standard_OVERRIDE; |
69 | |
70 | //! Sets default GUID for the attribute. |
71 | Standard_EXPORT void SetID() Standard_OVERRIDE; |
72 | |
42cf5bc1 |
73 | //! Inserts the <value> before the first meet of <before_value>. |
74 | Standard_EXPORT Standard_Boolean InsertBefore (const TDF_Label& value, const TDF_Label& before_value); |
75 | |
1ff07227 |
76 | //! Inserts the label before the <index> position. |
77 | //! The indices start with 1 .. Extent(). |
78 | Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer index, const TDF_Label& before_value); |
79 | |
42cf5bc1 |
80 | //! Inserts the <value> after the first meet of <after_value>. |
81 | Standard_EXPORT Standard_Boolean InsertAfter (const TDF_Label& value, const TDF_Label& after_value); |
82 | |
1ff07227 |
83 | //! Inserts the label after the <index> position. |
84 | //! The indices start with 1 .. Extent(). |
85 | Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer index, const TDF_Label& after_value); |
86 | |
42cf5bc1 |
87 | //! Removes the first meet of the <value>. |
88 | Standard_EXPORT Standard_Boolean Remove (const TDF_Label& value); |
89 | |
1ff07227 |
90 | //! Removes a label at "index" position. |
91 | Standard_EXPORT Standard_Boolean Remove (const Standard_Integer index); |
92 | |
42cf5bc1 |
93 | Standard_EXPORT void Clear(); |
94 | |
95 | Standard_EXPORT const TDF_Label& First() const; |
96 | |
97 | Standard_EXPORT const TDF_Label& Last() const; |
98 | |
99 | Standard_EXPORT const TDF_LabelList& List() const; |
100 | |
79104795 |
101 | Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE; |
42cf5bc1 |
102 | |
79104795 |
103 | Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE; |
42cf5bc1 |
104 | |
79104795 |
105 | Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE; |
42cf5bc1 |
106 | |
79104795 |
107 | Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE; |
42cf5bc1 |
108 | |
109 | Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE; |
110 | |
111 | Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE; |
112 | |
bc73b006 |
113 | //! Dumps the content of me into the stream |
114 | Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE; |
115 | |
42cf5bc1 |
116 | |
117 | |
118 | |
92efcf78 |
119 | DEFINE_STANDARD_RTTIEXT(TDataStd_ReferenceList,TDF_Attribute) |
42cf5bc1 |
120 | |
121 | protected: |
122 | |
123 | |
124 | |
125 | |
126 | private: |
127 | |
128 | |
129 | TDF_LabelList myList; |
5a1271c8 |
130 | Standard_GUID myID; |
42cf5bc1 |
131 | |
132 | }; |
133 | |
134 | |
135 | |
136 | |
137 | |
138 | |
139 | |
140 | #endif // _TDataStd_ReferenceList_HeaderFile |