include/opencascade/IFSelect_SelectEntityNumber.hxx

0001 // Created on: 1992-11-18
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_SelectEntityNumber_HeaderFile
0018 #define _IFSelect_SelectEntityNumber_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_SelectBase.hxx>
0024 class IFSelect_IntParam;
0025 class Interface_EntityIterator;
0026 class Interface_Graph;
0027 class TCollection_AsciiString;
0028
0029 //! A SelectEntityNumber gets in an InterfaceModel (through a
0030 //! Graph), the Entity which has a specified Number (its rank of
0031 //! adding into the Model) : there can be zero (if none) or one.
0032 //! The Number is not directly defined as an Integer, but as a
0033 //! Parameter, which can be externally controlled
0034 class IFSelect_SelectEntityNumber : public IFSelect_SelectBase
0035 {
0036
0037 public:
0038   //! Creates a SelectEntityNumber, initially with no specified Number
0039   Standard_EXPORT IFSelect_SelectEntityNumber();
0040
0041   //! Sets Entity Number to be taken (initially, none is set : 0)
0042   Standard_EXPORT void SetNumber(const occ::handle<IFSelect_IntParam>& num);
0043
0044   //! Returns specified Number (as a Parameter)
0045   Standard_EXPORT occ::handle<IFSelect_IntParam> Number() const;
0046
0047   //! Returns the list of selected entities : the Entity having the
0048   //! specified Number (this result assures naturally uniqueness)
0049   Standard_EXPORT Interface_EntityIterator RootResult(const Interface_Graph& G) const override;
0050
0051   //! Returns a text defining the criterium : "Entity Number ..."
0052   Standard_EXPORT TCollection_AsciiString Label() const override;
0053
0054   DEFINE_STANDARD_RTTIEXT(IFSelect_SelectEntityNumber, IFSelect_SelectBase)
0055
0056 private:
0057   occ::handle<IFSelect_IntParam> thenum;
0058 };
0059
0060 #endif // _IFSelect_SelectEntityNumber_HeaderFile