src/IFSelect/IFSelect_Selection.hxx

   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 <Standard_Transient.hxx>
  24 #include <Standard_Boolean.hxx>
  25 class Interface_InterfaceError;
  26 class Interface_EntityIterator;
  27 class Interface_Graph;
  28 class IFSelect_SelectionIterator;
  29 class TCollection_AsciiString;
  30
  31 class IFSelect_Selection;
  32 DEFINE_STANDARD_HANDLE(IFSelect_Selection, Standard_Transient)
  33
  34 //! A Selection allows to define a set of Interface Entities.
  35 //! Entities to be put on an output file should be identified in
  36 //! a way as independent from such or such execution as possible.
  37 //! This permits to handle comprehensive criteria, and to replay
  38 //! them when a new variant of an input file has to be processed.
  39 //!
  40 //! Its input can be, either an Interface Model (the very source),
  41 //! or another-other Selection(s) or any other output.
  42 //! All list computations start from an input Graph (from IFGraph)
  43 class IFSelect_Selection : public Standard_Transient
  44 {
  45
  46 public:
  47
  48   //! Returns the list of selected entities, computed from Input
  49   //! given as a Graph. Specific to each class of Selection
  50   //! Note that uniqueness of each entity is not required here
  51   //! This method can raise an exception as necessary
  52   Standard_EXPORT virtual Interface_EntityIterator RootResult (const Interface_Graph& G) const = 0;
  53
  54   //! Returns the list of selected entities, each of them being
  55   //! unique. Default definition works from RootResult. According
  56   //! HasUniqueResult, UniqueResult returns directly RootResult,
  57   //! or build a Unique Result from it with a Graph.
  58   Standard_EXPORT Interface_EntityIterator UniqueResult (const Interface_Graph& G) const;
  59
  60   //! Returns the list of entities involved by a Selection, i.e.
  61   //! UniqueResult plus the shared entities (directly or not)
  62   Standard_EXPORT virtual Interface_EntityIterator CompleteResult (const Interface_Graph& G) const;
  63
  64   //! Puts in an Iterator the Selections from which "me" depends
  65   //! (there can be zero, or one, or a list).
  66   //! Specific to each class of Selection
  67   Standard_EXPORT virtual void FillIterator (IFSelect_SelectionIterator& iter) const = 0;
  68
  69   //! Returns a text which defines the criterium applied by a
  70   //! Selection (can be used to be printed, displayed ...)
  71   //! Specific to each class
  72   Standard_EXPORT virtual TCollection_AsciiString Label() const = 0;
  73
  74   DEFINE_STANDARD_RTTIEXT(IFSelect_Selection,Standard_Transient)
  75
  76 protected:
  77
  78   //! Returns True if RootResult guarantees uniqueness for each
  79   //! Entity. Called by UniqueResult.
  80   //! Default answer is False. Can be redefined.
  81   Standard_EXPORT virtual Standard_Boolean HasUniqueResult() const;
  82
  83 };
  84
  85 #endif // _IFSelect_Selection_HeaderFile