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_BooleanArray_HeaderFile 17 #define _TDataStd_BooleanArray_HeaderFile 18 19 #include <Standard.hxx> 20 #include <Standard_Type.hxx> 21 22 #include <TColStd_HArray1OfByte.hxx> 23 #include <Standard_Integer.hxx> 24 #include <TDF_Attribute.hxx> 25 #include <Standard_Boolean.hxx> 26 #include <Standard_OStream.hxx> 27 #include <Standard_GUID.hxx> 28 class Standard_GUID; 29 class TDF_Label; 30 class TDF_Attribute; 31 class TDF_RelocationTable; 32 33 34 class TDataStd_BooleanArray; 35 DEFINE_STANDARD_HANDLE(TDataStd_BooleanArray, TDF_Attribute) 36 37 //! An array of boolean values. 38 class TDataStd_BooleanArray : public TDF_Attribute 39 { 40 41 public: 42 43 44 //! Static methods 45 //! ============== 46 //! Returns an ID for array. 47 Standard_EXPORT static const Standard_GUID& GetID(); 48 49 //! Finds or creates an attribute with internal boolean array. 50 Standard_EXPORT static Handle(TDataStd_BooleanArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper); 51 52 //! Finds or creates an attribute with the array using explicit user defined <guid>. 53 Standard_EXPORT static Handle(TDataStd_BooleanArray) Set (const TDF_Label& label, const Standard_GUID& theGuid, 54 const Standard_Integer lower, const Standard_Integer upper); 55 56 //! Initialize the inner array with bounds from <lower> to <upper> 57 Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper); 58 59 //! Sets the <Index>th element of the array to <Value> 60 //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal array. 61 Standard_EXPORT void SetValue (const Standard_Integer index, const Standard_Boolean value); 62 63 //! Sets the explicit GUID (user defined) for the attribute. 64 Standard_EXPORT void SetID( const Standard_GUID& theGuid) Standard_OVERRIDE; 65 66 //! Sets default GUID for the attribute. 67 Standard_EXPORT void SetID() Standard_OVERRIDE; 68 69 //! Return the value of the <Index>th element of the array. 70 Standard_EXPORT Standard_Boolean Value (const Standard_Integer Index) const; 71 operator ()(const Standard_Integer Index) const72 Standard_Boolean operator () (const Standard_Integer Index) const 73 { 74 return Value(Index); 75 } 76 77 //! Returns the lower boundary of the array. 78 Standard_EXPORT Standard_Integer Lower() const; 79 80 //! Returns the upper boundary of the array. 81 Standard_EXPORT Standard_Integer Upper() const; 82 83 //! Returns the number of elements in the array. 84 Standard_EXPORT Standard_Integer Length() const; 85 86 Standard_EXPORT const Handle(TColStd_HArray1OfByte)& InternalArray() const; 87 88 Standard_EXPORT void SetInternalArray (const Handle(TColStd_HArray1OfByte)& values); 89 90 Standard_EXPORT TDataStd_BooleanArray(); 91 92 Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE; 93 94 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE; 95 96 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE; 97 98 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE; 99 100 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& OS) const Standard_OVERRIDE; 101 102 //! Dumps the content of me into the stream 103 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE; 104 105 106 107 108 DEFINE_STANDARD_RTTIEXT(TDataStd_BooleanArray,TDF_Attribute) 109 110 protected: 111 112 113 114 115 private: 116 117 118 Handle(TColStd_HArray1OfByte) myValues; 119 Standard_Integer myLower; 120 Standard_Integer myUpper; 121 Standard_GUID myID; 122 123 }; 124 125 126 127 128 129 130 131 #endif // _TDataStd_BooleanArray_HeaderFile 132