/////////////////////////////////////////////////////////////////////////////// 
// 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_3_0_LABELS_H
#define _BCF_3_0_LABELS_H

#include "BcfCommon.h"
#include "OdArray.h"

#include "BcfElement.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 3.0.
*/
namespace OdBcf_3_0 {

  /** \details 
    A class that implements working with the BCF representation of labels.
    Labels are tags, which are used for grouping <exref target="../tifc_api_cpp/OdBcf_3_0__OdBcfTopic.html">BCF topics</exref>.
  */
  class BCF_3_0_EXPORT OdBcfLabels : public OdBcf::OdBcfElement
  {
  public:

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

    /** \details
      Creates a new labels object.
      \param label [in] An array of string objects that contains tag texts.
      \returns A smart pointer to the created <exref target="../tifc_api_cpp/OdBcf_3_0__OdBcfLabels.html">OdBcfLabels</exref> instance.
    */
    static OdSmartPtr<OdBcfLabels> createObject(const OdArray<OdString> &label);

    /** \details
      Reads XML data into ODA data structures.
      \param pParent [in] A pointer to the parent element of the data structure.
      \returns eOk if data is successfully read; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult inFields(TiXmlElement *pParent) ODRX_OVERRIDE;

    /** \details
      Writes data into XML structures.
      \param pParent [in] A pointer to the parent element of the data structure.
      \returns eOk if data is successfully written; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult outFields(TiXmlElement *pParent) const ODRX_OVERRIDE;

    /** \details
      Retrieves the array of labels, which are included in the labels object.
      \returns An array of string objects included in the labels object.
      \remarks 
      The array of labels returned by the method can't be modified in the calling subroutine.
    */
    const OdArray<OdString>& getLabel() const;

    /** \details
      Defines whether the array of labels, which are included in the labels object is not initialized.
      \returns true if the array of labels is not initialized; otherwise, the method returns false.
    */
    bool isLabelUnset() const;


    //DOM-IGNORE-BEGIN
  protected:
    OdArray<OdString> m_label;

    /** \details
      Checks whether the labels 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_3_0__OdBcfLabels.html">OdBcfLabels</exref> object.
  */
  typedef OdSmartPtr<OdBcfLabels> OdBcfLabelsPtr;

} //namespace OdBcf_3_0

#endif // _BCF_3_0_LABELS_H