/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef _DAI_CONST_ITERATOR_H
#define _DAI_CONST_ITERATOR_H

#include "OdPlatformSettings.h"
#include "OdaCommon.h"
#include "RxValue.h"

#include "daiBuildOptions.h"
#include "daiAggr/daiAggr.h"

#include "TD_PackPush.h"

namespace OdDAI {

  /** \details
  An abstract class that provides an interface of the sequential access to <link OdDAI::Aggr, aggregate> elements (a typified constant iterator).
  */
  class DAI_EXPORT ConstIterator
  {
  public:

    /** \details 
    Destroys the constant iterator object.
    */
    virtual ~ConstIterator() {};

    /** \details
    Move the iterator object to the first element. 
    */
    virtual void beginning() = 0;
    
    /** \details
    Move the iterator object to the next element. 
    \returns true if the next element exists and the iterator was moved to it; otherwise, the method returns false.
    */
    virtual bool next() = 0;

    /** \details
    Move the iterator object to the previous element. 
    \returns true if the previous element exists and the iterator was moved to it; otherwise, the method returns false.
    */
    virtual bool previous() = 0;

    /** \details
    Move the iterator object to the last element. 
    */
    virtual void end() = 0;

    /** \details
    Retrieves the current element (the element of the collection the iterator refers).
    \returns The current element represented with an <exref target="../tkernel_api_cpp/OdRxValue.html">OdRxValue</exref> object.
    */
    virtual const OdRxValue getCurrentMember() const = 0;

    /** \details
    Retrieves the value bound.
    \returns A signed integer that contains the value bound.
    */
    virtual int getValueBound() const = 0;
    
    /** \details
    Tests the current element the iterator refers.
    \returns true if the current element is correct; otherwise, the method returns false.
    */
    virtual bool testCurrentMember() const = 0;

    /** \details
    Retrieves the current element type.
    \returns The current element type represented with an <exref target="../tkernel_api_cpp/OdRxValueType.html">OdRxValueType</exref> object.
    */
    virtual const OdRxValueType& type() const = 0;
  };
  
  /** \details 
  A data type that represents a shared pointer to an <link OdDAI::ConstIterator, ConstIterator> object.
  */
  typedef OdSharedPtr<ConstIterator> ConstIteratorPtr;
}

#include "TD_PackPop.h"

#endif // _DAI_CONST_ITERATOR_H