/////////////////////////////////////////////////////////////////////////////// 
// 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_DOCUMENT_REFERENCE_GROUP_H
#define _BCF_2_1_DOCUMENT_REFERENCE_GROUP_H

#include "OdPlatformSettings.h"
#include "IfcBuildOptions.h"

#include "OdGUID.h"
#include "BcfValidation.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 {

  /** \details
  A class that stores and operates a document reference group data.
  */
  class BCF_2_1_EXPORT OdBcfDocumentReferenceGroup: public OdBcf::OdBcfValidation
  {
  public:
    /** \details 
    Creates a new document reference group object with default parameters.
    */
    OdBcfDocumentReferenceGroup();

    /** \details
    Retrieves the global unique identifier (GUID) of the document reference group.
    \returns An <exref target="../tkernel_api_cpp/OdGUID.html">OdGUID</exref> object that contains the group GUID.
    \remarks
    The GUID returned by the method can't be modified in the calling subroutine.
    */
    const OdGUID& getGuid() const ODRX_OVERRIDE;

    /** \details 
    A document reference group global unique identifier (GUID).
    */
    OdGUID m_guid;
    
    /** \details 
    A flag that determines whether the document reference group is an external one (if equals to true) or not (if equals to false).
    */
    bool   m_isExternal;

  protected:

    /** \details
   Checks whether the document reference group 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;
  };

} //namespace OdBcf_2_1

#endif // _BCF_2_1_DOCUMENT_REFERENCE_GROUP_H