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

#include "DbConstraintsExports.h"
#include "DbAssocGlobal.h"
#include "DbObject.h"
#include "IntArray.h"

#include "TD_PackPush.h"

/** \details
  This template class is a specialization of the OdArray class for OdDbAssocEvaluationCallback object pointers.
*/
typedef OdArray<OdDbAssocEvaluationCallback*> OdDbAssocEvaluationCallbackPtrArray;

/** \details
  This class represents the association manager.

  Library: Source code provided.
  <group Contraint_Classes> 
*/
class DBCONSTRAINTS_EXPORT OdDbAssocManager : public OdDbObject
{
public: 
    // ODRX_DECLARE_MEMBERS(OdDbAssocManager);

    /** \details
      Constructor creates an instance of this class.
    */
    explicit OdDbAssocManager();

    /** \details
      Adds evaluation callback.
      \param pCallback [in] global evaluation callback to add.
      \param order [in] specifies callback order. Callbacks with lower order are called first.
    */
    static OdResult addGlobalEvaluationCallback(
      OdDbAssocEvaluationCallback* pCallback, 
      int order
    );

    /** \details
      Removes evaluation callback.
      \param pCallback [in] global evaluation callback to remove.
   */
    static OdResult removeGlobalEvaluationCallback(
      OdDbAssocEvaluationCallback* pCallback
    );

    /** \details
      Retrieves all global evaluation callbacks.
      \param callbacks [out] returned global evaluation callbacks.
      \param orders [out] returned callback orders.
   */
    static void getGlobalEvaluationCallbacks(
      OdDbAssocEvaluationCallbackPtrArray& callbacks, 
      OdIntArray& orders
    );

    /** \details
      Returns the top level for network.
    */
    static OdDbAssocEvaluationCallback* globalEvaluationMultiCallback();

    /** \details
      Evaluates the top level for network.
    */
    static bool evaluateTopLevelNetwork( OdDbDatabase *pDb, 
                                         OdDbAssocEvaluationCallback *pCallback = NULL, 
                                         int callbackOrder = 0);
    
    /** \details
      Checks whether the system is evaluating an action or a network of actions.
    */
    static bool isActionEvaluationInProgress(const OdDbDatabase* db);

    /** \details
      Request to evaluate action, dependency or arbitrary object (all dependencies on it).
    */
    static OdResult requestToEvaluate( const OdDbObjectId& objectId,
      OdDbAssocStatus newStatus = kChangedDirectlyAssocStatus, bool ownedActionsAlso = true);

    /** \details
      Enables or disables evaluation of top level network on editor reactor events.

    \notes
      Disabling auto-evaluation also disables automatic audit of associative data.
      So client should manualy call OdDbAssocManager::auditAssociativeData()
      in cases when assoc. data might be damaged and before evaluating assoc.networks.
      It's crusual to do before first time evaluating assoc.networks of loaded drawing.
    */
    static void enableAutoEvaluation(bool doIt = true);

    /** \details
      \returns true if evaluation of top level network on editor reactor events is enabled.
    */
    static bool autoEvaluationEnabled();

    /** \details
      Performs generic associativity checks and fixes in a given database.
      \param pDb [in] a database to perform associativity auditing in.
      \param traverseWholeDatabase [in] forces loading objects in lazy-load mode.
      \returns eOk on success or error code otherwise.
    */
    static OdResult auditAssociativeData(OdDbDatabase* pDb, bool traverseWholeDatabase);
}; 
#include "TD_PackPop.h"

#endif