/////////////////////////////////////////////////////////////////////////////// 
// 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_BIM_SNIPPET_H
#define _BCF_3_0_BIM_SNIPPET_H

#include "BcfCommon.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 BimSnippet data type.
  */
  class BCF_3_0_EXPORT OdBcfBimSnippet : public OdBcf::OdBcfElement
  {
  public:

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

    /** \details
      Creates a new bim snippet object.
      \param reference       [in] A string containing reference of the bim snippet.
      \param referenceSchema [in] A string containing reference schema of the bim snippet.
      \param snippetType     [in] A string containing type of the bim snippet.
      \param isExternal      [in] A boolean signifying if the bim snippet is external.
      \returns A smart pointer to the created <exref target="../tifc_api_cpp/OdBcf_3_0__OdBcfBimSnippet.html">OdBcfBimSnippet</exref> instance.
    */
    static OdSmartPtr<OdBcfBimSnippet> createObject(
      const OdString& reference,
      const OdString& referenceSchema,
      const OdString& snippetType,
      bool isExternal = false);

    /** \details
      Creates a new BimSnippet object with default parameters.
    */
    OdBcfBimSnippet();

    /** \details
      Reads specified 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 snippet's reference.
      \returns A string that contains information about the snippet's reference.
      \remarks
      The string with information about the reference returned by the method can't be modified in the calling subroutine.
    */
    const OdString& getReference() const;

    /** \details
      Defines whether the reference of the snippet object is not initialized.
      \returns true if the reference is not initialized; otherwise, the method returns false.
    */
    bool isReferenceUnset() const;

    /** \details
      Retrieves the snippet's reference schema.
      \returns A string that contains information about the snippet's reference schema.
      \remarks
      The string with information about the reference schema returned by the method can't be modified in the calling subroutine.
    */
    const OdString& getReferenceSchema() const;

    /** \details
      Defines whether the reference schema of the snippet object is not initialized.
      \returns true if the reference schema is not initialized; otherwise, the method returns false.
    */
    bool isReferenceSchemaUnset() const;

    /** \details
      Retrieves the snippet's type.
      \returns A string that contains information about the snippet's type.
      \remarks
      The string with information about the snippet type returned by the method can't be modified in the calling subroutine.
    */
    const OdString& getSnippetType() const;

    /** \details
      Defines whether the type of the snippet object is not initialized.
      \returns true if the snippet type is not initialized; otherwise, the method returns false.
    */
    bool isSnippetTypeUnset() const;

    /** \details
      Retrieves whether the snippet is external.
      \returns A true if the snippet is external; otherwise, the method returns false.
      \remarks
      The boolean value returned by the method can't be modified in the calling subroutine.
    */
    const bool& getIsExternal() const;

    //DOM-IGNORE-BEGIN
  protected:
    OdString m_reference;
    OdString m_referenceSchema;
    OdString m_snippetType;
    bool     m_isExternal;

    /** \details
      Checks whether the 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__OdBcfBimSnippet.html">OdBcfBimSnippet</exref> object.
  */
  typedef OdSmartPtr<OdBcfBimSnippet> OdBcfBimSnippetPtr;

} //namespace OdBcf_3_0

#endif // _BCF_3_0_BIM_SNIPPET_H