42cf5bc1 |
1 | // Created on: 2002-01-16 |
2 | // Created by: Michael PONIKAROV |
3 | // Copyright (c) 2002-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_ExtStringArray_HeaderFile |
17 | #define _TDataStd_ExtStringArray_HeaderFile |
18 | |
19 | #include <Standard.hxx> |
20 | #include <Standard_Type.hxx> |
21 | |
22 | #include <TColStd_HArray1OfExtendedString.hxx> |
23 | #include <Standard_Boolean.hxx> |
24 | #include <TDF_Attribute.hxx> |
25 | #include <Standard_Integer.hxx> |
26 | #include <Standard_OStream.hxx> |
27 | class TDataStd_DeltaOnModificationOfExtStringArray; |
28 | class Standard_GUID; |
29 | class TDF_Label; |
30 | class TCollection_ExtendedString; |
31 | class TDF_Attribute; |
32 | class TDF_RelocationTable; |
33 | class TDF_DeltaOnModification; |
34 | |
35 | |
36 | class TDataStd_ExtStringArray; |
37 | DEFINE_STANDARD_HANDLE(TDataStd_ExtStringArray, TDF_Attribute) |
38 | |
39 | //! ExtStringArray Attribute. Handles an |
40 | //! array of UNICODE strings (represented by the |
41 | //! TCollection_ExtendedString class). |
42 | class TDataStd_ExtStringArray : public TDF_Attribute |
43 | { |
44 | |
45 | public: |
46 | |
47 | |
48 | //! class methods |
49 | //! ============= |
50 | //! Returns the GUID for the attribute. |
51 | Standard_EXPORT static const Standard_GUID& GetID(); |
52 | |
53 | //! Finds, or creates, an ExtStringArray attribute with <lower> |
54 | //! and <upper> bounds on the specified label. |
55 | //! If <isDelta> == False, DefaultDeltaOnModification is used. |
56 | //! If <isDelta> == True, DeltaOnModification of the current attribute is used. |
57 | //! If attribute is already set, all input parameters are refused and the found |
58 | //! attribute is returned. |
59 | Standard_EXPORT static Handle(TDataStd_ExtStringArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper, const Standard_Boolean isDelta = Standard_False); |
60 | |
61 | //! Initializes the inner array with bounds from <lower> to <upper> |
62 | Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper); |
63 | |
64 | //! Sets the <Index>th element of the array to <Value> |
65 | //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array. |
66 | Standard_EXPORT void SetValue (const Standard_Integer Index, const TCollection_ExtendedString& Value); |
67 | |
68 | //! Returns the value of the <Index>th element of the array |
69 | Standard_EXPORT const TCollection_ExtendedString& Value (const Standard_Integer Index) const; |
70 | const TCollection_ExtendedString& operator () (const Standard_Integer Index) const |
71 | { |
72 | return Value(Index); |
73 | } |
74 | |
75 | //! Return the lower bound. |
76 | Standard_EXPORT Standard_Integer Lower() const; |
77 | |
78 | //! Return the upper bound |
79 | Standard_EXPORT Standard_Integer Upper() const; |
80 | |
81 | //! Return the number of elements of <me>. |
82 | Standard_EXPORT Standard_Integer Length() const; |
83 | |
84 | //! Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>. |
85 | //! If value of <newArray> differs from <myValue>, Backup performed and myValue |
86 | //! refers to new instance of HArray1OfExtendedString that holds <newArray> values |
87 | //! If <isCheckItems> equal True each item of <newArray> will be checked with each |
88 | //! item of <myValue> for coincidence (to avoid backup). |
89 | Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfExtendedString)& newArray, const Standard_Boolean isCheckItems = Standard_True); |
90 | |
91 | //! Return the inner array of the ExtStringArray attribute |
92 | const Handle(TColStd_HArray1OfExtendedString) Array() const; |
93 | |
94 | Standard_Boolean GetDelta() const; |
95 | |
96 | //! for internal use only! |
97 | void SetDelta (const Standard_Boolean isDelta); |
98 | |
99 | Standard_EXPORT TDataStd_ExtStringArray(); |
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 Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE; |
110 | |
111 | //! Makes a DeltaOnModification between <me> and |
112 | //! <anOldAttribute>. |
113 | Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE; |
114 | |
115 | |
116 | friend class TDataStd_DeltaOnModificationOfExtStringArray; |
117 | |
118 | |
92efcf78 |
119 | DEFINE_STANDARD_RTTIEXT(TDataStd_ExtStringArray,TDF_Attribute) |
42cf5bc1 |
120 | |
121 | protected: |
122 | |
123 | |
124 | |
125 | |
126 | private: |
127 | |
128 | |
129 | void RemoveArray(); |
130 | |
131 | Handle(TColStd_HArray1OfExtendedString) myValue; |
132 | Standard_Boolean myIsDelta; |
133 | |
134 | |
135 | }; |
136 | |
137 | |
138 | #include <TDataStd_ExtStringArray.lxx> |
139 | |
140 | |
141 | |
142 | |
143 | |
144 | #endif // _TDataStd_ExtStringArray_HeaderFile |