0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / TDataStd / TDataStd_IntegerArray.hxx
diff --git a/src/TDataStd/TDataStd_IntegerArray.hxx b/src/TDataStd/TDataStd_IntegerArray.hxx
new file mode 100644 (file)
index 0000000..cf69756
--- /dev/null
@@ -0,0 +1,145 @@
+// Created on: 1999-06-16
+// Created by: Sergey RUIN
+// Copyright (c) 1999 Matra Datavision
+// Copyright (c) 1999-2014 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _TDataStd_IntegerArray_HeaderFile
+#define _TDataStd_IntegerArray_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_Type.hxx>
+
+#include <TColStd_HArray1OfInteger.hxx>
+#include <Standard_Boolean.hxx>
+#include <TDF_Attribute.hxx>
+#include <Standard_Integer.hxx>
+#include <Standard_OStream.hxx>
+class TDataStd_DeltaOnModificationOfIntArray;
+class Standard_GUID;
+class TDF_Label;
+class TDF_Attribute;
+class TDF_RelocationTable;
+class TDF_DeltaOnModification;
+
+
+class TDataStd_IntegerArray;
+DEFINE_STANDARD_HANDLE(TDataStd_IntegerArray, TDF_Attribute)
+
+//! Contains an array of integers.
+class TDataStd_IntegerArray : public TDF_Attribute
+{
+
+public:
+
+  
+  //! class methods
+  //! =============
+  //! Returns the GUID for arrays of integers.
+  Standard_EXPORT static const Standard_GUID& GetID();
+  
+  //! Finds or creates on the <label> an integer array attribute
+  //! with the specified <lower> and <upper> boundaries.
+  //! If <isDelta> == False, DefaultDeltaOnModification is used.
+  //! If <isDelta> == True, DeltaOnModification of the current attribute is used.
+  //! If attribute is already set, all input parameters are refused and the found
+  //! attribute is returned.
+  Standard_EXPORT static Handle(TDataStd_IntegerArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper, const Standard_Boolean isDelta = Standard_False);
+  
+  //! Initialize the inner array with bounds from <lower> to <upper>
+  Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
+  
+  //! Sets  the   <Index>th  element  of   the  array to <Value>
+  //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
+  Standard_EXPORT void SetValue (const Standard_Integer Index, const Standard_Integer Value);
+  
+  //! Return the value of  the  <Index>th element of the array
+  Standard_EXPORT Standard_Integer Value (const Standard_Integer Index) const;
+Standard_Integer operator () (const Standard_Integer Index) const
+{
+  return Value(Index);
+}
+  
+  //! Returns the lower boundary of this array of integers.
+  Standard_EXPORT Standard_Integer Lower() const;
+  
+  //! Return the upper boundary of this array of integers.
+  Standard_EXPORT Standard_Integer Upper() const;
+  
+  //! Returns the length of this array of integers in
+  //! terms of the number of elements it contains.
+  Standard_EXPORT Standard_Integer Length() const;
+  
+  //! Sets the inner array <myValue>  of the IntegerArray attribute to
+  //! <newArray>. If value of <newArray> differs from <myValue>, Backup performed
+  //! and myValue refers to new instance of HArray1OfInteger that holds <newArray>
+  //! values
+  //! If <isCheckItems> equal True each item of <newArray> will be checked with each
+  //! item of <myValue> for coincidence (to avoid backup).
+  Standard_EXPORT void ChangeArray (const Handle(TColStd_HArray1OfInteger)& newArray, const Standard_Boolean isCheckItems = Standard_True);
+  
+  //! Return the inner array of the IntegerArray attribute
+    const Handle(TColStd_HArray1OfInteger) Array() const;
+  
+    Standard_Boolean GetDelta() const;
+  
+  //! for  internal  use  only!
+    void SetDelta (const Standard_Boolean isDelta);
+  
+  Standard_EXPORT TDataStd_IntegerArray();
+  
+  Standard_EXPORT const Standard_GUID& ID() const;
+  
+  Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With);
+  
+  Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const;
+  
+  //! Note. Uses inside ChangeArray() method
+  Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const;
+  
+  Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
+  
+  //! Makes a DeltaOnModification between <me> and
+  //! <anOldAttribute>.
+  Standard_EXPORT virtual Handle(TDF_DeltaOnModification) DeltaOnModification (const Handle(TDF_Attribute)& anOldAttribute) const Standard_OVERRIDE;
+
+
+friend class TDataStd_DeltaOnModificationOfIntArray;
+
+
+  DEFINE_STANDARD_RTTI(TDataStd_IntegerArray,TDF_Attribute)
+
+protected:
+
+
+
+
+private:
+
+  
+    void RemoveArray();
+
+  Handle(TColStd_HArray1OfInteger) myValue;
+  Standard_Boolean myIsDelta;
+
+
+};
+
+
+#include <TDataStd_IntegerArray.lxx>
+
+
+
+
+
+#endif // _TDataStd_IntegerArray_HeaderFile