/////////////////////////////////////////////////////////////////////////////// 
// 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_DOCUMENT_H
#define _BCF_3_0_DOCUMENT_H

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

#include "BcfElement.h"
#include "Bcf_3_0DocumentAttributesGroup.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 stores and operates with a document data within the BCF format.
  */
  class BCF_3_0_EXPORT OdBcfDocument : public OdBcf::OdBcfElement
  {
  public:

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

    /** \details
      Creates a new document object.
      \param filename           [in] A string containing filename of the document.
      \param description        [in] A string containing description of the document.
      \param documentAttributes [in] A class containing attributes of the document.
      \returns A smart pointer to the created <exref target="../tifc_api_cpp/OdBcf_3_0__OdBcfDocument.html">OdBcfDocument</exref> instance.
    */
    static OdSmartPtr<OdBcfDocument> createObject(
      const OdString& filename,
      const OdString& description,
      const OdBcfDocumentAttributesGroup& documentAttributes);

    /** \details
      Creates a new document object with default parameters.
    */
    OdBcfDocument();

    /** \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 filename, which is included in the document object.
      \returns A string containing filename included in the document object.
      \remarks 
      The string returned by the method can't be modified in the calling subroutine.
    */
    const OdString& getFilename() const;

    /** \details
      Defines whether the filename string, which is included in the document object is not initialized.
      \returns true if the filename string is not initialized; otherwise, the method returns false.
    */
    bool isFilenameUnset() const;

    /** \details
      Defines whether the description string, which is included in the document object is not initialized.
      \returns true if the description string is not initialized; otherwise, the method returns false.
    */
    const OdString& getDescription() const;

    /** \details
      Defines whether the description string, which is included in the document object is not initialized.
      \returns true if the description string is not initialized; otherwise, the method returns false.
    */
    bool isDescriptionUnset() const;

    /** \details
      Retrieves document attributes, which is included in the document object.
      \returns Document attributes object included in the document object.
      \remarks
      Document attributes object returned by the method can't be modified in the calling subroutine.
    */
    const OdBcfDocumentAttributesGroup& getDocumentAttributes() const;

    /** \details
      Defines whether document attributes object, which is included in the document object is not initialized.
      \returns true if the document attributes object is not initialized; otherwise, the method returns false.
    */
    bool isDocumentAttributesnUnset() const;


    //DOM-IGNORE-BEGIN
  protected:
    OdString m_filename;
    OdString m_description;
    OdBcfDocumentAttributesGroup m_documentAttributes;

    /** \details
      Checks whether the lines 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__OdBcfDocument.html">OdBcfDocument</exref> object.
  */
  typedef OdSmartPtr<OdBcfDocument> OdBcfDocumentPtr;

} //namespace OdBcf_3_0

#endif // _BCF_3_0_DOCUMENT_H