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

#include "OdaCommon.h"
#include "daiExtentValidationTask.h"
#include "IfcValidationExport.h"
#include "daiValidationCommon.h"
#include "daiValidationHealer.h"

/** \details
Contains declarations related to working with IFC files content.
*/
namespace OdIfc
{
  /** \details
  A class which checks clothoid segments parametrization correctness. If segmentstart or segmentlength is of IfcParamValue which
  is more than 2*Pi, this is possibly incorrect value for clothoid.
  */
  class IFC_VALIDATION_EXPORT CurveSegmentParametrizationValidationTask : public OdDAI::ExtentValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_VALIDATION_DECLARE_MEMBERS(CurveSegmentParametrizationValidationTask);
    //DOM-IGNORE-END

  public:

    /**\details
    Creates a new CurveSegmentParametrizationValidationTask instance.
    */
    CurveSegmentParametrizationValidationTask();

    /** \details
    Checks instance parametrization correctness.
    \param instanceCtx [in] A raw pointer to the validation context with validate entity instance.
    \param invalidParams [out] An array of pointers to invalid segments instances and error description.
    \returns True if curve segment have correct parametrization; otherwise, the method returns False.
    */
    virtual OdDAI::Logical validate(OdDAI::InstanceValidationContext* instanceCtx, OdSharedPtr<InvalidValidationParamsBase>& invalidParams) override;

    /** \details
    Retrieves the description of validation task.
    \returns An ANSI string that contains the description of validation task.
    */
    virtual OdAnsiString description() const override;

  };
  /** \details
  A data type that represents a smart pointer to an <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdDAI__CurveSegmentParametrizationValidationTask.html>CurveSegmentParametrizationValidationTask</exref> CurveSegmentParametrizationValidationTask> object.
  */
  typedef OdSmartPtr<CurveSegmentParametrizationValidationTask> CurveSegmentParametrizationValidationTaskPtr;



  /** \details
  A class which fixs problem with incorrect parametrization of clothoid curve segment.
  */
  class IFC_VALIDATION_EXPORT CurveSegmentParametrizationValidationHealer: public OdDAI::ValidationHealer
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(CurveSegmentParametrizationValidationHealer);
    //DOM-IGNORE-END

  public:

    /** \details
    Fixs problem with incorrect parametrization of clothoid curve segment.
    \param model [in] A raw pointer to the <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdDAI__Model.html>Model</exref> model> class to be healing.
    \param invalidParams [in] A pointer to the struct with invalid <exref target="https://docs.opendesign.com/tifc_api_cpp/OdDAIObjectId.html>OdDAI object identifiers</exref> of the entity instances.
    \returns Result of healing. Returns True if healing is successful.
    */
    virtual OdDAI::Logical heal(OdDAI::Model* model, OdDAI::ValidationTask::InvalidValidationParamsBase* invalidParams) override;
  };

  /** \details
  A data type that represents a smart pointer to an <<exref target="https://docs.opendesign.com/tifc_api_cpp/OdDAI__CurveSegmentParametrizationValidationHealer.html>CurveSegmentParametrizationValidationHealer</exref> CurveSegmentParametrizationValidationHealer> object.
  */
  typedef OdSmartPtr<CurveSegmentParametrizationValidationHealer> CurveSegmentParametrizationValidationHealerPtr;
}

#endif // _IFC_CURVE_SEGMENT_PARAMETRIZATION_VALIDATION_TASK_H