include/opencascade/TDataStd_BooleanArray.hxx

0001 // Created on: 2007-05-29
0002 // Created by: Vlad Romashko
0003 // Copyright (c) 2007-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _TDataStd_BooleanArray_HeaderFile
0017 #define _TDataStd_BooleanArray_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TColStd_HArray1OfByte.hxx>
0022 #include <Standard_Integer.hxx>
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_OStream.hxx>
0025 #include <Standard_GUID.hxx>
0026 class TDF_Label;
0027 class TDF_RelocationTable;
0028
0029
0030 class TDataStd_BooleanArray;
0031 DEFINE_STANDARD_HANDLE(TDataStd_BooleanArray, TDF_Attribute)
0032
0033 //! An array of boolean values.
0034 class TDataStd_BooleanArray : public TDF_Attribute
0035 {
0036
0037 public:
0038
0039
0040   //! Static methods
0041   //! ==============
0042   //! Returns an ID for array.
0043   Standard_EXPORT static const Standard_GUID& GetID();
0044
0045   //! Finds or creates an attribute with internal boolean array.
0046   Standard_EXPORT static Handle(TDataStd_BooleanArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper);
0047
0048   //! Finds or creates an attribute with the array using explicit user defined <guid>.
0049   Standard_EXPORT static Handle(TDataStd_BooleanArray) Set (const TDF_Label& label, const Standard_GUID&   theGuid,
0050                                                             const Standard_Integer lower, const Standard_Integer upper);
0051
0052   //! Initialize the inner array with bounds from <lower> to <upper>
0053   Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
0054
0055   //! Sets the <Index>th element of the array to <Value>
0056   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
0057   Standard_EXPORT void SetValue (const Standard_Integer index, const Standard_Boolean value);
0058
0059   //! Sets the explicit GUID (user defined) for the attribute.
0060   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
0061
0062   //! Sets default GUID for the attribute.
0063   Standard_EXPORT void SetID() Standard_OVERRIDE;
0064
0065   //! Return the value of the <Index>th element of the array.
0066   Standard_EXPORT Standard_Boolean Value (const Standard_Integer Index) const;
0067
0068   Standard_Boolean operator () (const Standard_Integer Index) const
0069   {
0070     return Value(Index);
0071   }
0072
0073   //! Returns the lower boundary of the array.
0074   Standard_EXPORT Standard_Integer Lower() const;
0075
0076   //! Returns the upper boundary of the array.
0077   Standard_EXPORT Standard_Integer Upper() const;
0078
0079   //! Returns the number of elements in the array.
0080   Standard_EXPORT Standard_Integer Length() const;
0081
0082   Standard_EXPORT const Handle(TColStd_HArray1OfByte)& InternalArray() const;
0083
0084   Standard_EXPORT void SetInternalArray (const Handle(TColStd_HArray1OfByte)& values);
0085
0086   Standard_EXPORT TDataStd_BooleanArray();
0087
0088   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0089
0090   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with) Standard_OVERRIDE;
0091
0092   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0093
0094   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0095
0096   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& OS) const Standard_OVERRIDE;
0097
0098   //! Dumps the content of me into the stream
0099   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0100
0101
0102
0103
0104   DEFINE_STANDARD_RTTIEXT(TDataStd_BooleanArray,TDF_Attribute)
0105
0106 protected:
0107
0108
0109
0110
0111 private:
0112
0113
0114   Handle(TColStd_HArray1OfByte) myValues;
0115   Standard_Integer myLower;
0116   Standard_Integer myUpper;
0117   Standard_GUID myID;
0118
0119 };
0120
0121
0122
0123
0124
0125
0126
0127 #endif // _TDataStd_BooleanArray_HeaderFile