A SelectEntityNumber gets in an InterfaceModel (through a Graph), the Entity which has a specified Number (its rank of adding into the Model) : there can be zero (if none) or one. The Number is not directly defined as an Integer, but as a Parameter, which can be externally controlled. More...
#include <IFSelect_SelectEntityNumber.hxx>
Inheritance diagram for IFSelect_SelectEntityNumber:
Public Member Functions | |
| IFSelect_SelectEntityNumber () | |
| Creates a SelectEntityNumber, initially with no specified Number. | |
| void | SetNumber (const Handle< IFSelect_IntParam > &num) |
| Sets Entity Number to be taken (initially, none is set : 0) | |
| Handle< IFSelect_IntParam > | Number () const |
| Returns specified Number (as a Parameter) | |
| Interface_EntityIterator | RootResult (const Interface_Graph &G) const override |
| Returns the list of selected entities : the Entity having the specified Number (this result assures naturally uniqueness) | |
| TCollection_AsciiString | Label () const override |
| Returns a text defining the criterium : "Entity Number ...". | |
 Public Member Functions inherited from IFSelect_SelectBase | |
| void | FillIterator (IFSelect_SelectionIterator &iter) const override |
| Puts in an Iterator the Selections from which "me" depends This list is empty for all SelectBase type Selections. | |
| Public Member Functions inherited from IFSelect_Selection | |
| Interface_EntityIterator | UniqueResult (const Interface_Graph &G) const |
| Returns the list of selected entities, each of them being unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph. | |
| virtual Interface_EntityIterator | CompleteResult (const Interface_Graph &G) const |
| Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not) | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from IFSelect_Selection | |
| virtual Standard_Boolean | HasUniqueResult () const |
| Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined. | |
Detailed Description
A SelectEntityNumber gets in an InterfaceModel (through a Graph), the Entity which has a specified Number (its rank of adding into the Model) : there can be zero (if none) or one. The Number is not directly defined as an Integer, but as a Parameter, which can be externally controlled.
Constructor & Destructor Documentation
◆ IFSelect_SelectEntityNumber()
| IFSelect_SelectEntityNumber::IFSelect_SelectEntityNumber | ( | ) |
Creates a SelectEntityNumber, initially with no specified Number.
Member Function Documentation
◆ Label()
|
overridevirtual |
Returns a text defining the criterium : "Entity Number ...".
Implements IFSelect_Selection.
◆ Number()
| Handle< IFSelect_IntParam > IFSelect_SelectEntityNumber::Number | ( | ) | const |
Returns specified Number (as a Parameter)
◆ RootResult()
|
overridevirtual |
Returns the list of selected entities : the Entity having the specified Number (this result assures naturally uniqueness)
Implements IFSelect_Selection.
◆ SetNumber()
| void IFSelect_SelectEntityNumber::SetNumber | ( | const Handle< IFSelect_IntParam > & | num | ) |
Sets Entity Number to be taken (initially, none is set : 0)
The documentation for this class was generated from the following file:
