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