A SelectAnyList kind Selection selects a List of an Entity, as well as this Entity contains some. A List contains sub-entities as one per Item, or several (for instance if an Entity binds couples of sub-entities, each item is one of these couples). Remark that only Entities are taken into account (neither Reals, nor Strings, etc...) More...
#include <IFSelect_SelectAnyList.hxx>
Public Member Functions | |
| virtual void | KeepInputEntity (Interface_EntityIterator &iter) const =0 |
| Keeps Input Entity, as having required type. It works by keeping in <iter>, only suitable Entities (SelectType can be used). Called by RootResult (which waits for ONE ENTITY MAX) | |
| virtual Standard_Integer | NbItems (const Handle< Standard_Transient > &ent) const =0 |
| Returns count of Items in the list in the Entity <ent> If <ent> has not required type, returned value must be Zero. | |
| void | SetRange (const Handle< IFSelect_IntParam > &rankfrom, const Handle< IFSelect_IntParam > &rankto) |
| Sets a Range for numbers, with a lower and a upper limits. | |
| void | SetOne (const Handle< IFSelect_IntParam > &rank) |
| Sets a unique number (only one Entity will be sorted as True) | |
| void | SetFrom (const Handle< IFSelect_IntParam > &rankfrom) |
| Sets a Lower limit but no upper limit. | |
| void | SetUntil (const Handle< IFSelect_IntParam > &rankto) |
| Sets an Upper limit but no lower limit (equivalent to lower 1) | |
| Standard_Boolean | HasLower () const |
| Returns True if a Lower limit is defined. | |
| Handle< IFSelect_IntParam > | Lower () const |
| Returns Lower limit (if there is; else, value is senseless) | |
| Standard_Integer | LowerValue () const |
| Returns Integer Value of Lower Limit (0 if none) | |
| Standard_Boolean | HasUpper () const |
| Returns True if a Lower limit is defined. | |
| Handle< IFSelect_IntParam > | Upper () const |
| Returns Upper limit (if there is; else, value is senseless) | |
| Standard_Integer | UpperValue () const |
| Returns Integer Value of Upper Limit (0 if none) | |
| Interface_EntityIterator | RootResult (const Interface_Graph &G) const override |
| Returns the list of selected entities (list of entities complying with rank criterium) Error if the input list has more than one Item. | |
| virtual void | FillResult (const Standard_Integer n1, const Standard_Integer n2, const Handle< Standard_Transient > &ent, Interface_EntityIterator &res) const =0 |
| Puts into <res>, the sub-entities of the list, from n1 to n2 included. Remark that adequation with Entity's type and length of list has already been made at this stage Called by RootResult. | |
| TCollection_AsciiString | Label () const override |
| Returns a text defining the criterium : "Components of List " then Specific List Label, then, following cases : " From .. Until .." or "From .." or "Until .." or "Rank no .." Specific type is given by deferred method ListLabel. | |
| virtual TCollection_AsciiString | ListLabel () const =0 |
| Returns the specific label for the list, which is included as a part of Label. | |
 Public Member Functions inherited from IFSelect_SelectDeduct | |
| void | SetInput (const Handle< IFSelect_Selection > &sel) |
| Defines or Changes the Input Selection. | |
| Handle< IFSelect_Selection > | Input () const |
| Returns the Input Selection. | |
| Standard_Boolean | HasInput () const |
| Returns True if the Input Selection is defined, False else. | |
| Standard_Boolean | HasAlternate () const |
| Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set. | |
| 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. | |
| 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. | |
| void | FillIterator (IFSelect_SelectionIterator &iter) const override |
| Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection. | |
| 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 SelectAnyList kind Selection selects a List of an Entity, as well as this Entity contains some. A List contains sub-entities as one per Item, or several (for instance if an Entity binds couples of sub-entities, each item is one of these couples). Remark that only Entities are taken into account (neither Reals, nor Strings, etc...)
To define the list on which to work, SelectAnyList has two deferred methods : NbItems (which gives the length of the list), FillResult (which fills an EntityIterator). They are intended to get a List in an Entity of the required Type (and consider that list is empty if Entity has not required Type)
In addition, remark that some types of Entity define more than one list in each instance : a given sub-class of SelectAnyList must be attached to one list
SelectAnyList keeps or rejects a sub-set of the list, that is the Items of which rank in the list is in a given range (for instance form 2nd to 6th, etc...) Range is defined by two Integer values. In order to allow external control of them, these values are not directly defined as fields, but accessed through IntParams, that is, referenced as Transient (Handle) objects
Warning : the Input can be any kind of Selection, BUT its RootResult must have zero (empty) or one Entity maximum
Member Function Documentation
◆ FillResult()
|
pure virtual |
Puts into <res>, the sub-entities of the list, from n1 to n2 included. Remark that adequation with Entity's type and length of list has already been made at this stage Called by RootResult.
Implemented in IFSelect_SelectInList.
◆ HasLower()
| Standard_Boolean IFSelect_SelectAnyList::HasLower | ( | ) | const |
Returns True if a Lower limit is defined.
◆ HasUpper()
| Standard_Boolean IFSelect_SelectAnyList::HasUpper | ( | ) | const |
Returns True if a Lower limit is defined.
◆ KeepInputEntity()
|
pure virtual |
Keeps Input Entity, as having required type. It works by keeping in <iter>, only suitable Entities (SelectType can be used). Called by RootResult (which waits for ONE ENTITY MAX)
◆ Label()
|
overridevirtual |
Returns a text defining the criterium : "Components of List " then Specific List Label, then, following cases : " From .. Until .." or "From .." or "Until .." or "Rank no .." Specific type is given by deferred method ListLabel.
Implements IFSelect_Selection.
◆ ListLabel()
|
pure virtual |
Returns the specific label for the list, which is included as a part of Label.
◆ Lower()
| Handle< IFSelect_IntParam > IFSelect_SelectAnyList::Lower | ( | ) | const |
Returns Lower limit (if there is; else, value is senseless)
◆ LowerValue()
| Standard_Integer IFSelect_SelectAnyList::LowerValue | ( | ) | const |
Returns Integer Value of Lower Limit (0 if none)
◆ NbItems()
|
pure virtual |
Returns count of Items in the list in the Entity <ent> If <ent> has not required type, returned value must be Zero.
◆ RootResult()
|
overridevirtual |
Returns the list of selected entities (list of entities complying with rank criterium) Error if the input list has more than one Item.
Implements IFSelect_Selection.
◆ SetFrom()
| void IFSelect_SelectAnyList::SetFrom | ( | const Handle< IFSelect_IntParam > & | rankfrom | ) |
Sets a Lower limit but no upper limit.
◆ SetOne()
| void IFSelect_SelectAnyList::SetOne | ( | const Handle< IFSelect_IntParam > & | rank | ) |
Sets a unique number (only one Entity will be sorted as True)
◆ SetRange()
| void IFSelect_SelectAnyList::SetRange | ( | const Handle< IFSelect_IntParam > & | rankfrom, |
| const Handle< IFSelect_IntParam > & | rankto | ||
| ) |
Sets a Range for numbers, with a lower and a upper limits.
◆ SetUntil()
| void IFSelect_SelectAnyList::SetUntil | ( | const Handle< IFSelect_IntParam > & | rankto | ) |
Sets an Upper limit but no lower limit (equivalent to lower 1)
◆ Upper()
| Handle< IFSelect_IntParam > IFSelect_SelectAnyList::Upper | ( | ) | const |
Returns Upper limit (if there is; else, value is senseless)
◆ UpperValue()
| Standard_Integer IFSelect_SelectAnyList::UpperValue | ( | ) | const |
Returns Integer Value of Upper Limit (0 if none)
The documentation for this class was generated from the following file:
