/////////////////////////////////////////////////////////////////////////////// 
// 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 _BCF_2_1_TOPIC_FOLDER_H
#define _BCF_2_1_TOPIC_FOLDER_H

#include "BcfCommon.h"
#include "BcfValidation.h"
#include "OdGUID.h"
#include "OdArray.h"
#define STL_USING_MAP
#include "OdaSTL.h"

/** \details
Contains declarations related to working with BCF files content.
*/
namespace OdBcf {

  class OdBcfValidationContext;

}

/** \details
Contains declarations related to working with data of the BCF format version 2.1.
*/
namespace OdBcf_2_1 {

  class OdBcfMarkup;
  typedef OdSmartPtr<OdBcfMarkup> OdBcfMarkupPtr;

  class OdBcfVisualizationInfo;
  typedef OdSmartPtr<OdBcfVisualizationInfo> OdBcfVisualizationInfoPtr;
  
  /** \details 
  A data type that represents an array of smart pointers to <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfVisualizationInfo.html">OdBcfVisualizationInfo</exref> objects.
  */
  typedef OdArray<OdBcfVisualizationInfoPtr> OdBcfVisualizationInfoArray;

  /** \details
  A class that provides functionality for working with a BCF topic folder.
  */
  class BCF_2_1_EXPORT OdBcfTopicFolder : public OdRxObject, public OdBcf::OdBcfValidation
  {
  public:

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

    /** \details
    Creates a new topic folder object.
    \param pMarkup           [in] A smart pointer to the markup of the topic folder.
    \param visualizationInfo [in] An array of smart pointers to visualization information about topics.
    \returns A smart pointer to the created <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfTopicFolder.html">OdBcfTopicFolder</exref> instance.
    */
    static OdSmartPtr<OdBcfTopicFolder> createObject(
      const OdBcfMarkupPtr              &pMarkup, 
      const OdBcfVisualizationInfoArray &visualizationInfo);

    /** \details
    Sets the markup for the topic folder object.
    \param markupValue [in] A smart pointer to the <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfMarkup.html">OdBcfMarkup</exref> object to be set.
    */
    void setMarkup(const OdBcfMarkupPtr &markupValue);

    /** \details
    Retrieves the topic folder's markup.
    \returns A smart pointer to the <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfMarkup.html">OdBcfMarkup</exref> object that represents the markup.
    \remarks 
    The markup object returned by the method can be modified in the calling subroutine.
    */
    OdBcfMarkupPtr& getMarkup();

    /** \details
    Retrieves the topic folder's markup.
    \returns A smart pointer to the <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfMarkup.html">OdBcfMarkup</exref> object that represents the markup.
    \remarks 
    The markup object returned by the method can't be modified in the calling subroutine.
    */
    const OdBcfMarkupPtr& getMarkup() const;

    /** \details
    Defines whether the topic folder's markup is not initialized.
    \returns true if the markup object is not initialized; otherwise, the method returns false.
    */
    bool isMarkupUnset() const;

    /** \details
    Sets the visualization information for the topic folder object.
    \param visualizationInfoValue [in] An array of smart pointers to <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfVisualizationInfo.html">OdBcfVisualizationInfo</exref> objects that represents the visualizaion information to be set.
    */
    void setVisualizationInfo(const OdBcfVisualizationInfoArray &visualizationInfoValue);

    /** \details
    Retrieves the topic folder's visualization information.
    \returns An array of smart pointers to <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfVisualizationInfo.html">OdBcfVisualizationInfo</exref> objects that represents the visualization information.
    \remarks 
    The array returned by the method can be modified in the calling subroutine.
    */
    OdBcfVisualizationInfoArray& getVisualizationInfo();

    /** \details
    Retrieves the topic folder's visualization information.
    \returns An array of smart pointers to <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfVisualizationInfo.html">OdBcfVisualizationInfo</exref> objects that represents the visualization information.
    \remarks 
    The array returned by the method can't be modified in the calling subroutine.
    */
    const OdBcfVisualizationInfoArray& getVisualizationInfo() const;

    /** \details
    Defines whether the topic folder's visualization information is not initialized.
    \returns true if the visualization information is not initialized; otherwise, the method returns false.
    */
    bool isVisualizationInfoUnset() const;


    //DOM-IGNORE-BEGIN
  protected:
    /**A smart pointer to the topic folder's <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfMarkup.html">OdBcfMarkup</exref> object.*/
    OdBcfMarkupPtr              m_pMarkup;
    /**An array of smart pointers to <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfVisualizationInfo.html">OdBcfVisualizationInfo</exref> objects that represents the topic folder's visualization information.*/
    OdBcfVisualizationInfoArray m_visualizationInfo;

    /** \details
    Checks whether the topic folder instance has all required fields initialized.
    \param context [in/out] A raw pointer to the validation context to store results in.
    \returns true if all required fields are initialized; otherwise the method returns false.
    */
    virtual bool validateData(OdBcf::OdBcfValidationContext *context) const ODRX_OVERRIDE;
    //DOM-IGNORE-END
  };

  /** \details 
  A data type that represents a smart pointer to an <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfTopicFolder.html">OdBcfTopicFolder</exref> object.
  */
  typedef OdSmartPtr<OdBcfTopicFolder> OdBcfTopicFolderPtr;

  /** \details
  A data type that represents an STD map of pairs consisting of OdGUID and a pointer to an <exref target="../tifc_api_cpp/OdBcf_2_1__OdBcfTopicFolder.html">OdBcfTopicFolder</exref> objects.
  */
  typedef std::map<OdGUID, OdBcfTopicFolderPtr> OdBcfTopicFolderMap;

} //namespace OdBcf_2_1

#endif // _BCF_2_1_TOPIC_FOLDER_H