include/opencascade/TDataStd_BooleanList.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_BooleanList_HeaderFile
0017 #define _TDataStd_BooleanList_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <NCollection_List.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_OStream.hxx>
0025 #include <Standard_GUID.hxx>
0026
0027 class TDF_Label;
0028 class TDF_RelocationTable;
0029
0030 //! Contains a list of bolleans.
0031 class TDataStd_BooleanList : public TDF_Attribute
0032 {
0033
0034 public:
0035   //! Static methods
0036   //! ==============
0037   //! Returns the ID of the list of booleans attribute.
0038   Standard_EXPORT static const Standard_GUID& GetID();
0039
0040   //! Finds or creates a list of boolean values attribute.
0041   Standard_EXPORT static occ::handle<TDataStd_BooleanList> Set(const TDF_Label& label);
0042
0043   //! Finds or creates a list of boolean values attribute with explicit user defined <guid>.
0044   Standard_EXPORT static occ::handle<TDataStd_BooleanList> Set(const TDF_Label&     label,
0045                                                                const Standard_GUID& theGuid);
0046
0047   Standard_EXPORT TDataStd_BooleanList();
0048
0049   Standard_EXPORT bool IsEmpty() const;
0050
0051   Standard_EXPORT int Extent() const;
0052
0053   Standard_EXPORT void Prepend(const bool value);
0054
0055   Standard_EXPORT void Append(const bool value);
0056
0057   Standard_EXPORT void Clear();
0058
0059   Standard_EXPORT bool First() const;
0060
0061   Standard_EXPORT bool Last() const;
0062
0063   //! 1 - means TRUE,
0064   //! 0 - means FALSE.
0065   Standard_EXPORT const NCollection_List<uint8_t>& List() const;
0066
0067   //! Inserts the <value> before the <index> position.
0068   //! The indices start with 1 .. Extent().
0069   Standard_EXPORT bool InsertBefore(const int index, const bool before_value);
0070
0071   //! Inserts the <value> after the <index> position.
0072   //! The indices start with 1 .. Extent().
0073   Standard_EXPORT bool InsertAfter(const int index, const bool after_value);
0074
0075   //! Removes a value at <index> position.
0076   Standard_EXPORT bool Remove(const int index);
0077
0078   //! Sets the explicit GUID (user defined) for the attribute.
0079   Standard_EXPORT void SetID(const Standard_GUID& theGuid) override;
0080
0081   //! Sets default GUID for the attribute.
0082   Standard_EXPORT void SetID() override;
0083
0084   Standard_EXPORT const Standard_GUID& ID() const override;
0085
0086   Standard_EXPORT void Restore(const occ::handle<TDF_Attribute>& With) override;
0087
0088   Standard_EXPORT occ::handle<TDF_Attribute> NewEmpty() const override;
0089
0090   Standard_EXPORT void Paste(const occ::handle<TDF_Attribute>&       Into,
0091                              const occ::handle<TDF_RelocationTable>& RT) const override;
0092
0093   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0094
0095   //! Dumps the content of me into the stream
0096   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0097
0098   DEFINE_STANDARD_RTTIEXT(TDataStd_BooleanList, TDF_Attribute)
0099
0100 private:
0101   NCollection_List<uint8_t> myList;
0102   Standard_GUID             myID;
0103 };
0104
0105 #endif // _TDataStd_BooleanList_HeaderFile