include/opencascade/IFSelect_SelectSent.hxx

0001 // Created on: 1995-10-25
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1995-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_SelectSent_HeaderFile
0018 #define _IFSelect_SelectSent_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <IFSelect_SelectExtract.hxx>
0025 class Interface_EntityIterator;
0026 class Interface_Graph;
0027 class Standard_Transient;
0028 class Interface_InterfaceModel;
0029 class TCollection_AsciiString;
0030
0031 //! This class returns entities according sending to a file
0032 //! Once a model has been loaded, further sendings are recorded
0033 //! as status in the graph (for each value, a count of sendings)
0034 //!
0035 //! Hence, it is possible to query entities : sent ones (at least
0036 //! once), non-sent (i.e. remaining) ones, duplicated ones, etc...
0037 //!
0038 //! This selection performs this query
0039 class IFSelect_SelectSent : public IFSelect_SelectExtract
0040 {
0041
0042 public:
0043   //! Creates a SelectSent :
0044   //! sentcount = 0 -> remaining (non-sent) entities
0045   //! sentcount = 1, atleast = True (D) -> sent (at least once)
0046   //! sentcount = 2, atleast = True -> duplicated (sent least twice)
0047   //! etc...
0048   //! sentcount = 1, atleast = False -> sent just once (non-dupl.d)
0049   //! sentcount = 2, atleast = False -> sent just twice
0050   //! etc...
0051   Standard_EXPORT IFSelect_SelectSent(const int sentcount = 1, const bool atleast = true);
0052
0053   //! Returns the queried count of sending
0054   Standard_EXPORT int SentCount() const;
0055
0056   //! Returns the <atleast> status, True for sending at least the
0057   //! sending count, False for sending exactly the sending count
0058   //! Remark : if SentCount is 0, AtLeast is ignored
0059   Standard_EXPORT bool AtLeast() const;
0060
0061   //! Returns the list of selected entities. It is redefined to
0062   //! work on the graph itself (not queried by sort)
0063   //!
0064   //! An entity is selected if its count complies to the query in
0065   //! Direct Mode, rejected in Reversed Mode
0066   //!
0067   //! Query works on the sending count recorded as status in Graph
0068   Standard_EXPORT Interface_EntityIterator RootResult(const Interface_Graph& G) const override;
0069
0070   //! Returns always False because RootResult has done the work
0071   Standard_EXPORT bool Sort(const int                                    rank,
0072                             const occ::handle<Standard_Transient>&       ent,
0073                             const occ::handle<Interface_InterfaceModel>& model) const override;
0074
0075   //! Returns a text defining the criterium : query :
0076   //! SentCount = 0 -> "Remaining (non-sent) entities"
0077   //! SentCount = 1, AtLeast = True  -> "Sent entities"
0078   //! SentCount = 1, AtLeast = False -> "Sent once (no duplicated)"
0079   //! SentCount = 2, AtLeast = True  -> "Sent several times entities"
0080   //! SentCount = 2, AtLeast = False -> "Sent twice entities"
0081   //! SentCount > 2, AtLeast = True  -> "Sent at least <count> times entities"
0082   //! SentCount > 2, AtLeast = False -> "Sent <count> times entities"
0083   Standard_EXPORT TCollection_AsciiString ExtractLabel() const override;
0084
0085   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectSent, IFSelect_SelectExtract)
0086
0087 private:
0088   int  thecnt;
0089   bool thelst;
0090 };
0091
0092 #endif // _IFSelect_SelectSent_HeaderFile