include/opencascade/IFSelect_SelectInList.hxx

0001 // Created on: 1993-01-07
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IFSelect_SelectInList_HeaderFile
0018 #define _IFSelect_SelectInList_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_SelectAnyList.hxx>
0024 #include <Standard_Integer.hxx>
0025 class Standard_Transient;
0026 class Interface_EntityIterator;
0027
0028 class IFSelect_SelectInList;
0029 DEFINE_STANDARD_HANDLE(IFSelect_SelectInList, IFSelect_SelectAnyList)
0030
0031 //! A SelectInList kind Selection selects a List of an Entity,
0032 //! which is composed of single Entities
0033 //! To know the list on which to work, SelectInList has two
0034 //! deferred methods : NbItems (inherited from SelectAnyList) and
0035 //! ListedEntity (which gives an item as an Entity) which must be
0036 //! defined to get a List in an Entity of the required Type (and
0037 //! consider that list is empty if Entity has not required Type)
0038 //!
0039 //! As for SelectAnyList, if a type of Entity defines several
0040 //! lists, a given sub-class of SelectInList is attached on one
0041 class IFSelect_SelectInList : public IFSelect_SelectAnyList
0042 {
0043
0044 public:
0045   //! Returns an Entity, given its rank in the list
0046   Standard_EXPORT virtual Handle(Standard_Transient) ListedEntity(
0047     const Standard_Integer            num,
0048     const Handle(Standard_Transient)& ent) const = 0;
0049
0050   //! Puts into the result, the sub-entities of the list, from n1 to
0051   //! n2 included. Remark that adequation with Entity's type and
0052   //! length of list has already been made at this stage
0053   //! Called by RootResult; calls ListedEntity (see below)
0054   Standard_EXPORT void FillResult(const Standard_Integer            n1,
0055                                   const Standard_Integer            n2,
0056                                   const Handle(Standard_Transient)& ent,
0057                                   Interface_EntityIterator&         result) const Standard_OVERRIDE;
0058
0059   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectInList, IFSelect_SelectAnyList)
0060
0061 protected:
0062 private:
0063 };
0064
0065 #endif // _IFSelect_SelectInList_HeaderFile