include/opencascade/IGESSelect_SelectName.hxx

0001 // Created on: 1994-05-31
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-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 _IGESSelect_SelectName_HeaderFile
0018 #define _IGESSelect_SelectName_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_SelectExtract.hxx>
0024 #include <Standard_Integer.hxx>
0025 class TCollection_HAsciiString;
0026 class Standard_Transient;
0027 class Interface_InterfaceModel;
0028 class TCollection_AsciiString;
0029
0030 //! Selects Entities which have a given name.
0031 //! Consider Property Name if present, else Short Label, but
0032 //! not the Subscript Number
0033 //! First version : keeps exact name
0034 //! Later : regular expression
0035 class IGESSelect_SelectName : public IFSelect_SelectExtract
0036 {
0037
0038 public:
0039   //! Creates an empty SelectName : every entity is considered
0040   //! good (no filter active)
0041   Standard_EXPORT IGESSelect_SelectName();
0042
0043   //! Returns True if Name of Entity complies with Name Filter
0044   Standard_EXPORT bool Sort(const int                                    rank,
0045                             const occ::handle<Standard_Transient>&       ent,
0046                             const occ::handle<Interface_InterfaceModel>& model) const override;
0047
0048   //! Sets a Name as a criterium : IGES Entities which have this name
0049   //! are kept (without regular expression, there should be at most
0050   //! one). <name> can be regarded as a Text Parameter
0051   Standard_EXPORT void SetName(const occ::handle<TCollection_HAsciiString>& name);
0052
0053   //! Returns the Name used as Filter
0054   Standard_EXPORT occ::handle<TCollection_HAsciiString> Name() const;
0055
0056   //! Returns the Selection criterium : "IGES Entity, Name : <name>"
0057   Standard_EXPORT TCollection_AsciiString ExtractLabel() const override;
0058
0059   DEFINE_STANDARD_RTTIEXT(IGESSelect_SelectName, IFSelect_SelectExtract)
0060
0061 private:
0062   occ::handle<TCollection_HAsciiString> thename;
0063 };
0064
0065 #endif // _IGESSelect_SelectName_HeaderFile