1 // Created on: 2002-01-16
2 // Created by: Michael PONIKAROV
3 // Copyright (c) 2002-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _TDataStd_ExtStringArray_HeaderFile
17 #define _TDataStd_ExtStringArray_HeaderFile
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
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 #include <Standard_GUID.hxx>
30 class TCollection_ExtendedString;
31 class TDF_RelocationTable;
32 class TDF_DeltaOnModification;
35 class TDataStd_ExtStringArray;
36 DEFINE_STANDARD_HANDLE(TDataStd_ExtStringArray, TDF_Attribute)
38 //! ExtStringArray Attribute. Handles an array of UNICODE strings (represented by the TCollection_ExtendedString class).
39 class TDataStd_ExtStringArray : public TDF_Attribute
41 friend class TDataStd_DeltaOnModificationOfExtStringArray;
42 DEFINE_STANDARD_RTTIEXT(TDataStd_ExtStringArray, TDF_Attribute)
47 //! Returns the GUID for the attribute.
48 Standard_EXPORT static const Standard_GUID& GetID();
50 //! Finds, or creates, an ExtStringArray attribute with <lower>
51 //! and <upper> bounds on the specified label.
52 //! If <isDelta> == False, DefaultDeltaOnModification is used.
53 //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
54 //! If attribute is already set, all input parameters are refused and the found
55 //! attribute is returned.
56 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);
58 //! Finds, or creates, an ExtStringArray attribute with explicit user defined <guid>.
59 //! The ExtStringArray attribute is returned.
60 Standard_EXPORT static Handle(TDataStd_ExtStringArray) Set (const TDF_Label& label, const Standard_GUID& theGuid,
61 const Standard_Integer lower, const Standard_Integer upper,
62 const Standard_Boolean isDelta = Standard_False);
65 //! Initializes the inner array with bounds from <lower> to <upper>
66 Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
68 //! Sets the <Index>th element of the array to <Value>
69 //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array.
70 Standard_EXPORT void SetValue (const Standard_Integer Index, const TCollection_ExtendedString& Value);
72 //! Sets the explicit GUID (user defined) for the attribute.
73 Standard_EXPORT void SetID( const Standard_GUID& theGuid) Standard_OVERRIDE;
75 //! Sets default GUID for the attribute.
76 Standard_EXPORT void SetID() Standard_OVERRIDE;
78 //! Returns the value of the <Index>th element of the array
79 Standard_EXPORT const TCollection_ExtendedString& Value (const Standard_Integer Index) const;
81 const TCollection_ExtendedString& operator () (const Standard_Integer Index) const
86 //! Return the lower bound.
87 Standard_EXPORT Standard_Integer Lower() const;
89 //! Return the upper bound
90 Standard_EXPORT Standard_Integer Upper() const;
92 //! Return the number of elements of <me>.
93 Standard_EXPORT Standard_Integer Length() const;
95 //! Sets the inner array <myValue> of the ExtStringArray attribute to <newArray>.
96 //! If value of <newArray> differs from <myValue>, Backup performed and myValue
97 //! refers to new instance of HArray1OfExtendedString that holds <newArray> values
98 //! If <isCheckItems> equal True each item of <newArray> will be checked with each
99 //! item of <myValue> for coincidence (to avoid backup).
100 Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfExtendedString)& newArray, const Standard_Boolean isCheckItems = Standard_True);
102 //! Return the inner array of the ExtStringArray attribute
103 const Handle(TColStd_HArray1OfExtendedString)& Array() const { return myValue; }
105 Standard_Boolean GetDelta() const { return myIsDelta; }
107 //! for internal use only!
108 void SetDelta (const Standard_Boolean isDelta) { myIsDelta = isDelta; }
110 Standard_EXPORT TDataStd_ExtStringArray();
112 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
114 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
116 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
118 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
120 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
122 //! Makes a DeltaOnModification between <me> and
123 //! <anOldAttribute>.
124 Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
126 //! Dumps the content of me into the stream
127 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
131 void RemoveArray() { myValue.Nullify(); }
135 Handle(TColStd_HArray1OfExtendedString) myValue;
136 Standard_Boolean myIsDelta;
141 #endif // _TDataStd_ExtStringArray_HeaderFile