/////////////////////////////////////////////////////////////////////////////// 
// 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_EXTERNAL_SCHEMA_H_
#define _DAI_EXTERNAL_SCHEMA_H_

#include "daiSchema.h"
#include "daiDomainEquivalentType.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 implements working with a schema definition.
  */
  class DAI_EXPORT ExternalSchema : public DictionaryInstance
  {
  public:

    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(ExternalSchema);
    //DOM-IGNORE-END
    
    /** \details
    Destroys the schema object.
    */
    virtual ~ExternalSchema();

    /** \details
    Retrieves the name of the schema.
    \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the name of the schema.
    */
    const OdAnsiString& name() const;

    /** \details
    Retrieves a <link OdDAI::EntitySet, set of entity definitions> of the schema.
    \returns A <link OdDAI::EntitySet, set of entity definitions> of the schema.
    */
    const SchemaPtr& nativeSchema() const;

    /** \details
    Retrieves an array of <link OdDAI::DomainEquivalentType, domain equivalent types> for the external schema.
    \returns An array of <link OdDAI::DomainEquivalentType, domain equivalent types> for the external schema.
    */
    const OdArray<DomainEquivalentTypePtr>& forTypes() const;

//DOM-IGNORE-BEGIN

  protected:

    /** \details
    Sets a new name for the external schema reference.
    \param name [in] A name for the external schema reference.
    \remarks 
    This method is for internal use only.
    */
    void setName(const OdAnsiString &name);

    /** \details
    Sets a native schema definition for the external schema.
    \param entities [in] A set of entity definitions to assign to the schema definition.
    \remarks
    This method is for internal use only.
    */
    void setNativeSchema(const SchemaPtr& nativeSchema);

    /** \details
    Sets a new set of defined types for the schema.
    \param types [in] A set of defined types to assign to the schema definition.
    \remarks
    This method is for internal use only.
    */
    void setForTypes(const OdArray<DomainEquivalentTypePtr> &forTypes);

    /** The external schema name.*/
    OdAnsiString m_name;
    
    /** Entity definitions that are contained in the schema.*/
    SchemaPtr m_nativeSchema;

    /** Complex entity type definitions. Contains entities not explicitly specified in schema.*/
    OdArray<DomainEquivalentTypePtr> m_forTypes;

    friend class SchemaFiller;

//DOM-IGNORE-END
  };
  
  /** \details 
  A data type that represents a smart pointer to a <link OdDAI::ExternalSchema, ExternalSchema> object.
  */
  typedef OdSmartPtr<ExternalSchema> ExternalSchemaPtr;
}

#include "TD_PackPop.h"

#endif // _DAI_EXTERNAL_SCHEMA_H_