// Created on: 2004-11-23
// Created by: Pavel TELKOV
// Copyright (c) 2004-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

// The original implementation Copyright: (C) RINA S.p.A

#ifndef TObj_LabelIterator_HeaderFile
#define TObj_LabelIterator_HeaderFile

#include "TObj_Object.hxx"

#include "TDF_Label.hxx"
#include "TDF_ChildIterator.hxx"
#include "TObj_ObjectIterator.hxx"

/**
 * This class is a basis for OCAF based iterators.
 */

class TObj_LabelIterator : public TObj_ObjectIterator
{

protected:
  /**
   * Constructor
   */

  //! Creates an Empty Iterator
  Standard_EXPORT TObj_LabelIterator();

public:
  /**
   * Constructor
   */

  //! Creates an iterator an initialize it by theLabel and recursive flag.
  //! If isRecursive is true make recursive iterations
  Standard_EXPORT TObj_LabelIterator(const TDF_Label& theLabel, const bool isRecursive = false);

public:
  /**
   * Redefined methods
   */

  //! Returns True if there is a current Item in the iteration.
  bool More() const override { return !myNode.IsNull(); }

  //! Move to the next Item
  Standard_EXPORT void Next() override;

  //! Returns the current item
  occ::handle<TObj_Object> Value() const override { return myObject; }

  //! Returns the label of the current item
  inline const TDF_Label& LabelValue() const { return myNode; }

protected:
  /**
   * Iterating methods
   */

  //! Shifts iterator to the next object
  virtual void MakeStep() = 0;

protected:
  /**
   * Internal methods
   */

  //! Initialize Iterator by the theLabel
  void Init(const TDF_Label& theLabel, const bool isRecursive = false)
  {
    myIterator.Initialize(theLabel, isRecursive);
  }

protected:
  /**
   * Fields
   */
  TDF_Label                myNode;     //!< Current node
  TDF_ChildIterator        myIterator; //!< OCAF Child iterator
  occ::handle<TObj_Object> myObject;   //!< Current Object

public:
  //! CASCADE RTTI
  DEFINE_STANDARD_RTTIEXT(TObj_LabelIterator, TObj_ObjectIterator)
};

//! Define handle class for TObj_LabelIterator
#endif

#ifdef _MSC_VER
#pragma once
#endif