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 class Standard_GUID;
  28 class TDF_Label;
  29 class TDF_Attribute;
  30 class TDF_RelocationTable;
  31
  32
  33 class TDataStd_IntegerList;
  34 DEFINE_STANDARD_HANDLE(TDataStd_IntegerList, TDF_Attribute)
  35
  36 //! Contains a list of integers.
  37 class TDataStd_IntegerList : public TDF_Attribute
  38 {
  39
  40 public:
  41
  42
  43   //! Static methods
  44   //! ==============
  45   //! Returns the ID of the list of integer attribute.
  46   Standard_EXPORT static const Standard_GUID& GetID();
  47
  48   //! Finds or creates a list of integer values attribute.
  49   Standard_EXPORT static Handle(TDataStd_IntegerList) Set (const TDF_Label& label);
  50
  51   Standard_EXPORT TDataStd_IntegerList();
  52
  53   Standard_EXPORT Standard_Boolean IsEmpty() const;
  54
  55   Standard_EXPORT Standard_Integer Extent() const;
  56
  57   Standard_EXPORT void Prepend (const Standard_Integer value);
  58
  59   Standard_EXPORT void Append (const Standard_Integer value);
  60
  61   //! Inserts the <value> before the first meet of <before_value>.
  62   Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer value, const Standard_Integer before_value);
  63
  64   //! Inserts the <value> before the <index> position.
  65   //! The indices start with 1 .. Extent().
  66   Standard_EXPORT Standard_Boolean InsertBeforeByIndex (const Standard_Integer index, const Standard_Integer before_value);
  67
  68   //! Inserts the <value> after the first meet of <after_value>.
  69   Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer value, const Standard_Integer after_value);
  70
  71   //! Inserts the <value> after the <index> position.
  72   //! The indices start with 1 .. Extent().
  73   Standard_EXPORT Standard_Boolean InsertAfterByIndex (const Standard_Integer index, const Standard_Integer after_value);
  74
  75   //! Removes the first meet of the <value>.
  76   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer value);
  77
  78   //! Removes a value at <index> position.
  79   Standard_EXPORT Standard_Boolean RemoveByIndex (const Standard_Integer index);
  80
  81   Standard_EXPORT void Clear();
  82
  83   Standard_EXPORT Standard_Integer First() const;
  84
  85   Standard_EXPORT Standard_Integer Last() const;
  86
  87   Standard_EXPORT const TColStd_ListOfInteger& List() const;
  88
  89   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  90
  91   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  92
  93   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  94
  95   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  96
  97   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  98
  99
 100
 101
 102   DEFINE_STANDARD_RTTIEXT(TDataStd_IntegerList,TDF_Attribute)
 103
 104 protected:
 105
 106
 107
 108
 109 private:
 110
 111
 112   TColStd_ListOfInteger myList;
 113
 114
 115 };
 116
 117
 118
 119
 120
 121
 122
 123 #endif // _TDataStd_IntegerList_HeaderFile