src/TDataStd/TDataStd_ReferenceArray.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_ReferenceArray_HeaderFile
  17 #define _TDataStd_ReferenceArray_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <TDataStd_HLabelArray1.hxx>
  23 #include <TDF_Attribute.hxx>
  24 #include <Standard_Integer.hxx>
  25 #include <TDF_Label.hxx>
  26 #include <Standard_Boolean.hxx>
  27 #include <Standard_OStream.hxx>
  28 class Standard_GUID;
  29 class TDF_Label;
  30 class TDF_Attribute;
  31 class TDF_RelocationTable;
  32 class TDF_DataSet;
  33
  34
  35 class TDataStd_ReferenceArray;
  36 DEFINE_STANDARD_HANDLE(TDataStd_ReferenceArray, TDF_Attribute)
  37
  38 //! Contains an array of references to the labels.
  39 class TDataStd_ReferenceArray : public TDF_Attribute
  40 {
  41
  42 public:
  43
  44
  45   //! Static methods
  46   //! ==============
  47   //! Returns the ID of the array of references (labels) attribute.
  48   Standard_EXPORT static const Standard_GUID& GetID();
  49
  50   //! Finds or creates an array of reference values (labels) attribute.
  51   Standard_EXPORT static Handle(TDataStd_ReferenceArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper);
  52
  53   //! Initialize the inner array with bounds from <lower> to <upper>
  54   Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
  55
  56   //! Sets the <Index>th element of the array to <Value>
  57   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
  58   Standard_EXPORT void SetValue (const Standard_Integer index, const TDF_Label& value);
  59
  60   //! Returns the value of the <Index>th element of the array.
  61   Standard_EXPORT TDF_Label Value (const Standard_Integer Index) const;
  62 TDF_Label operator () (const Standard_Integer Index) const
  63 {
  64   return Value(Index);
  65 }
  66
  67   //! Returns the lower boundary of the array.
  68   Standard_EXPORT Standard_Integer Lower() const;
  69
  70   //! Returns the upper boundary of the array.
  71   Standard_EXPORT Standard_Integer Upper() const;
  72
  73   //! Returns the number of elements in the array.
  74   Standard_EXPORT Standard_Integer Length() const;
  75
  76   Standard_EXPORT const Handle(TDataStd_HLabelArray1)& InternalArray() const;
  77
  78   Standard_EXPORT void SetInternalArray (const Handle(TDataStd_HLabelArray1)& values, const Standard_Boolean isCheckItems = Standard_True);
  79
  80   Standard_EXPORT TDataStd_ReferenceArray();
  81
  82   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  83
  84   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  85
  86   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  87
  88   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  89
  90   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
  91
  92   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  93
  94
  95
  96
  97   DEFINE_STANDARD_RTTIEXT(TDataStd_ReferenceArray,TDF_Attribute)
  98
  99 protected:
 100
 101
 102
 103
 104 private:
 105
 106
 107   Handle(TDataStd_HLabelArray1) myArray;
 108
 109
 110 };
 111
 112
 113
 114
 115
 116
 117
 118 #endif // _TDataStd_ReferenceArray_HeaderFile