/////////////////////////////////////////////////////////////////////////////// 
// 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_UNSUPPORTED_SYMBOLS_VALIDATION_TASK_H
#define _DAI_UNSUPPORTED_SYMBOLS_VALIDATION_TASK_H

#include "daiInstanceValidationTask.h"
#include "daiValidationHealer.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 validation string with unsupported symbols.
  */
  class DAI_EXPORT UnsupportedSymbolsValidationTask 
    : public InstanceValidationTask
  {
    //DOM-IGNORE-BEGIN
    ODRX_VALIDATION_DECLARE_MEMBERS(UnsupportedSymbolsValidationTask);
    //DOM-IGNORE-END

  public:

    /** \details
    Checks whether a specified instance has string attributes with unsupported symbols and forms a list of such attributes.
    \param pInstanceCtx  [in] A raw pointer to the <link OdDAI::InstanceValidationContext, instance validation context> object that contains an entity instance to be validated.
    \param invalidParams [out] A shared pointer to an <link OdDAI::ValidationTask::InvalidValidationParamsBase, InvalidValidationParamsBase> object. 
                               After method execution, this object contains an array of pointers to <link OdDAI::Attribute, attributes> that have incorrect widths.
    \returns 
    * <link OdDAI::Logical::True, True> if the validation passes. This means that all string attributes have correct widths or the specified instance doesn't have string attributes.
    * <link OdDAI::Logical::False, False> if any string attribute width is incorrect.
    * <link OdDAI::Logical::Unknown, Unknown> if the expression of any string width constraint is unknown or is not defined.
    */
    OdDAI::Logical validate(OdDAI::InstanceValidationContext* pInstanceCtx, OdSharedPtr<InvalidValidationParamsBase>& invalidParams) final;

    /** \details
    Retrieves the description of the validation task.
    \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the description of the validation task.
    */
    OdAnsiString description() const final;
  };

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

namespace OdDAI
{
  class DAI_EXPORT UnsupportedSymbolsValidationHealer
    : public OdDAI::ValidationHealer
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(UnsupportedSymbolsValidationHealer);
    //DOM-IGNORE-END

  public:
    /** \details
    Fixs problem with unsupported symbols in string.
    \param model [in] A raw pointer to the <exref target="https://docs.opendesign.com/tifc_api_cpp/OdDAI__Model.html>Model</exref> 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 <link OdDAI::UnsupportedSymbolsValidationHealer, UnsupportedSymbolsValidationHealer> object.
  */
  typedef OdSmartPtr<UnsupportedSymbolsValidationHealer> UnsupportedSymbolsValidationHealerPtr;

}

#include "TD_PackPop.h"

#endif //_DAI_STRING_WIDTH_VALIDATION_TASK_H