src/TDataStd/TDataStd_BooleanArray.hxx

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