0026377: Passing Handle objects as arguments to functions as non-const reference...
[occt.git] / src / IFSelect / IFSelect_Selection.hxx
CommitLineData
42cf5bc1 1// Created on: 1992-11-17
2// Created by: Christian CAILLET
3// Copyright (c) 1992-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_Selection_HeaderFile
18#define _IFSelect_Selection_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <MMgt_TShared.hxx>
24#include <Standard_Boolean.hxx>
25class Interface_InterfaceError;
26class Interface_EntityIterator;
27class Interface_Graph;
28class IFSelect_SelectionIterator;
29class TCollection_AsciiString;
30
31
32class IFSelect_Selection;
33DEFINE_STANDARD_HANDLE(IFSelect_Selection, MMgt_TShared)
34
35//! A Selection allows to define a set of Interface Entities.
36//! Entities to be put on an output file should be identified in
37//! a way as independant from such or such execution as possible.
38//! This permits to handle comprehensive criteria, and to replay
39//! them when a new variant of an input file has to be processed.
40//!
41//! Its input can be, either an Interface Model (the very source),
42//! or another-other Selection(s) or any other ouput. All list
43//! computations start from an input Graph (from IFGraph)
44class IFSelect_Selection : public MMgt_TShared
45{
46
47public:
48
49
50 //! Returns the list of selected entities, computed from Input
51 //! given as a Graph. Specific to each class of Selection
52 //! Note that uniqueness of each entity is not required here
53 //! This method can raise an exception as necessary
54 Standard_EXPORT virtual Interface_EntityIterator RootResult (const Interface_Graph& G) const = 0;
55
56 //! Returns the list of selected entities, each of them beeing
57 //! unique. Default definition works from RootResult. According
58 //! HasUniqueResult, UniqueResult returns directly RootResult,
59 //! or build a Unique Result from it with a Graph.
60 Standard_EXPORT Interface_EntityIterator UniqueResult (const Interface_Graph& G) const;
61
62 //! Returns the list of entities involved by a Selection, i.e.
63 //! UniqueResult plus the shared entities (directly or not)
64 Standard_EXPORT virtual Interface_EntityIterator CompleteResult (const Interface_Graph& G) const;
65
66 //! Puts in an Iterator the Selections from which "me" depends
67 //! (there can be zero, or one, or a list).
68 //! Specific to each class of Selection
69 Standard_EXPORT virtual void FillIterator (IFSelect_SelectionIterator& iter) const = 0;
70
71 //! Returns a text which defines the criterium applied by a
72 //! Selection (can be used to be printed, displayed ...)
73 //! Specific to each class
74 Standard_EXPORT virtual TCollection_AsciiString Label() const = 0;
75
76
77
78
92efcf78 79 DEFINE_STANDARD_RTTIEXT(IFSelect_Selection,MMgt_TShared)
42cf5bc1 80
81protected:
82
83
84 //! Returns True if RootResult guarantees uniqueness for each
85 //! Entity. Called by UniqueResult.
86 //! Default answer is False. Can be redefined.
87 Standard_EXPORT virtual Standard_Boolean HasUniqueResult() const;
88
89
90
91private:
92
93
94
95
96};
97
98
99
100
101
102
103
104#endif // _IFSelect_Selection_HeaderFile