/////////////////////////////////////////////////////////////////////////////// 
// 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_VALIDATION_CONTEXT_H
#define _BCF_VALIDATION_CONTEXT_H

#include "BcfCommon.h"
#include "BcfValidation.h"

#include "RxObject.h"
#include "OdHashSet.h"
#include "OdHashMap.h"

/** \details
Contains declarations related to working with BCF files content.
*/
namespace OdBcf {

  using ValidationMap = OdHashMap<const OdBcfValidation*, OdResult, OdHashSet_PtrHasher<OdBcfValidation>>;

  /** \details
  A class that provides the interface for collecting validation results of BCF data types.
  */
  class BCF_EXPORT OdBcfValidationContext : public OdRxObject
  {
  public:

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

    /** \details
    Retrieves the map of validation errors.
    \returns constant map of validations.
    */
    const ValidationMap& validationMap() const;

    /** \details
    Retrieves the map of validation errors.
    \returns map of validations.
    */
    ValidationMap& validationMap();

    /** \details
    Adds validation to the map.
    \param pElement [in] A raw pointer to element to add.
    \param res      [in] Validation result for the element.
    \returns true if validation was successfully added; otherwise, the method returns false. 
    \remarks 
    If result alredy exists for the element it won't be overridden.
    */
    bool addValidation(const OdBcfValidation* pElement, OdResult res);

    /** \details
    Clears the map of validation errors.
    */
    void clear();

  protected:
    ValidationMap m_validationMap;
  };

  /** \details
  A data type that represents a smart pointer to an OdBcfValidationContext object.
  */
  typedef OdSmartPtr<OdBcfValidationContext> OdBcfValidationContextPtr;

} //namespace OdBcf

#endif // _BCF_VALIDATION_CONTEXT_H