///////////////////////////////////////////////////////////////////////////////
// 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_IMPLICIT_SELECTION_H__
#define __NW_IMPLICIT_SELECTION_H__

#include "NwObject.h"
#include "NwSelectionSetsTypes.h"

class OdNwSearch;

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

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

/**
 This class represents selection variant.
 
 <group OdNw_Classes>
*/
class NWDBEXPORT OdNwSelectionVariant : public OdNwObject
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwSelectionVariant);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwSelectionVariant();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwSelectionVariant();
  
  /** \details
    Receives the list of path link.

    \returns List of the OdNwObjectId objects.
    \remarks
    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.
  */
  OdNwObjectIdArray getPathLinkList() const;
  
  /** \details
    Receives the type of selection set item.

    \returns One of the enumerated items from the NwSelectionSetItemType::Enum enumerated type.
    \remarks
     Selection set item type can be one of the following:

     <table>
     Name                                        Value Description
     NwSelectionSetItemType::Enum::PATHLINK       0     Path link
     NwSelectionSetItemType::Enum::FINDCONDITION  1     Find condition
     NwSelectionSetItemType::Enum::NONE           2     None
     NwSelectionSetItemType::Enum::ZONESPEC       3     Zone spec
     </table>
  */
  NwSelectionSetItemType::Enum getItemType() const;
  
  /** \details
    Gets pointer to class that contains find condition results.

    \returns OdNwFindSpecPtr as pointer to OdNwFindSpec.

    \remarks
    The method is deprecated since release 25.5. Use the getSearch method instead.
  */
  OdNwFindSpecPtr getFindSpec() const;

  /** \details
    Receives the search object with setted condtion lists and selection.

    \returns OdNwSearchPtr as pointer to OdNwSearch with search object.

    \remarks
    The method is return object if selection variant has NwSelectionSetItemType::FINDCONDITION mode.
  */
  OdNwSearchPtr getSearch() const;
};

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

#endif /* __NW_IMPLICIT_SELECTION_H__ */