0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TDataStd / TDataStd_BooleanList.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_BooleanList_HeaderFile
17 #define _TDataStd_BooleanList_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <TDataStd_ListOfByte.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_BooleanList;
36 DEFINE_STANDARD_HANDLE(TDataStd_BooleanList, TDF_Attribute)
37
38 //! Contains a list of bolleans.
39 class TDataStd_BooleanList : public TDF_Attribute
40 {
41
42 public:
43
44   
45   //! Static methods
46   //! ==============
47   //! Returns the ID of the list of booleans attribute.
48   Standard_EXPORT static const Standard_GUID& GetID();
49   
50   //! Finds or creates a list of boolean values attribute.
51   Standard_EXPORT static Handle(TDataStd_BooleanList) Set (const TDF_Label& label);
52
53   //! Finds or creates a list of boolean values attribute with explicit user defined <guid>.
54   Standard_EXPORT static Handle(TDataStd_BooleanList) Set (const TDF_Label& label, const Standard_GUID& theGuid);
55   
56   Standard_EXPORT TDataStd_BooleanList();
57   
58   Standard_EXPORT Standard_Boolean IsEmpty() const;
59   
60   Standard_EXPORT Standard_Integer Extent() const;
61   
62   Standard_EXPORT void Prepend (const Standard_Boolean value);
63   
64   Standard_EXPORT void Append (const Standard_Boolean value);
65   
66   Standard_EXPORT void Clear();
67   
68   Standard_EXPORT Standard_Boolean First() const;
69   
70   Standard_EXPORT Standard_Boolean Last() const;
71   
72   //! 1 - means TRUE,
73   //! 0 - means FALSE.
74   Standard_EXPORT const TDataStd_ListOfByte& List() const;
75   
76   //! Inserts the <value> before the <index> position.
77   //! The indices start with 1 .. Extent().
78   Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer index, const Standard_Boolean before_value);
79   
80   //! Inserts the <value> after the <index> position.
81   //! The indices start with 1 .. Extent().
82   Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer index, const Standard_Boolean after_value);
83   
84   //! Removes a value at <index> position.
85   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer index);
86
87   //! Sets the explicit GUID (user defined) for the attribute.
88   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
89
90   //! Sets default GUID for the attribute.
91   Standard_EXPORT void SetID() Standard_OVERRIDE;
92
93   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
94   
95   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
96   
97   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
98   
99   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
100   
101   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
102
103   //! Dumps the content of me into the stream
104   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
105
106
107
108
109   DEFINE_STANDARD_RTTIEXT(TDataStd_BooleanList,TDF_Attribute)
110
111 protected:
112
113
114
115
116 private:
117
118
119   TDataStd_ListOfByte myList;
120   Standard_GUID myID;
121
122 };
123
124
125
126
127
128
129
130 #endif // _TDataStd_BooleanList_HeaderFile