include/opencascade/TDataStd_IntegerList.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_IntegerList_HeaderFile
0017 #define _TDataStd_IntegerList_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TColStd_ListOfInteger.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
0031 class TDataStd_IntegerList;
0032 DEFINE_STANDARD_HANDLE(TDataStd_IntegerList, TDF_Attribute)
0033
0034 //! Contains a list of integers.
0035 class TDataStd_IntegerList : public TDF_Attribute
0036 {
0037
0038 public:
0039
0040
0041   //! Static methods
0042   //! ==============
0043   //! Returns the ID of the list of integer attribute.
0044   Standard_EXPORT static const Standard_GUID& GetID();
0045
0046   //! Finds or creates a list of integer values attribute.
0047   Standard_EXPORT static Handle(TDataStd_IntegerList) Set (const TDF_Label& label);
0048
0049  //! Finds or creates a list of integer values attribute with explicit user defined <guid>.
0050   Standard_EXPORT static Handle(TDataStd_IntegerList) Set (const TDF_Label& label, const Standard_GUID&   theGuid);
0051
0052   Standard_EXPORT TDataStd_IntegerList();
0053
0054   Standard_EXPORT Standard_Boolean IsEmpty() const;
0055
0056   Standard_EXPORT Standard_Integer Extent() const;
0057
0058   Standard_EXPORT void Prepend (const Standard_Integer value);
0059
0060   Standard_EXPORT void Append (const Standard_Integer value);
0061
0062   //! Sets the explicit GUID (user defined) for the attribute.
0063   Standard_EXPORT void SetID( const Standard_GUID&  theGuid) Standard_OVERRIDE;
0064
0065   //! Sets default GUID for the attribute.
0066   Standard_EXPORT void SetID() Standard_OVERRIDE;
0067
0068   //! Inserts the <value> before the first meet of <before_value>.
0069   Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer value, const Standard_Integer before_value);
0070
0071   //! Inserts the <value> before the <index> position.
0072   //! The indices start with 1 .. Extent().
0073   Standard_EXPORT Standard_Boolean InsertBeforeByIndex (const Standard_Integer index, const Standard_Integer before_value);
0074
0075   //! Inserts the <value> after the first meet of <after_value>.
0076   Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer value, const Standard_Integer after_value);
0077
0078   //! Inserts the <value> after the <index> position.
0079   //! The indices start with 1 .. Extent().
0080   Standard_EXPORT Standard_Boolean InsertAfterByIndex (const Standard_Integer index, const Standard_Integer after_value);
0081
0082   //! Removes the first meet of the <value>.
0083   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer value);
0084
0085   //! Removes a value at <index> position.
0086   Standard_EXPORT Standard_Boolean RemoveByIndex (const Standard_Integer index);
0087
0088   Standard_EXPORT void Clear();
0089
0090   Standard_EXPORT Standard_Integer First() const;
0091
0092   Standard_EXPORT Standard_Integer Last() const;
0093
0094   Standard_EXPORT const TColStd_ListOfInteger& List() const;
0095
0096   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0097
0098   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0099
0100   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0101
0102   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0103
0104   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0105
0106   //! Dumps the content of me into the stream
0107   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0108
0109
0110
0111
0112   DEFINE_STANDARD_RTTIEXT(TDataStd_IntegerList,TDF_Attribute)
0113
0114 protected:
0115
0116
0117
0118
0119 private:
0120
0121
0122   TColStd_ListOfInteger myList;
0123   Standard_GUID myID;
0124
0125 };
0126
0127
0128
0129
0130
0131
0132
0133 #endif // _TDataStd_IntegerList_HeaderFile