[occt.git] / src / IFSelect / IFSelect_SelectInList.hxx

// Created on: 1993-01-07
// Created by: Christian CAILLET
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _IFSelect_SelectInList_HeaderFile
#define _IFSelect_SelectInList_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <IFSelect_SelectAnyList.hxx>
#include <Standard_Integer.hxx>
class Standard_OutOfRange;
class Standard_Transient;
class Interface_EntityIterator;


class IFSelect_SelectInList;
DEFINE_STANDARD_HANDLE(IFSelect_SelectInList, IFSelect_SelectAnyList)

//! A SelectInList kind Selection selects a List of an Entity,
//! which is composed of single Entities
//! To know the list on which to work, SelectInList has two
//! deferred methods : NbItems (inherited from SelectAnyList) and
//! ListedEntity (which gives an item as an Entity) which must be
//! defined to get a List in an Entity of the required Type (and
//! consider that list is empty if Entity has not required Type)
//!
//! As for SelectAnyList, if a type of Entity defines several
//! lists, a given sub-class of SelectInList is attached on one
class IFSelect_SelectInList : public IFSelect_SelectAnyList
{

public:

  
  //! Returns an Entity, given its rank in the list
  Standard_EXPORT virtual Handle(Standard_Transient) ListedEntity (const Standard_Integer num, const Handle(Standard_Transient)& ent) const = 0;
  
  //! Puts into the result, the sub-entities of the list, from n1 to
  //! n2 included. Remark that adequation with Entity's type and
  //! length of list has already been made at this stage
  //! Called by RootResult; calls ListedEntity (see below)
  Standard_EXPORT void FillResult (const Standard_Integer n1, const Standard_Integer n2, const Handle(Standard_Transient)& ent, Interface_EntityIterator& result) const Standard_OVERRIDE;


  DEFINE_STANDARD_RTTIEXT(IFSelect_SelectInList,IFSelect_SelectAnyList)

protected:


private:


};


#endif // _IFSelect_SelectInList_HeaderFile
Commit	Line	Data
42cf5bc1	1	// Created on: 1993-01-07
	2	// Created by: Christian CAILLET
	3	// Copyright (c) 1993-1999 Matra Datavision
	4	// Copyright (c) 1999-2014 OPEN CASCADE SAS
	5	//
	6	// This file is part of Open CASCADE Technology software library.
	7	//
	8	// This library is free software; you can redistribute it and/or modify it under
	9	// the terms of the GNU Lesser General Public License version 2.1 as published
	10	// by the Free Software Foundation, with special exception defined in the file
	11	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	12	// distribution for complete text of the license and disclaimer of any warranty.
	13	//
	14	// Alternatively, this file may be used under the terms of Open CASCADE
	15	// commercial license or contractual agreement.
	16
	17	#ifndef _IFSelect_SelectInList_HeaderFile
	18	#define _IFSelect_SelectInList_HeaderFile
	19
	20	#include <Standard.hxx>
	21	#include <Standard_Type.hxx>
	22
	23	#include <IFSelect_SelectAnyList.hxx>
	24	#include <Standard_Integer.hxx>
	25	class Standard_OutOfRange;
	26	class Standard_Transient;
	27	class Interface_EntityIterator;
	28
	29
	30	class IFSelect_SelectInList;
	31	DEFINE_STANDARD_HANDLE(IFSelect_SelectInList, IFSelect_SelectAnyList)
	32
	33	//! A SelectInList kind Selection selects a List of an Entity,
	34	//! which is composed of single Entities
	35	//! To know the list on which to work, SelectInList has two
	36	//! deferred methods : NbItems (inherited from SelectAnyList) and
	37	//! ListedEntity (which gives an item as an Entity) which must be
	38	//! defined to get a List in an Entity of the required Type (and
	39	//! consider that list is empty if Entity has not required Type)
	40	//!
	41	//! As for SelectAnyList, if a type of Entity defines several
	42	//! lists, a given sub-class of SelectInList is attached on one
	43	class IFSelect_SelectInList : public IFSelect_SelectAnyList
	44	{
	45
	46	public:
	47
	48
	49	//! Returns an Entity, given its rank in the list
	50	Standard_EXPORT virtual Handle(Standard_Transient) ListedEntity (const Standard_Integer num, const Handle(Standard_Transient)& ent) const = 0;
	51
	52	//! Puts into the result, the sub-entities of the list, from n1 to
	53	//! n2 included. Remark that adequation with Entity's type and
	54	//! length of list has already been made at this stage
	55	//! Called by RootResult; calls ListedEntity (see below)
79104795	56	Standard_EXPORT void FillResult (const Standard_Integer n1, const Standard_Integer n2, const Handle(Standard_Transient)& ent, Interface_EntityIterator& result) const Standard_OVERRIDE;
42cf5bc1	57
	58
	59
	60
92efcf78	61	DEFINE_STANDARD_RTTIEXT(IFSelect_SelectInList,IFSelect_SelectAnyList)
42cf5bc1	62
	63	protected:
	64
	65
	66
	67
	68	private:
	69
	70
	71
	72
	73	};
	74
	75
	76
	77
	78
	79
	80
	81	#endif // _IFSelect_SelectInList_HeaderFile