include/vrfobjcore/vrfObjFiltIter.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: vrfObjFiltIter.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/


#ifndef DtVrfObjectFilterIterator_H_
#define DtVrfObjectFilterIterator_H_

#include "vrfobjcore/fltrFcnInf.h"
#include "vrfobjcore/vrfObjIter.h"
#include "vrfobjcore/vrfObject.h"
#include "vrfobjcore/simObjSR.h"
#include "vrfobjcore/vrfObjPred.h"


#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtVrfObjectFilterIterator : public DtVrfObjectIterator
{

private:
   DtVrfObjectFilterIterator();
   DtVrfObjectFilterIterator& operator=(const DtVrfObjectFilterIterator& orig);

public:

   DtVrfObjectFilterIterator(const DtList& list,
      const DtObjectType & filter = DtObjectType::anyType(), 
      bool invertFilter = false);

   DtVrfObjectFilterIterator(const DtList& list,
      DtFilterFcn filter, bool invertFilter = false,
      void* usrData = 0);

   DtVrfObjectFilterIterator(const DtList& list,
      const DtVrfObjectPredicate& predicate);

   DtVrfObjectFilterIterator(const DtVrfObjectFilterIterator& orig);

   virtual ~DtVrfObjectFilterIterator();

   virtual DtVrfObject* first(bool move = true)
      {
         return firstMatch(DtVrfObjectIterator::first(move), false, move); //don't wrap
      };

   virtual DtVrfObject* next(bool move = true)
      {
         return firstMatch(DtVrfObjectIterator::next(move), false, move); //don't wrap
      };

   virtual DtVrfObject* wrapNext(bool move = true)
      {
         return firstMatch(DtVrfObjectIterator::wrapNext(move), true, move); //wrap
      };

   virtual DtVrfObject* prev(bool move = true)
      {
         return lastMatch(DtVrfObjectIterator::prev(move), false, move);  //don't wrap
      };

   virtual DtVrfObject* wrapPrev(bool move = true)
      {
         return lastMatch(DtVrfObjectIterator::wrapPrev(move), true, move); //wrap
      };

   virtual DtVrfObject* last(bool move = true)
      {
         return lastMatch(DtVrfObjectIterator::last(move), false, move); //don't wrap
      };

   virtual DtVrfObject* firstMatch(DtVrfObject* initial, bool wrap, 
      bool move = true);

   virtual DtVrfObject* lastMatch(DtVrfObject* initial, bool wrap, bool move = true);

   virtual void setFilter(const DtVrfObjectPredicate& objectPredicate);

   void setFilter(const DtObjectType& filter);

   virtual void setFilter(DtFilterFcn filter, void* usrData = 0);

   virtual void setInvertFilter(bool invert) { myInvertFilter = invert; };
   virtual bool invertFilter() const { return myInvertFilter; };


protected:
   virtual bool matchFilter(DtVrfObject* simObject) const;

   static bool filterByObjType(const DtVrfObject* object, void* usr);
   static bool filterByPredicate(const DtVrfObject* object, void* usr);

protected:
   DtVrfObjectPredicate* myVrfObjectPredicate; 
   bool                  myDoFiltering;
   DtFilterFcnInfo       myFilterInfo;
   DtObjectType          myFilter;  
   bool                  myInvertFilter;
};

#endif