include/opencascade/IFSelect_SelectDeduct.hxx

0001 // Created on: 1992-11-17
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1992-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_SelectDeduct_HeaderFile
0018 #define _IFSelect_SelectDeduct_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_Selection.hxx>
0024 class IFSelect_SelectPointed;
0025 class Interface_EntityIterator;
0026 class Interface_Graph;
0027 class IFSelect_SelectionIterator;
0028
0029 //! A SelectDeduct determines a list of Entities from an Input
0030 //! Selection, by a computation : Output list is not obliged to be
0031 //! a sub-list of Input list
0032 //! (for more specific, see SelectExtract for filtered sub-lists,
0033 //! and SelectExplore for recurcive exploration)
0034 //!
0035 //! A SelectDeduct may use an alternate input for one shot
0036 //! This allows to use an already existing definition, by
0037 //! overloading the input selection by an alternate list,
0038 //! already defined, for one use :
0039 //! If this alternate list is set, InputResult queries it instead
0040 //! of calling the input selection, then clears it immediately
0041 class IFSelect_SelectDeduct : public IFSelect_Selection
0042 {
0043
0044 public:
0045   //! Defines or Changes the Input Selection
0046   Standard_EXPORT void SetInput(const occ::handle<IFSelect_Selection>& sel);
0047
0048   //! Returns the Input Selection
0049   Standard_EXPORT occ::handle<IFSelect_Selection> Input() const;
0050
0051   //! Returns True if the Input Selection is defined, False else
0052   Standard_EXPORT bool HasInput() const;
0053
0054   //! Tells if an Alternate List has been set, i.e. : the Alternate
0055   //! Definition is present and set
0056   Standard_EXPORT bool HasAlternate() const;
0057
0058   //! Returns the Alternate Definition
0059   //! It is returned modifiable, hence an already defined
0060   //! SelectPointed can be used
0061   //! But if it was not yet defined, it is created the first time
0062   //!
0063   //! It is exploited by InputResult
0064   Standard_EXPORT occ::handle<IFSelect_SelectPointed>& Alternate();
0065
0066   //! Returns the Result determined by Input Selection, as Unique
0067   //! if Input Selection is not defined, returns an empty list.
0068   //!
0069   //! If Alternate is set, InputResult takes its definition instead
0070   //! of calling the Input Selection, then clears it
0071   Standard_EXPORT Interface_EntityIterator InputResult(const Interface_Graph& G) const;
0072
0073   //! Puts in an Iterator the Selections from which "me" depends
0074   //! This list contains one Selection : the InputSelection
0075   Standard_EXPORT void FillIterator(IFSelect_SelectionIterator& iter) const override;
0076
0077   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectDeduct, IFSelect_Selection)
0078
0079 private:
0080   occ::handle<IFSelect_Selection>     thesel;
0081   occ::handle<IFSelect_SelectPointed> thealt;
0082 };
0083
0084 #endif // _IFSelect_SelectDeduct_HeaderFile