Open CASCADE Technology
6.5.4
|
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
#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 |
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 |
Returns a text defining the criterium : "Componants 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 |
virtual void IFSelect_SelectAnyList::FillResult | ( | const Standard_Integer | n1, |
const Standard_Integer | n2, | ||
const Handle< Standard_Transient > & | ent, | ||
Interface_EntityIterator & | res | ||
) | const [pure virtual] |
Implemented in IFSelect_SelectInList.
virtual void IFSelect_SelectAnyList::KeepInputEntity | ( | Interface_EntityIterator & | iter | ) | const [pure virtual] |
TCollection_AsciiString IFSelect_SelectAnyList::Label | ( | ) | const [virtual] |
Implements IFSelect_Selection.
virtual TCollection_AsciiString IFSelect_SelectAnyList::ListLabel | ( | ) | const [pure virtual] |
Handle_IFSelect_IntParam IFSelect_SelectAnyList::Lower | ( | ) | const |
virtual Standard_Integer IFSelect_SelectAnyList::NbItems | ( | const Handle< Standard_Transient > & | ent | ) | const [pure virtual] |
Interface_EntityIterator IFSelect_SelectAnyList::RootResult | ( | const Interface_Graph & | G | ) | const [virtual] |
Implements IFSelect_Selection.
void IFSelect_SelectAnyList::SetFrom | ( | const Handle< IFSelect_IntParam > & | rankfrom | ) |
void IFSelect_SelectAnyList::SetOne | ( | const Handle< IFSelect_IntParam > & | rank | ) |
void IFSelect_SelectAnyList::SetRange | ( | const Handle< IFSelect_IntParam > & | rankfrom, |
const Handle< IFSelect_IntParam > & | rankto | ||
) |
void IFSelect_SelectAnyList::SetUntil | ( | const Handle< IFSelect_IntParam > & | rankto | ) |
Handle_IFSelect_IntParam IFSelect_SelectAnyList::Upper | ( | ) | const |