0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_IntegerList.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_IntegerList_HeaderFile
17 #define _TDataStd_IntegerList_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TColStd_ListOfInteger.hxx>
23 #include <TDF_Attribute.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_OStream.hxx>
27 #include <Standard_GUID.hxx>
28
29 class Standard_GUID;
30 class TDF_Label;
31 class TDF_Attribute;
32 class TDF_RelocationTable;
33
34
35 class TDataStd_IntegerList;
36 DEFINE_STANDARD_HANDLE(TDataStd_IntegerList, TDF_Attribute)
37
38 //! Contains a list of integers.
39 class TDataStd_IntegerList : public TDF_Attribute
40 {
41
42 public:
43
44   
45   //! Static methods
46   //! ==============
47   //! Returns the ID of the list of integer attribute.
48   Standard_EXPORT static const Standard_GUID& GetID();
49   
50   //! Finds or creates a list of integer values attribute.
51   Standard_EXPORT static Handle(TDataStd_IntegerList) Set (const TDF_Label& label);
52
53  //! Finds or creates a list of integer values attribute with explicit user defined <guid>.
54   Standard_EXPORT static Handle(TDataStd_IntegerList) Set (const TDF_Label& label, const Standard_GUID&   theGuid);
55
56   Standard_EXPORT TDataStd_IntegerList();
57   
58   Standard_EXPORT Standard_Boolean IsEmpty() const;
59   
60   Standard_EXPORT Standard_Integer Extent() const;
61   
62   Standard_EXPORT void Prepend (const Standard_Integer value);
63   
64   Standard_EXPORT void Append (const Standard_Integer 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   //! Inserts the <value> before the first meet of <before_value>.
73   Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer value, const Standard_Integer before_value);
74   
75   //! Inserts the <value> before the <index> position.
76   //! The indices start with 1 .. Extent().
77   Standard_EXPORT Standard_Boolean InsertBeforeByIndex (const Standard_Integer index, const Standard_Integer before_value);
78   
79   //! Inserts the <value> after the first meet of <after_value>.
80   Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer value, const Standard_Integer after_value);
81   
82   //! Inserts the <value> after the <index> position.
83   //! The indices start with 1 .. Extent().
84   Standard_EXPORT Standard_Boolean InsertAfterByIndex (const Standard_Integer index, const Standard_Integer after_value);
85
86   //! Removes the first meet of the <value>.
87   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer value);
88   
89   //! Removes a value at <index> position.
90   Standard_EXPORT Standard_Boolean RemoveByIndex (const Standard_Integer index);
91   
92   Standard_EXPORT void Clear();
93   
94   Standard_EXPORT Standard_Integer First() const;
95   
96   Standard_EXPORT Standard_Integer Last() const;
97   
98   Standard_EXPORT const TColStd_ListOfInteger& List() const;
99   
100   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
101   
102   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
103   
104   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
105   
106   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
107   
108   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
109   
110   //! Dumps the content of me into the stream
111   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
112
113
114
115
116   DEFINE_STANDARD_RTTIEXT(TDataStd_IntegerList,TDF_Attribute)
117
118 protected:
119
120
121
122
123 private:
124
125
126   TColStd_ListOfInteger myList;
127   Standard_GUID myID;
128
129 };
130
131
132
133
134
135
136
137 #endif // _TDataStd_IntegerList_HeaderFile