include/opencascade/IFSelect_SelectSignedShared.hxx

0001 // Created on: 1996-09-25
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1996-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_SelectSignedShared_HeaderFile
0018 #define _IFSelect_SelectSignedShared_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <TCollection_AsciiString.hxx>
0023 #include <IFSelect_SelectExplore.hxx>
0024 #include <Standard_Integer.hxx>
0025 class IFSelect_Signature;
0026 class Standard_Transient;
0027 class Interface_Graph;
0028 class Interface_EntityIterator;
0029
0030
0031 class IFSelect_SelectSignedShared;
0032 DEFINE_STANDARD_HANDLE(IFSelect_SelectSignedShared, IFSelect_SelectExplore)
0033
0034 //! In the graph, explore the Shareds of the input entities,
0035 //! until it encounters some which match a given Signature
0036 //! (for a limited level, filters the returned list)
0037 //! By default, fitted for any level
0038 class IFSelect_SelectSignedShared : public IFSelect_SelectExplore
0039 {
0040
0041 public:
0042
0043
0044   //! Creates a SelectSignedShared, defaulted for any level
0045   //! with a given Signature and text to match
0046   Standard_EXPORT IFSelect_SelectSignedShared(const Handle(IFSelect_Signature)& matcher, const Standard_CString signtext, const Standard_Boolean exact = Standard_True, const Standard_Integer level = 0);
0047
0048   //! Returns the used Signature, then it is possible to access it,
0049   //! modify it as required
0050   Standard_EXPORT Handle(IFSelect_Signature) Signature() const;
0051
0052   //! Returns Text used to Sort Entity on its Signature
0053   Standard_EXPORT const TCollection_AsciiString& SignatureText() const;
0054
0055   //! Returns True if match must be exact
0056   Standard_EXPORT Standard_Boolean IsExact() const;
0057
0058   //! Explores an entity : its Shared entities
0059   //! <ent> to take if it matches the Signature
0060   //! At level max, filters the result. Else gives all Shareds
0061   Standard_EXPORT Standard_Boolean Explore (const Standard_Integer level, const Handle(Standard_Transient)& ent, const Interface_Graph& G, Interface_EntityIterator& explored) const Standard_OVERRIDE;
0062
0063   //! Returns a text defining the criterium.
0064   //! (it refers to the text and exact flag to be matched, and is
0065   //! qualified by the Name provided by the Signature)
0066   Standard_EXPORT TCollection_AsciiString ExploreLabel() const Standard_OVERRIDE;
0067
0068
0069
0070
0071   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectSignedShared,IFSelect_SelectExplore)
0072
0073 protected:
0074
0075
0076
0077
0078 private:
0079
0080
0081   Handle(IFSelect_Signature) thematcher;
0082   TCollection_AsciiString thesigntext;
0083   Standard_Boolean theexact;
0084
0085
0086 };
0087
0088
0089
0090
0091
0092
0093
0094 #endif // _IFSelect_SelectSignedShared_HeaderFile