A SelectRange keeps or rejects a sub-set of the input set, that is the Entities of which rank in the iteration list is in a given range (for instance form 2nd to 6th, etc...) More...
#include <IFSelect_SelectRange.hxx>
Inheritance diagram for IFSelect_SelectRange:
Public Member Functions | |
| IFSelect_SelectRange () | |
| Creates a SelectRange. Default is Take all the input list. More... | |
| void | SetRange (const Handle< IFSelect_IntParam > &rankfrom, const Handle< IFSelect_IntParam > &rankto) |
| Sets a Range for numbers, with a lower and a upper limits Error if rankto is lower then rankfrom. More... | |
| void | SetOne (const Handle< IFSelect_IntParam > &rank) |
| Sets a unique number (only one Entity will be sorted as True) More... | |
| void | SetFrom (const Handle< IFSelect_IntParam > &rankfrom) |
| Sets a Lower limit but no upper limit. More... | |
| void | SetUntil (const Handle< IFSelect_IntParam > &rankto) |
| Sets an Upper limit but no lower limit (equivalent to lower 1) More... | |
| Standard_Boolean | HasLower () const |
| Returns True if a Lower limit is defined. More... | |
| Handle< IFSelect_IntParam > | Lower () const |
| Returns Lower limit (if there is; else, value is senseless) More... | |
| Standard_Integer | LowerValue () const |
| Returns Value of Lower Limit (0 if none is defined) More... | |
| Standard_Boolean | HasUpper () const |
| Returns True if a Lower limit is defined. More... | |
| Handle< IFSelect_IntParam > | Upper () const |
| Returns Upper limit (if there is; else, value is senseless) More... | |
| Standard_Integer | UpperValue () const |
| Returns Value of Upper Limit (0 if none is defined) More... | |
| Standard_Boolean | Sort (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) const override |
| Returns True for an Entity of which occurence number in the iteration is inside the selected Range (considers <rank>) More... | |
| TCollection_AsciiString | ExtractLabel () const override |
| Returns a text defining the criterium : following cases, " From .. Until .." or "From .." or "Until .." or "Rank no ..". More... | |
 Public Member Functions inherited from IFSelect_SelectExtract | |
| Standard_Boolean | IsDirect () const |
| Returns True if Sort criterium is Direct, False if Reverse. More... | |
| void | SetDirect (const Standard_Boolean direct) |
| Sets Sort criterium sense to a new value (True : Direct , False : Reverse) More... | |
| virtual Interface_EntityIterator | RootResult (const Interface_Graph &G) const override |
| Returns the list of selected entities. Works by calling the method Sort on each input Entity : the Entity is kept as output if Sort returns the same value as Direct status. More... | |
| virtual Standard_Boolean | SortInGraph (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Interface_Graph &G) const |
| Works as Sort but works on the Graph Default directly calls Sort, but it can be redefined If SortInGraph is redefined, Sort should be defined even if not called (to avoid deferred methods in a final class) More... | |
| TCollection_AsciiString | Label () const override |
| Returns a text saying "Picked" or "Removed", plus the specific criterium returned by ExtractLabel (see below) More... | |
| Public Member Functions inherited from IFSelect_SelectDeduct | |
| void | SetInput (const Handle< IFSelect_Selection > &sel) |
| Defines or Changes the Input Selection. More... | |
| Handle< IFSelect_Selection > | Input () const |
| Returns the Input Selection. More... | |
| Standard_Boolean | HasInput () const |
| Returns True if the Input Selection is defined, False else. More... | |
| Standard_Boolean | HasAlternate () const |
| Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set. More... | |
| Handle< IFSelect_SelectPointed > & | Alternate () |
| Returns the Alternate Definition It is returned modifiable, hence an already defined SelectPointed can be used But if it was not yet defined, it is created the first time. More... | |
| Interface_EntityIterator | InputResult (const Interface_Graph &G) const |
| Returns the Result determined by Input Selection, as Unique if Input Selection is not defined, returns an empty list. More... | |
| void | FillIterator (IFSelect_SelectionIterator &iter) const override |
| Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection. More... | |
| Public Member Functions inherited from IFSelect_Selection | |
| Interface_EntityIterator | UniqueResult (const Interface_Graph &G) const |
| Returns the list of selected entities, each of them beeing unique. Default definition works from RootResult. According HasUniqueResult, UniqueResult returns directly RootResult, or build a Unique Result from it with a Graph. More... | |
| 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) More... | |
| Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
| Protected Member Functions inherited from IFSelect_SelectExtract | |
| IFSelect_SelectExtract () | |
| Initializes a SelectExtract : enforces the sort to be Direct. More... | |
| 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. More... | |
Detailed Description
A SelectRange keeps or rejects a sub-set of the input set, that is the Entities of which rank in the iteration list is in a given range (for instance form 2nd to 6th, etc...)
Constructor & Destructor Documentation
| IFSelect_SelectRange::IFSelect_SelectRange | ( | ) |
Creates a SelectRange. Default is Take all the input list.
Member Function Documentation
|
overridevirtual |
Returns a text defining the criterium : following cases, " From .. Until .." or "From .." or "Until .." or "Rank no ..".
Implements IFSelect_SelectExtract.
| Standard_Boolean IFSelect_SelectRange::HasLower | ( | ) | const |
Returns True if a Lower limit is defined.
| Standard_Boolean IFSelect_SelectRange::HasUpper | ( | ) | const |
Returns True if a Lower limit is defined.
| Handle< IFSelect_IntParam > IFSelect_SelectRange::Lower | ( | ) | const |
Returns Lower limit (if there is; else, value is senseless)
| Standard_Integer IFSelect_SelectRange::LowerValue | ( | ) | const |
Returns Value of Lower Limit (0 if none is defined)
| void IFSelect_SelectRange::SetFrom | ( | const Handle< IFSelect_IntParam > & | rankfrom | ) |
Sets a Lower limit but no upper limit.
| void IFSelect_SelectRange::SetOne | ( | const Handle< IFSelect_IntParam > & | rank | ) |
Sets a unique number (only one Entity will be sorted as True)
| void IFSelect_SelectRange::SetRange | ( | const Handle< IFSelect_IntParam > & | rankfrom, |
| const Handle< IFSelect_IntParam > & | rankto | ||
| ) |
Sets a Range for numbers, with a lower and a upper limits Error if rankto is lower then rankfrom.
| void IFSelect_SelectRange::SetUntil | ( | const Handle< IFSelect_IntParam > & | rankto | ) |
Sets an Upper limit but no lower limit (equivalent to lower 1)
|
overridevirtual |
Returns True for an Entity of which occurence number in the iteration is inside the selected Range (considers <rank>)
Implements IFSelect_SelectExtract.
| Handle< IFSelect_IntParam > IFSelect_SelectRange::Upper | ( | ) | const |
Returns Upper limit (if there is; else, value is senseless)
| Standard_Integer IFSelect_SelectRange::UpperValue | ( | ) | const |
Returns Value of Upper Limit (0 if none is defined)
The documentation for this class was generated from the following file:
