/////////////////////////////////////////////////////////////////////////////// 
// 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_FILE_ATTRIBUTES_GROUP_H
#define _BCF_3_0_FILE_ATTRIBUTES_GROUP_H

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

  /** \details
    A class that stores and operates the group of a BCF file attributes.
  */
  class BCF_3_0_EXPORT OdBcfFileAttributesGroup: public OdBcf::OdBcfValidation
  {
  public:
    /** \details 
      Creates a new BCF file attributes group object with default parameters.
    */
    OdBcfFileAttributesGroup();

    /** \details 
      A string that contains the name of the related IFC project.
    */
    OdString m_ifcProject;
    
    /** \details 
      A string that contains the name of the related IFC spatial structure element.
    */
    OdString m_ifcSpatialStructureElement;
    
    /** \details 
      A flag that determines whether the attribute group is an external one (if equals to true) or not (if equals to false).
    */
    bool     m_isExternal;

  protected:

    /** \details
      Checks whether a file attribute 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;
  };

  /** \details
    Contains declarations related to utilities related to working with BCF files content.
  */
  namespace Utils
  {
    inline bool isUnset(const OdBcf_3_0::OdBcfFileAttributesGroup & value)
    {
      return OdBcf::Utils::isUnset(value.m_ifcProject) &&
        OdBcf::Utils::isUnset(value.m_ifcSpatialStructureElement) &&
        OdBcf::Utils::isUnset(value.m_isExternal);
    }
  }

} //namespace OdBcf_3_0

#endif // _BCF_3_0_FILE_ATTRIBUTES_GROUP_H