A SelectExtract determines a list of Entities from an Input Selection, as a sub-list of the Input Result It works by applying a sort criterium on each Entity of the Input. This criterium can be applied Direct to Pick Items (default case) or Reverse to Remove Item. More...

#include <IFSelect_SelectExtract.hxx>

Inheritance diagram for IFSelect_SelectExtract:

[legend]

Public Member Functions
Standard_Boolean	IsDirect () const
	Returns True if Sort criterium is Direct, False if Reverse.

void	SetDirect (const Standard_Boolean direct)
	Sets Sort criterium sense to a new value (True : Direct , False : Reverse)

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.

virtual Standard_Boolean	Sort (const Standard_Integer rank, const Handle< Standard_Transient > &ent, const Handle< Interface_InterfaceModel > &model) const =0
	Returns True for an Entity if it satisfies the Sort criterium It receives :

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)

TCollection_AsciiString	Label () const override
	Returns a text saying "Picked" or "Removed", plus the specific criterium returned by ExtractLabel (see below)

virtual TCollection_AsciiString	ExtractLabel () const =0
	Returns a text defining the criterium for extraction.

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.

Protected Member Functions
	IFSelect_SelectExtract ()
	Initializes a SelectExtract : enforces the sort to be Direct.

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.

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.

Detailed Description

A SelectExtract determines a list of Entities from an Input Selection, as a sub-list of the Input Result It works by applying a sort criterium on each Entity of the Input. This criterium can be applied Direct to Pick Items (default case) or Reverse to Remove Item.

Basic features (the unique Input) are inherited from SelectDeduct

Constructor & Destructor Documentation

◆ IFSelect_SelectExtract()

IFSelect_SelectExtract::IFSelect_SelectExtract ( )

protected

Initializes a SelectExtract : enforces the sort to be Direct.

Member Function Documentation

◆ ExtractLabel()

virtual TCollection_AsciiString IFSelect_SelectExtract::ExtractLabel ( ) const

pure virtual

Returns a text defining the criterium for extraction.

Implemented in IFSelect_SelectErrorEntities, IFSelect_SelectFlag, IFSelect_SelectRange, IFSelect_SelectRootComps, IFSelect_SelectRoots, IFSelect_SelectSent, IFSelect_SelectSignature, IFSelect_SelectType, IFSelect_SelectUnknownEntities, IGESSelect_SelectLevelNumber, IGESSelect_SelectName, IGESSelect_SelectSubordinate, IGESSelect_SelectVisibleStatus, and XSControl_SelectForTransfer.

◆ IsDirect()

Standard_Boolean IFSelect_SelectExtract::IsDirect ( ) const

Returns True if Sort criterium is Direct, False if Reverse.

◆ Label()

TCollection_AsciiString IFSelect_SelectExtract::Label ( ) const

overridevirtual

Returns a text saying "Picked" or "Removed", plus the specific criterium returned by ExtractLabel (see below)

Implements IFSelect_Selection.

◆ RootResult()

virtual Interface_EntityIterator IFSelect_SelectExtract::RootResult ( const Interface_Graph & G ) const

overridevirtual

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.

Implements IFSelect_Selection.

Reimplemented in IFSelect_SelectFlag, IFSelect_SelectRootComps, IFSelect_SelectRoots, IFSelect_SelectSent, and STEPSelections_SelectForTransfer.

◆ SetDirect()

void IFSelect_SelectExtract::SetDirect ( const Standard_Boolean direct )

Sets Sort criterium sense to a new value (True : Direct , False : Reverse)

◆ Sort()

virtual Standard_Boolean IFSelect_SelectExtract::Sort	(	const Standard_Integer	rank,
		const Handle< Standard_Transient > &	ent,
		const Handle< Interface_InterfaceModel > &	model
	)		const

pure virtual

Returns True for an Entity if it satisfies the Sort criterium It receives :

<rank>, the rank of the Entity in the Iteration,
<ent> , the Entity itself, and
<model>, the Starting Model Hence, the Entity to check is "model->Value(num)" (but an InterfaceModel allows other checks) This method is specific to each class of SelectExtract

Implemented in IFSelect_SelectAnyType, IFSelect_SelectErrorEntities, IFSelect_SelectFlag, IFSelect_SelectRange, IFSelect_SelectRootComps, IFSelect_SelectRoots, IFSelect_SelectSent, IFSelect_SelectSignature, IFSelect_SelectUnknownEntities, IGESSelect_SelectLevelNumber, IGESSelect_SelectName, IGESSelect_SelectSubordinate, IGESSelect_SelectVisibleStatus, and XSControl_SelectForTransfer.

◆ SortInGraph()

virtual Standard_Boolean IFSelect_SelectExtract::SortInGraph	(	const Standard_Integer	rank,
		const Handle< Standard_Transient > &	ent,
		const Interface_Graph &	G
	)		const

virtual

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)

Reimplemented in IFSelect_SelectSignature.

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

IFSelect_SelectExtract.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members