/////////////////////////////////////////////////////////////////////////////// 
// 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 _DAI_VALIDATOR_H
#define _DAI_VALIDATOR_H

#include "OdaCommon.h"

#define STL_USING_MAP
#include "OdaSTL.h"

#include "OdPerfTimer.h"

#include "daiInstanceValidationTask.h"
#include "daiModelValidationTask.h"
#include "daiExtentValidationTask.h"
#include "daiValidationNotifier.h"

#include "TD_PackPush.h"

/** \details
Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.
*/
namespace OdDAI
{
  /** \details
  A class that implements functionality of work with <link OdDAI::ValidationTask, validation tasks>.
  */
  class DAI_EXPORT Validator : public OdRxObject
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(Validator);
    //DOM-IGNORE-END

  public:

    /** \details
    Defines types of validation results which notifier objects show.
    */
    enum PrintingResult
    {
      /**Validations that finished with an error.*/
      kError = 0x0001,
      /**Validations with unknown result.*/
      kUnknown = 0x0002,
      /**Validations with unset result.*/
      kUnset = 0x0004,
      /**Validation check successfully passed.*/
      kOk = 0x0008,

      /**Validations that didn't pass.*/
      kNotOk = kError | kUnknown | kUnset,
      /**All validation results.*/
      kAll = kError | kUnknown | kUnset | kOk
    };

    /** \details
    Defines validation types to be checked.
    */
    enum ValidationType
    {
      /**Validation of instances.*/
      kInstancesValidation = 0x0001,
      /**Validation of a model*/
      kModelValidation = 0x0002,
      /**Validation of extents.*/
      kExtentsValidation = 0x0004,

      /**All types of validation.*/
      kFullValidation = kInstancesValidation | kModelValidation | kExtentsValidation
    };
    
    /** \details
    Creates a new validator associated with a specified <link OdDAI::InstanceValidationContext, validation context> object.
    \param validationContext [in] A smart pointer to the <link OdDAI::InstanceValidationContext, validation context> object.
    \param pSevices          [in] A raw pointer to an <link OdDAIHostAppServicesBase, OdDAIHostAppServicesBase> object that implements platform specific operation for Data Access Interface.
    \param createTimer       [in] A flag that determines whether the validation timer is created when a new validator is created (equals true) or not (equals false).
    \returns A smart pointer to the created validator.
    */
    static OdSmartPtr<Validator> createObject(OdDAI::InstanceValidationContextPtr &validationContext, OdDAIHostAppServicesBase* pSevices, bool createTimer = false);

    /** \details 
    Creates a new validator with default parameters.
    */
    Validator();
    
    /** \details
    Sets the <exref target="../tkernel_api_cpp/OdDbHostAppProgressMeter.html">progress meter</exref> for the validator object.
    \param progressMeter [in] A raw pointer to the <exref target="../tkernel_api_cpp/OdDbHostAppProgressMeter.html">progress meter</exref> object.
    */
    void setProgressMeter(OdDbHostAppProgressMeter* progressMeter);
    
    /** \details
    Sets the <link OdDAI::Validator::PrintingResult, type of validation result> shown by the notifier object.
    \param printingResult [in] A <link OdDAI::Validator::PrintingResult, validation result type>.
    */
    void setPrintingResult(PrintingResult printingResult);

    /** \details
    Sets the list of <link OdDAI::InstanceValidationTask, instance validation tasks> to execute.
    \param tasksList [in] The list of smart pointers to <link OdDAI::InstanceValidationTask, InstanceValidationTask> class instances.
    */
    void setInstanceTasks(std::list<InstanceValidationTaskPtr> tasksList);
    
    /** \details
    Adds a new <link OdDAI::InstanceValidationTask, instance validation task> to the list of validation tasks.
    \param task [in] A raw pointer to the <link OdDAI::InstanceValidationTask, instance validation task>.
    */
    void addInstanceTask(InstanceValidationTask* task);
    
    /** \details
    Removes all <link OdDAI::InstanceValidationTask, instance validation tasks>.
    */
    void clearInstanceTasks();
    
    /** \details
    Retrieves the number of <link OdDAI::InstanceValidationTask, instance validation tasks> associated with the validator.
    \returns An integer value that contains the number of <link OdDAI::InstanceValidationTask, instance validation tasks>.
    */
    int instanceTasksCount();

    /** \details
    Sets the list of <link OdDAI::ModelValidationTask, model validation tasks> to execute.
    \param tasksList [in] The list of smart pointers to <link OdDAI::ModelValidationTask, model validation task> objects.
    */
    void setModelTasks(std::list<ModelValidationTaskPtr> tasksList);
    
    /** \details
    Adds a new <link OdDAI::ModelValidationTask, model validation task> to the list of validation tasks.
    \param task [in] A raw pointer to the <link OdDAI::ModelValidationTask, model validation task>.
    */
    void addModelTask(ModelValidationTask* task);
    
    /** \details
    Removes all <link OdDAI::ModelValidationTask, model validation tasks>.
    */
    void clearModelTasks();
    
    /** \details
    Retrieves the number of <link OdDAI::ModelValidationTask, model validation tasks> associated with the validator.
    \returns An integer value that contains the number of <link OdDAI::ModelValidationTask, model validation tasks>.
    */
    int modelTasksCount();

    /** \details
    Sets the list of <link OdDAI::ExtentValidationTask, extent validation tasks> to execute.
    \param tasksList [in] The list of smart pointers to <link OdDAI::ExtentValidationTask, extent validation task> objects.
    */
    void setExtentTasks(std::list<ExtentValidationTaskPtr> tasksList);
    
    /** \details
    Adds a new <link OdDAI::ExtentValidationTask, extent validation task> to the list of validation tasks.
    \param task [in] A raw pointer to the <link OdDAI::ExtentValidationTask, extent validation task>.
    */
    void addExtentTask(ExtentValidationTask* task);
    
    /** \details
    Removes all <link OdDAI::ExtentValidationTask, extent validation tasks>.
    */
    void clearExtentTasks();
    
    /** \details
    Retrieves the number of <link OdDAI::ExtentValidationTask, extent validation tasks> associated with the validator.
    \returns An integer value that contains the number of <link OdDAI::ExtentValidationTask, extent validation tasks>.
    */
    int extentTasksCount();

    /** \details
    Adds a new <link OdDAI::InstanceValidationTask, instance>, <link OdDAI::ModelValidationTask, model> or <link OdDAI::ExtentValidationTask, extent> validation task to the list of validation tasks.
    \param task [in] A raw pointer to the <link OdDAI::ValidationTask, validation task>.
    */
    void addValidationTask(ValidationTask* task);
    
    /** \details
    Removes all <link OdDAI::InstanceValidationTask, instance>, <link OdDAI::ModelValidationTask, model> or <link OdDAI::ExtentValidationTask, extent> validation tasks.
    */
    void clearValidationTasks();

    /** \details
    Sets the list of <link OdDAI::ValidationNotifier, validation notifiers>.
    \param tasksList [in] The list of smart pointers to the <link OdDAI::ValidationNotifier, validation notifier> objects.
    */
    void setNotifiers(std::list<ValidationNotifierPtr> tasksList);
    
    /** \details
    Adds a new <link OdDAI::ValidationNotifier, validation notifier> to the list of notifiers.
    \param task [in] A raw pointer to the <link OdDAI::ValidationNotifier, validation notifier>.
    */
    void addNotifier(ValidationNotifier* task);
    
    /** \details
    Removes all <link OdDAI::ValidationNotifier, notifiers>.
    */
    void clearNotifiers();

    /** \details
    Sets the <link OdDAI::Validator::ValidationType, type of validation> to run.
    \param validationType [in] A <link OdDAI::Validator::ValidationType, validation type> value.
    */
    void setValidationType(ValidationType validationType);
    
    /** \details
    Starts execution of <link OdDAI::ValidationTask, validation tasks> assigned to the validator object.
    */
    void run();

    /** \details
    Retrieves the current value of the healing flag. 
    When this flag equals to true, the validation task object tries to heal found validation errors (if the object has an appropriated healer class). 
    \returns true if the healing of the validation errors is enabled; otherwise, the method returns false.
    */
    bool isHealingEnable();
    
    /** \details
    Sets a new value of the healing flag.
    When this flag equals to true, the validation task object tries to heal found validation errors (if the object has an appropriated healer class). 
    Otherwise, this flag equals to false.
    \param healingEnable [in] A new value of the flag.
    */
    void setHealingEnable(bool healingEnable);
    
    /** \details
    Sets a new <link OdDAI::InstanceValidationContext, validation context> for all <link OdDAI::ValidationTask, validation tasks>.
    \param pCtx [in] A smart pointer to the new <link OdDAI::InstanceValidationContext, validation context> object.
    */
    //void setContext(InstanceValidationContextPtr pCtx);

    /** \details
    Retrieves the current time in milliseconds the timer has been started (if the timer is active); if the timer has been stopped, the method retrieves the final validation time.
    \returns An unsigned long that contains time in milliseconds.
    */
    unsigned long timerValue();

  private:

    void modelValidation();
    void instancesValidation();
    void extentsValidation();

    OdDbHostAppProgressMeter* m_progressMeter;
    OdSharedPtr<OdPerfTimerWrapper> m_timer;
    bool m_healingEnable;

    ValidationType m_validationType;
    std::set<OdDAI::Logical> m_printingResults;
    std::list<InstanceValidationTaskPtr> m_instanceValidationTasks;
    std::list<ModelValidationTaskPtr> m_modelValidationTasks;
    std::map<OdAnsiString, std::list<ExtentValidationTaskPtr> > m_extentValidationTask;
    std::list<ValidationNotifierPtr> m_validationNotifiers;
    InstanceValidationContextPtr m_validationContext;
    OdDAIHostAppServicesBase* m_pServices;
  };

  /** \details
  A data type that represents a smart pointer to an <link OdDAI::Validator, Validator> object.
  */
  typedef OdSmartPtr<Validator> ValidatorPtr;
}

#include "TD_PackPop.h"

#endif // _DAI_VALIDATOR_H