IFSelect_SelectAnyList Class Reference

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>

Inheritance diagram for IFSelect_SelectAnyList:

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 int	NbItems (const occ::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 occ::handle< IFSelect_IntParam > &rankfrom, const occ::handle< IFSelect_IntParam > &rankto)
	Sets a Range for numbers, with a lower and a upper limits.
void	SetOne (const occ::handle< IFSelect_IntParam > &rank)
	Sets a unique number (only one Entity will be sorted as True).
void	SetFrom (const occ::handle< IFSelect_IntParam > &rankfrom)
	Sets a Lower limit but no upper limit.
void	SetUntil (const occ::handle< IFSelect_IntParam > &rankto)
	Sets an Upper limit but no lower limit (equivalent to lower 1).
bool	HasLower () const
	Returns True if a Lower limit is defined.
occ::handle< IFSelect_IntParam >	Lower () const
	Returns Lower limit (if there is; else, value is senseless).
int	LowerValue () const
	Returns Integer Value of Lower Limit (0 if none).
bool	HasUpper () const
	Returns True if a Lower limit is defined.
occ::handle< IFSelect_IntParam >	Upper () const
	Returns Upper limit (if there is; else, value is senseless).
int	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 int n1, const int n2, const occ::handle< Standard_Transient > &ent, Interface_EntityIterator &resres) 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 occ::handle< IFSelect_Selection > &sel)
	Defines or Changes the Input Selection.
occ::handle< IFSelect_Selection >	Input () const
	Returns the Input Selection.
bool	HasInput () const
	Returns True if the Input Selection is defined, False else.
bool	HasAlternate () const
	Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set.
occ::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 ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
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 bool	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()

virtual void IFSelect_SelectAnyList::FillResult ( const int n1, const int n2, const occ::handle< Standard_Transient > & ent, Interface_EntityIterator & res ) const

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()

bool IFSelect_SelectAnyList::HasLower

(

)

const

Returns True if a Lower limit is defined.

HasUpper()

bool IFSelect_SelectAnyList::HasUpper

(

)

const

Returns True if a Lower limit is defined.

KeepInputEntity()

virtual void IFSelect_SelectAnyList::KeepInputEntity ( Interface_EntityIterator & iter ) const

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()

TCollection_AsciiString IFSelect_SelectAnyList::Label ( ) const

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()

virtual TCollection_AsciiString IFSelect_SelectAnyList::ListLabel ( ) const

pure virtual

Returns the specific label for the list, which is included as a part of Label.

Lower()

occ::handle< IFSelect_IntParam > IFSelect_SelectAnyList::Lower

(

)

const

Returns Lower limit (if there is; else, value is senseless).

LowerValue()

int IFSelect_SelectAnyList::LowerValue

(

)

const

Returns Integer Value of Lower Limit (0 if none).

NbItems()

virtual int IFSelect_SelectAnyList::NbItems ( const occ::handle< Standard_Transient > & ent ) const

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()

Interface_EntityIterator IFSelect_SelectAnyList::RootResult ( const Interface_Graph & G ) const

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 occ::handle< IFSelect_IntParam > &

rankfrom

)

Sets a Lower limit but no upper limit.

SetOne()

void IFSelect_SelectAnyList::SetOne

(

const occ::handle< IFSelect_IntParam > &

rank

)

Sets a unique number (only one Entity will be sorted as True).

SetRange()

void IFSelect_SelectAnyList::SetRange	(	const occ::handle< IFSelect_IntParam > &	rankfrom,
		const occ::handle< IFSelect_IntParam > &	rankto )

Sets a Range for numbers, with a lower and a upper limits.

SetUntil()

void IFSelect_SelectAnyList::SetUntil

(

const occ::handle< IFSelect_IntParam > &

rankto

)

Sets an Upper limit but no lower limit (equivalent to lower 1).

Upper()

occ::handle< IFSelect_IntParam > IFSelect_SelectAnyList::Upper

(

)

const

Returns Upper limit (if there is; else, value is senseless).

UpperValue()

int IFSelect_SelectAnyList::UpperValue

(

)

const

Returns Integer Value of Upper Limit (0 if none).

---

The documentation for this class was generated from the following file:

• IFSelect_SelectAnyList.hxx