include/opencascade/TDataStd_ByteArray.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_ByteArray_HeaderFile
0017 #define _TDataStd_ByteArray_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <NCollection_Array1.hxx>
0022 #include <NCollection_HArray1.hxx>
0023 #include <TDF_Attribute.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <Standard_OStream.hxx>
0026 #include <Standard_GUID.hxx>
0027
0028 class TDF_Label;
0029 class TDF_RelocationTable;
0030 class TDF_DeltaOnModification;
0031
0032 //! An array of Byte (unsigned char) values.
0033 class TDataStd_ByteArray : public TDF_Attribute
0034 {
0035   friend class TDataStd_DeltaOnModificationOfByteArray;
0036   DEFINE_STANDARD_RTTIEXT(TDataStd_ByteArray, TDF_Attribute)
0037 public:
0038   //! Static methods
0039   //! ==============
0040   //! Returns an ID for array.
0041   Standard_EXPORT static const Standard_GUID& GetID();
0042
0043   //! Finds or creates an attribute with the array on the specified label.
0044   //! If <isDelta> == False, DefaultDeltaOnModification is used.
0045   //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
0046   //! If attribute is already set, all input parameters are refused and the found
0047   //! attribute is returned.
0048   Standard_EXPORT static occ::handle<TDataStd_ByteArray> Set(const TDF_Label& label,
0049                                                              const int        lower,
0050                                                              const int        upper,
0051                                                              const bool       isDelta = false);
0052
0053   //! Finds or creates an attribute with byte array and explicit user defined <guid> on the
0054   //! specified label.
0055   Standard_EXPORT static occ::handle<TDataStd_ByteArray> Set(const TDF_Label&     label,
0056                                                              const Standard_GUID& theGuid,
0057                                                              const int            lower,
0058                                                              const int            upper,
0059                                                              const bool           isDelta = false);
0060
0061   //! Initialize the inner array with bounds from <lower> to <upper>
0062   Standard_EXPORT void Init(const int lower, const int upper);
0063
0064   //! Sets the <Index>th element of the array to <Value>
0065   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
0066   //! internal array.
0067   Standard_EXPORT void SetValue(const int index, const uint8_t value);
0068
0069   //! Sets the explicit GUID (user defined) for the attribute.
0070   Standard_EXPORT void SetID(const Standard_GUID& theGuid) override;
0071
0072   //! Sets default GUID for the attribute.
0073   Standard_EXPORT void SetID() override;
0074
0075   //! Return the value of the <Index>th element of the array.
0076   Standard_EXPORT uint8_t Value(const int Index) const;
0077
0078   uint8_t operator()(const int Index) const { return Value(Index); }
0079
0080   //! Returns the lower boundary of the array.
0081   Standard_EXPORT int Lower() const;
0082
0083   //! Returns the upper boundary of the array.
0084   Standard_EXPORT int Upper() const;
0085
0086   //! Returns the number of elements in the array.
0087   Standard_EXPORT int Length() const;
0088
0089   const occ::handle<NCollection_HArray1<uint8_t>>& InternalArray() const { return myValue; }
0090
0091   //! Sets the inner array <myValue> of the attribute to
0092   //! <newArray>. If value of <newArray> differs from <myValue>, Backup performed
0093   //! and myValue refers to new instance of HArray1OfInteger that holds <newArray>
0094   //! values.
0095   //! If <isCheckItems> equal True each item of <newArray> will be checked with each
0096   //! item of <myValue> for coincidence (to avoid backup).
0097   Standard_EXPORT void ChangeArray(const occ::handle<NCollection_HArray1<uint8_t>>& newArray,
0098                                    const bool isCheckItems = true);
0099
0100   bool GetDelta() const { return myIsDelta; }
0101
0102   //! for internal use only!
0103   void SetDelta(const bool isDelta) { myIsDelta = isDelta; }
0104
0105   Standard_EXPORT TDataStd_ByteArray();
0106
0107   Standard_EXPORT const Standard_GUID& ID() const override;
0108
0109   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& with) override;
0110
0111   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0112
0113   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       into,
0114                              const occ::handle<TDF_RelocationTable>& RT) const override;
0115
0116   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& OS) const override;
0117
0118   //! Makes a DeltaOnModification between <me> and
0119   //! <anOldAttribute>.
0120   Standard_EXPORT occ::handle<TDF_DeltaOnModification> DeltaOnModification(
0121     const occ::handle<TDF_Attribute>& anOldAttribute) const override;
0122
0123   //! Dumps the content of me into the stream
0124   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0125
0126 private:
0127   void RemoveArray() { myValue.Nullify(); }
0128
0129 private:
0130   occ::handle<NCollection_HArray1<uint8_t>> myValue;
0131   bool                                      myIsDelta;
0132   Standard_GUID                             myID;
0133 };
0134
0135 #endif // _TDataStd_ByteArray_HeaderFile