IIndexHelperSet.hpp

#ifndef DM_IINDEX_HELPER_SET_HPP_INCLUDED
#define DM_IINDEX_HELPER_SET_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif


#include "DM/config.hpp"
#include "DM/Iterator.hpp"

DM_NAMESPACE_BEGIN

/// \brief Helper class for traversing a IndexMap object in multiple stages
class DM_API IIndexHelper : public ObjectBase 
{
protected:
  virtual ~IIndexHelper() {}

public:
  virtual IIndexHelper* clone() const = 0;

  virtual int id() const = 0;           ///< corresponding class id
  virtual int64_t counter() const = 0;  ///< number of points/object that have been traversed in this class
  virtual int64_t index() const = 0;    ///< next index for the corresponding IndexMap object that has to be considered
};

typedef Handle<IIndexHelper> IndexHelperHandle;



/// \brief Helper class for traversing a IndexMapSet object in multiple stages
class DM_API IIndexHelperSet : public ObjectBase
{
public:
  // Iterator typedefs ============================================================================
  typedef ConstIterator< IIndexHelper >       const_iterator;   

  static IIndexHelperSet* New();  ///< create an empty index helper set

  // General member functions ====================================================================
  virtual IIndexHelperSet* clone()  const = 0;          ///< clone object

  virtual int64_t size()  const = 0;                    ///< size of index map set

  virtual IIndexHelper& operator[](const int id) = 0;             ///< access index helper by class id
  virtual const IIndexHelper& operator[](const int id) const = 0; ///< const access index helper by class id

  virtual const_iterator beginIndexHelper() const = 0;
  virtual const_iterator endIndexHelper() const = 0;
};

typedef Handle<IIndexHelperSet> IndexHelperSetHandle;

DM_NAMESPACE_END

#endif //DM_IINDEX_HELPER_SET_HPP_INCLUDED