Salome HOME
Increment version: 8.5.0
[modules/smesh.git] / src / SMDS / SMDS_SetIterator.hxx
index 05fa6c0464d7396eeaa2828eac3f95be679f2c45..a3bcd44faaeb02f69137d3e0b6cf2d02e1902d5b 100644 (file)
-//  SMESH SMDS : implementaion of Salome mesh data structure
+// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+//  SMESH SMDS : implementation of Salome mesh data structure
 // File      : SMDS_SetIterator.hxx
-// Created   : Mon Feb 27 16:57:43 2006
+// Created   : Feb 27 2006
 // Author    : Edward AGAPOV (eap)
-
-
+//
 #ifndef SMDS_SetIterator_HeaderFile
 #define SMDS_SetIterator_HeaderFile
 
 #include "SMDS_Iterator.hxx"
 
+namespace SMDS {
+
+  ///////////////////////////////////////////////////////////////////////////////
+  /// Accessors to value pointed by iterator
+  ///////////////////////////////////////////////////////////////////////////////
+
+  template<typename VALUE,typename VALUE_SET_ITERATOR>
+  struct SimpleAccessor {
+    static VALUE value(VALUE_SET_ITERATOR it) { return (VALUE) *it; }
+  };
+
+  template<typename VALUE,typename VALUE_SET_ITERATOR>
+  struct KeyAccessor {
+    static VALUE value(VALUE_SET_ITERATOR it) { return (VALUE) it->first; }
+  };
+
+  template<typename VALUE,typename VALUE_SET_ITERATOR>
+  struct ValueAccessor {
+    static VALUE value(VALUE_SET_ITERATOR it) { return (VALUE) it->second; }
+  };
+
+  template<typename VALUE,typename VALUE_SET_ITERATOR>
+  struct PointerAccessor {
+    static VALUE value(VALUE_SET_ITERATOR it) { return (VALUE) &(*it); }
+  };
+
+  ///////////////////////////////////////////////////////////////////////////////
+  /// Filters of value pointed by iterator
+  ///////////////////////////////////////////////////////////////////////////////
+
+  template <typename VALUE>
+  struct PassAllValueFilter
+  {
+    bool operator()(const VALUE& t ) { return true; }
+  };
+
+  template <typename VALUE>
+  struct NonNullFilter
+  {
+    bool operator()(const VALUE& t ) { return bool( t ); }
+  };
+}
+
 ///////////////////////////////////////////////////////////////////////////////
-/// specific SMDS_Iterator iterating over abstract set of values like STL containers
+/// SMDS_Iterator iterating over abstract set of values like STL containers
 ///
 /// BE CAREFUL: iterator pointed value is static_cast'ed to VALUE
 ///
 ///////////////////////////////////////////////////////////////////////////////
 
-template<typename VALUE, typename VALUE_SET_ITERATOR>
+template<typename VALUE,
+         typename VALUE_SET_ITERATOR,
+         typename ACCESOR=SMDS::SimpleAccessor<VALUE,VALUE_SET_ITERATOR>,
+         typename VALUE_FILTER=SMDS::PassAllValueFilter<VALUE> >
 class SMDS_SetIterator : public SMDS_Iterator<VALUE>
 {
 protected:
   VALUE_SET_ITERATOR _beg, _end;
+  VALUE_FILTER _filter;
 public:
   SMDS_SetIterator(const VALUE_SET_ITERATOR & begin,
-                   const VALUE_SET_ITERATOR & end)
-  { init ( begin, end ); }
+                   const VALUE_SET_ITERATOR & end,
+                   const VALUE_FILTER&        filter=VALUE_FILTER())
+  { init ( begin, end, filter ); }
 
   /// Initialization
   virtual void init(const VALUE_SET_ITERATOR & begin,
-                    const VALUE_SET_ITERATOR & end)
-  { _beg = begin; _end = end; }
-
-  /// Return true if and only if there are other object in this iterator
-  virtual bool more() { return _beg != _end; }
-
+                    const VALUE_SET_ITERATOR & end,
+                    const VALUE_FILTER&        filter=VALUE_FILTER())
+  {
+    _beg = begin;
+    _end = end;
+    _filter = filter;
+    if ( more() && !_filter( ACCESOR::value( _beg )))
+      next();
+  }
+  /// Return true iff there are other object in this iterator
+  virtual bool more()
+  {
+    return _beg != _end;
+  }
   /// Return the current object and step to the next one
-  virtual VALUE next() { return static_cast<VALUE>( *_beg++ ); }
+  virtual VALUE next()
+  {
+    VALUE ret = ACCESOR::value( _beg++ );
+    while ( more() && !_filter( ACCESOR::value( _beg )))
+      ++_beg;
+    return ret;
+  }
+};
+
+///////////////////////////////////////////////////////////////////////////////
+/// map iterators
+///////////////////////////////////////////////////////////////////////////////
 
+#include <map>
+/*!
+ * \brief iterator on values of a map
+ */
+template<typename M>
+struct SMDS_mapIterator : public SMDS_SetIterator< typename M::mapped_type, typename M::const_iterator,
+                                                   SMDS::ValueAccessor<typename M::mapped_type,
+                                                                       typename M::const_iterator> > {
+  typedef SMDS_SetIterator< typename M::mapped_type, typename M::const_iterator,
+                            SMDS::ValueAccessor<typename M::mapped_type,
+                                                typename M::const_iterator> > parent_type;
+  SMDS_mapIterator(const M& m):parent_type(m.begin(),m.end()) {}
+};
+/*!
+ * \brief reverse iterator on values of a map
+ */
+template<typename M>
+struct SMDS_mapReverseIterator : public SMDS_SetIterator< typename M::mapped_type,
+                                                          typename M::const_reverse_iterator,
+                                                          SMDS::ValueAccessor<typename M::mapped_type,
+                                                                              typename M::const_reverse_iterator> > {
+  typedef SMDS_SetIterator< typename M::mapped_type, typename M::const_reverse_iterator,
+                            SMDS::ValueAccessor<typename M::mapped_type,
+                                                typename M::const_reverse_iterator> > parent_type;
+  SMDS_mapReverseIterator(const M& m):parent_type(m.rbegin(),m.rend()) {}
+};
+/*!
+ * \brief iterator on keys of a map
+ */
+template<typename M>
+struct SMDS_mapKeyIterator : public SMDS_SetIterator< typename M::key_type, typename M::const_iterator,
+                                                      SMDS::KeyAccessor<typename M::key_type,
+                                                                        typename M::const_iterator> > {
+  typedef SMDS_SetIterator< typename M::key_type, typename M::const_iterator,
+                            SMDS::KeyAccessor<typename M::key_type,
+                                              typename M::const_iterator> > parent_type;
+  SMDS_mapKeyIterator(const M& m):parent_type(m.begin(),m.end()) {}
+};
+/*!
+ * \brief reverse iterator on keys of a map
+ */
+template<typename M>
+struct SMDS_mapKeyReverseIterator : public SMDS_SetIterator< typename M::key_type, typename M::const_iterator,
+                                                            SMDS::KeyAccessor<typename M::key_type,
+                                                                              typename M::const_iterator> > {
+  typedef SMDS_SetIterator< typename M::key_type, typename M::const_iterator,
+                            SMDS::KeyAccessor<typename M::key_type,
+                                              typename M::const_iterator> > parent_type;
+  SMDS_mapKeyReverseIterator(const M& m):parent_type(m.rbegin(),m.rend()) {}
 };
 
+///////////////////////////////////////////////////////////////////////////////
 // useful specifications
+///////////////////////////////////////////////////////////////////////////////
 
 #include <vector>