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
0031 class IGESSelect_SelectName;
0032 DEFINE_STANDARD_HANDLE(IGESSelect_SelectName, IFSelect_SelectExtract)
0033
0034 //! Selects Entities which have a given name.
0035 //! Consider Property Name if present, else Short Label, but
0036 //! not the Subscript Number
0037 //! First version : keeps exact name
0038 //! Later : regular expression
0039 class IGESSelect_SelectName : public IFSelect_SelectExtract
0040 {
0041
0042 public:
0043
0044
0045   //! Creates an empty SelectName : every entity is considered
0046   //! good (no filter active)
0047   Standard_EXPORT IGESSelect_SelectName();
0048
0049   //! Returns True if Name of Entity complies with Name Filter
0050   Standard_EXPORT Standard_Boolean Sort (const Standard_Integer rank, const Handle(Standard_Transient)& ent, const Handle(Interface_InterfaceModel)& model) const Standard_OVERRIDE;
0051
0052   //! Sets a Name as a criterium : IGES Entities which have this name
0053   //! are kept (without regular expression, there should be at most
0054   //! one). <name> can be regarded as a Text Parameter
0055   Standard_EXPORT void SetName (const Handle(TCollection_HAsciiString)& name);
0056
0057   //! Returns the Name used as Filter
0058   Standard_EXPORT Handle(TCollection_HAsciiString) Name() const;
0059
0060   //! Returns the Selection criterium : "IGES Entity, Name : <name>"
0061   Standard_EXPORT TCollection_AsciiString ExtractLabel() const Standard_OVERRIDE;
0062
0063
0064
0065
0066   DEFINE_STANDARD_RTTIEXT(IGESSelect_SelectName,IFSelect_SelectExtract)
0067
0068 protected:
0069
0070
0071
0072
0073 private:
0074
0075
0076   Handle(TCollection_HAsciiString) thename;
0077
0078
0079 };
0080
0081
0082
0083
0084
0085
0086
0087 #endif // _IGESSelect_SelectName_HeaderFile