/////////////////////////////////////////////////////////////////////////////// 
// 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 _NW_FIND_SELECTION_H_
#define _NW_FIND_SELECTION_H_
#include "NwExport.h"
#include "NwObject.h"

/** \details
  This class represents find selection objects.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwFindSelection : public OdNwObject
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwFindSelection);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates a new OdNwFindSelection object.
  */
  OdNwFindSelection();

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwFindSelection();

  /** \details
    Receives object IDs of selected model items.

    \returns Array of OdNwObjectId of OdNwModelItem objects.
    \remarks
    If path is empty then returns explicit selection, otherwise returns implicit selection resolved by path. 
    For NWD and NWC files the method returns object IDs of model items.
    For NWF file the method returns an OdNwObjectId from external embedded database, if Xref model has NWD or NWC type in the same directory with NWF file.
    Returns empty OdNwObjectIds otherwise.
  */
  virtual OdNwObjectIdArray getItems() const = 0;

  /** \details
    Gets the path of find selection.

    \returns OdString value.
  */
  virtual OdString getPath() const = 0;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for
  OdNwFindSelection object pointers.
*/
typedef OdSmartPtr<OdNwFindSelection> OdNwFindSelectionPtr;

#endif // _NW_FIND_SELECTION_H_