include/opencascade/TDataStd_ReferenceArray.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_ReferenceArray_HeaderFile
0017 #define _TDataStd_ReferenceArray_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TDataStd_HLabelArray1.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <TDF_Label.hxx>
0025 #include <Standard_OStream.hxx>
0026 #include <Standard_GUID.hxx>
0027
0028 class TDF_RelocationTable;
0029 class TDF_DataSet;
0030
0031
0032 class TDataStd_ReferenceArray;
0033 DEFINE_STANDARD_HANDLE(TDataStd_ReferenceArray, TDF_Attribute)
0034
0035 //! Contains an array of references to the labels.
0036 class TDataStd_ReferenceArray : public TDF_Attribute
0037 {
0038
0039 public:
0040
0041
0042   //! Static methods
0043   //! ==============
0044   //! Returns the ID of the array of references (labels) attribute.
0045   Standard_EXPORT static const Standard_GUID& GetID();
0046
0047   //! Finds or creates an array of reference values (labels) attribute.
0048   Standard_EXPORT static Handle(TDataStd_ReferenceArray) Set (const TDF_Label& label, const Standard_Integer lower, const Standard_Integer upper);
0049
0050   //! Finds or creates an array of reference values (labels) attribute with explicit user defined <guid>.
0051   Standard_EXPORT static Handle(TDataStd_ReferenceArray) Set (const TDF_Label& label,  const Standard_GUID&   theGuid,
0052                                                               const Standard_Integer lower, const Standard_Integer upper);
0053
0054   //! Initialize the inner array with bounds from <lower> to <upper>
0055   Standard_EXPORT void Init (const Standard_Integer lower, const Standard_Integer upper);
0056
0057   //! Sets the <Index>th element of the array to <Value>
0058   //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the internal  array.
0059   Standard_EXPORT void SetValue (const Standard_Integer index, const TDF_Label& value);
0060
0061   //! Sets the explicit GUID (user defined) for the attribute.
0062   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
0063
0064   //! Sets default GUID for the attribute.
0065   Standard_EXPORT void SetID() Standard_OVERRIDE;
0066
0067   //! Returns the value of the <Index>th element of the array.
0068   Standard_EXPORT TDF_Label Value (const Standard_Integer Index) const;
0069
0070   TDF_Label operator () (const Standard_Integer Index) const
0071   {
0072     return Value(Index);
0073   }
0074
0075   //! Returns the lower boundary of the array.
0076   Standard_EXPORT Standard_Integer Lower() const;
0077
0078   //! Returns the upper boundary of the array.
0079   Standard_EXPORT Standard_Integer Upper() const;
0080
0081   //! Returns the number of elements in the array.
0082   Standard_EXPORT Standard_Integer Length() const;
0083
0084   Standard_EXPORT const Handle(TDataStd_HLabelArray1)& InternalArray() const;
0085
0086   Standard_EXPORT void SetInternalArray (const Handle(TDataStd_HLabelArray1)& values, const Standard_Boolean isCheckItems = Standard_True);
0087
0088   Standard_EXPORT TDataStd_ReferenceArray();
0089
0090   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0091
0092   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0093
0094   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0095
0096   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0097
0098   Standard_EXPORT virtual void References (const Handle(TDF_DataSet)& DS) const Standard_OVERRIDE;
0099
0100   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0101
0102   //! Dumps the content of me into the stream
0103   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0104
0105
0106
0107
0108   DEFINE_STANDARD_RTTIEXT(TDataStd_ReferenceArray,TDF_Attribute)
0109
0110 protected:
0111
0112
0113
0114
0115 private:
0116
0117
0118   Handle(TDataStd_HLabelArray1) myArray;
0119   Standard_GUID myID;
0120
0121 };
0122
0123
0124
0125
0126
0127
0128
0129 #endif // _TDataStd_ReferenceArray_HeaderFile