Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 10:03:54

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_Selection_HeaderFile
0018 #define _IFSelect_Selection_HeaderFile
0019 
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022 
0023 #include <Standard_Transient.hxx>
0024 class Interface_EntityIterator;
0025 class Interface_Graph;
0026 class IFSelect_SelectionIterator;
0027 class TCollection_AsciiString;
0028 
0029 class IFSelect_Selection;
0030 DEFINE_STANDARD_HANDLE(IFSelect_Selection, Standard_Transient)
0031 
0032 //! A Selection allows to define a set of Interface Entities.
0033 //! Entities to be put on an output file should be identified in
0034 //! a way as independent from such or such execution as possible.
0035 //! This permits to handle comprehensive criteria, and to replay
0036 //! them when a new variant of an input file has to be processed.
0037 //!
0038 //! Its input can be, either an Interface Model (the very source),
0039 //! or another-other Selection(s) or any other output.
0040 //! All list computations start from an input Graph (from IFGraph)
0041 class IFSelect_Selection : public Standard_Transient
0042 {
0043 
0044 public:
0045 
0046   //! Returns the list of selected entities, computed from Input
0047   //! given as a Graph. Specific to each class of Selection
0048   //! Note that uniqueness of each entity is not required here
0049   //! This method can raise an exception as necessary
0050   Standard_EXPORT virtual Interface_EntityIterator RootResult (const Interface_Graph& G) const = 0;
0051 
0052   //! Returns the list of selected entities, each of them being
0053   //! unique. Default definition works from RootResult. According
0054   //! HasUniqueResult, UniqueResult returns directly RootResult,
0055   //! or build a Unique Result from it with a Graph.
0056   Standard_EXPORT Interface_EntityIterator UniqueResult (const Interface_Graph& G) const;
0057 
0058   //! Returns the list of entities involved by a Selection, i.e.
0059   //! UniqueResult plus the shared entities (directly or not)
0060   Standard_EXPORT virtual Interface_EntityIterator CompleteResult (const Interface_Graph& G) const;
0061   
0062   //! Puts in an Iterator the Selections from which "me" depends
0063   //! (there can be zero, or one, or a list).
0064   //! Specific to each class of Selection
0065   Standard_EXPORT virtual void FillIterator (IFSelect_SelectionIterator& iter) const = 0;
0066   
0067   //! Returns a text which defines the criterium applied by a
0068   //! Selection (can be used to be printed, displayed ...)
0069   //! Specific to each class
0070   Standard_EXPORT virtual TCollection_AsciiString Label() const = 0;
0071 
0072   DEFINE_STANDARD_RTTIEXT(IFSelect_Selection,Standard_Transient)
0073 
0074 protected:
0075 
0076   //! Returns True if RootResult guarantees uniqueness for each
0077   //! Entity. Called by UniqueResult.
0078   //! Default answer is False. Can be redefined.
0079   Standard_EXPORT virtual Standard_Boolean HasUniqueResult() const;
0080 
0081 };
0082 
0083 #endif // _IFSelect_Selection_HeaderFile