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
0030 class IFSelect_SelectDeduct;
0031 DEFINE_STANDARD_HANDLE(IFSelect_SelectDeduct, IFSelect_Selection)
0032
0033 //! A SelectDeduct determines a list of Entities from an Input
0034 //! Selection, by a computation : Output list is not obliged to be
0035 //! a sub-list of Input list
0036 //! (for more specific, see SelectExtract for filtered sub-lists,
0037 //! and SelectExplore for recurcive exploration)
0038 //!
0039 //! A SelectDeduct may use an alternate input for one shot
0040 //! This allows to use an already existing definition, by
0041 //! overloading the input selection by an alternate list,
0042 //! already defined, for one use :
0043 //! If this alternate list is set, InputResult queries it instead
0044 //! of calling the input selection, then clears it immediately
0045 class IFSelect_SelectDeduct : public IFSelect_Selection
0046 {
0047
0048 public:
0049
0050
0051   //! Defines or Changes the Input Selection
0052   Standard_EXPORT void SetInput (const Handle(IFSelect_Selection)& sel);
0053
0054   //! Returns the Input Selection
0055   Standard_EXPORT Handle(IFSelect_Selection) Input() const;
0056
0057   //! Returns True if the Input Selection is defined, False else
0058   Standard_EXPORT Standard_Boolean HasInput() const;
0059
0060   //! Tells if an Alternate List has been set, i.e. : the Alternate
0061   //! Definition is present and set
0062   Standard_EXPORT Standard_Boolean HasAlternate() const;
0063
0064   //! Returns the Alternate Definition
0065   //! It is returned modifiable, hence an already defined
0066   //! SelectPointed can be used
0067   //! But if it was not yet defined, it is created the first time
0068   //!
0069   //! It is exploited by InputResult
0070   Standard_EXPORT Handle(IFSelect_SelectPointed)& Alternate();
0071
0072   //! Returns the Result determined by Input Selection, as Unique
0073   //! if Input Selection is not defined, returns an empty list.
0074   //!
0075   //! If Alternate is set, InputResult takes its definition instead
0076   //! of calling the Input Selection, then clears it
0077   Standard_EXPORT Interface_EntityIterator InputResult (const Interface_Graph& G) const;
0078
0079   //! Puts in an Iterator the Selections from which "me" depends
0080   //! This list contains one Selection : the InputSelection
0081   Standard_EXPORT void FillIterator (IFSelect_SelectionIterator& iter) const Standard_OVERRIDE;
0082
0083
0084
0085
0086   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectDeduct,IFSelect_Selection)
0087
0088 protected:
0089
0090
0091
0092
0093 private:
0094
0095
0096   Handle(IFSelect_Selection) thesel;
0097   Handle(IFSelect_SelectPointed) thealt;
0098
0099
0100 };
0101
0102
0103
0104
0105
0106
0107
0108 #endif // _IFSelect_SelectDeduct_HeaderFile