/////////////////////////////////////////////////////////////////////////////// 
// 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_INTERFACESPECIFICATION_H_
#define _DAI_INTERFACESPECIFICATION_H_

#include "daiInterfacedItem.h"

#include "TD_PackPush.h"

/** \details 
Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.
*/
namespace OdDAI {

  /** \details
  A class that provides an interface specification within a schema definition.
  */
  class DAI_EXPORT InterfaceSpec : public DictionaryInstance
  {
  public:

    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(InterfaceSpec);
    //DOM-IGNORE-END

    /** \details
    Gets current schema identifier name. 
    \returns String containing schema identifier name.
    */
    const OdAnsiString& currentSchemaId() const;

    /** \details
    Sets current schema identifier.
    \param currentSchemaId   [in] String containing schema identifier name.
    */
    void setCurrentSchemaId(const OdAnsiString &currentSchemaId);

    /** \details
    Gets explicit items associated with this instance. 
    \returns An array of smart pointers to ExplicitItemId objects.
    */
    const OdArray<ExplicitItemIdPtr>& explicitItems() const
    {
      return m_explicitItems;
    }

    /** \details
    Appends an explicit item.
    \param explicitItemId   [in] Identifier of an explicit item to append.
    */
    void appendExplicitItem(ExplicitItemIdPtr& explicitItemId)
    {
      m_explicitItems.append(explicitItemId);
    }

    /** \details
    Finds an explicit item by the specified type name.
    \param typeName   [in] Type name by which to search.
    \remarks
    Smart pointer to the explicit item if found.
    */
    ExplicitItemIdPtr findExplicit(const OdAnsiString &typeName)
    {
      for (const auto &explicitItemId : m_explicitItems)
      {
        if (explicitItemId->originalId() == typeName)
        {
          return explicitItemId;
        }
      }
      return{};
    }

  private:

    OdAnsiString m_currentSchemaId;
    OdArray<ExplicitItemIdPtr> m_explicitItems;
  };

  /** \details 
  A data type that represents a smart pointer to an <exref target="OdDAI__InterfaceSpec.html">Interface Specification</exref> object.
  */
  typedef OdSmartPtr<InterfaceSpec> InterfaceSpecPtr;

}

#include "TD_PackPop.h"

#endif // _DAI_INTERFACESPECIFICATION_H_