Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Member Functions
IFSelect_SelectExplore Class Referenceabstract

A SelectExplore determines from an input list of Entities, a list obtained by a way of exploration. This implies the possibility of recursive exploration : the output list is itself reused as input, etc... Examples : Shared Entities, can be considered at one level (immediate shared) or more, or max level. More...

#include <IFSelect_SelectExplore.hxx>

Inheritance diagram for IFSelect_SelectExplore:
Inheritance graph
[legend]

Public Member Functions

Standard_Integer Level () const
 Returns the required exploring level. More...
 
Interface_EntityIterator RootResult (const Interface_Graph &G) const override
 Returns the list of selected entities. Works by calling the method Explore on each input entity : it can be rejected, taken for output, or to explore. If the maximum level has not yet been attained, or if no max level is specified, entities to be explored are themselves used as if they were input. More...
 
virtual Standard_Boolean Explore (const Standard_Integer level, const Handle< Standard_Transient > &ent, const Interface_Graph &G, Interface_EntityIterator &explored) const =0
 Analyses and, if required, Explores an entity, as follows : The explored list starts as empty, it has to be filled by this method. If it returns False, <ent> is rejected for result (this is to be used only as safety) If it returns True and <explored> remains empty, <ent> is taken itself for result, not explored If it returns True and <explored> is not empty, the content of this list is considered : If maximum level is attained, it is taken for result Else (or no max), each of its entity will be itself explored. More...
 
TCollection_AsciiString Label () const override
 Returns a text saying "(Recursive)" or "(Level nn)" plus specific criterium returned by ExploreLabel (see below) More...
 
virtual TCollection_AsciiString ExploreLabel () const =0
 Returns a text defining the way of exploration. More...
 
- Public Member Functions inherited from IFSelect_SelectDeduct
void SetInput (const Handle< IFSelect_Selection > &sel)
 Defines or Changes the Input Selection. More...
 
Handle< IFSelect_SelectionInput () 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 Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. 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_TransientThis () 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...
 

Protected Member Functions

 IFSelect_SelectExplore (const Standard_Integer level)
 Initializes a SelectExplore : the level must be specified on starting. 0 means all levels, 1 means level one only, etc... 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...
 

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...
 

Detailed Description

A SelectExplore determines from an input list of Entities, a list obtained by a way of exploration. This implies the possibility of recursive exploration : the output list is itself reused as input, etc... Examples : Shared Entities, can be considered at one level (immediate shared) or more, or max level.

Then, for each input entity, if it is not rejected, it can be either taken itself, or explored : it then produces a list. According to a level, either the produced lists or taken entities give the result (level one), or lists are themselves considered and for each item, is it taken or explored.

Remark that rejection is just a safety : normally, an input entity is, either taken itself, or explored A maximum level can be specified. Else, the process continues until all entities have been either taken or rejected

Constructor & Destructor Documentation

◆ IFSelect_SelectExplore()

IFSelect_SelectExplore::IFSelect_SelectExplore ( const Standard_Integer  level)
protected

Initializes a SelectExplore : the level must be specified on starting. 0 means all levels, 1 means level one only, etc...

Member Function Documentation

◆ Explore()

virtual Standard_Boolean IFSelect_SelectExplore::Explore ( const Standard_Integer  level,
const Handle< Standard_Transient > &  ent,
const Interface_Graph G,
Interface_EntityIterator explored 
) const
pure virtual

Analyses and, if required, Explores an entity, as follows : The explored list starts as empty, it has to be filled by this method. If it returns False, <ent> is rejected for result (this is to be used only as safety) If it returns True and <explored> remains empty, <ent> is taken itself for result, not explored If it returns True and <explored> is not empty, the content of this list is considered : If maximum level is attained, it is taken for result Else (or no max), each of its entity will be itself explored.

Implemented in IGESSelect_SelectBasicGeom, IFSelect_SelectSignedShared, IFSelect_SelectSignedSharing, XSControl_ConnectedShapes, IGESSelect_SelectBypassSubfigure, IGESSelect_SelectBypassGroup, IGESSelect_SelectFaces, IGESSelect_SelectPCurves, STEPSelections_SelectAssembly, STEPSelections_SelectFaces, STEPSelections_SelectInstances, and STEPSelections_SelectGSCurves.

◆ ExploreLabel()

virtual TCollection_AsciiString IFSelect_SelectExplore::ExploreLabel ( ) const
pure virtual

◆ Label()

TCollection_AsciiString IFSelect_SelectExplore::Label ( ) const
overridevirtual

Returns a text saying "(Recursive)" or "(Level nn)" plus specific criterium returned by ExploreLabel (see below)

Implements IFSelect_Selection.

◆ Level()

Standard_Integer IFSelect_SelectExplore::Level ( ) const

Returns the required exploring level.

◆ RootResult()

Interface_EntityIterator IFSelect_SelectExplore::RootResult ( const Interface_Graph G) const
overridevirtual

Returns the list of selected entities. Works by calling the method Explore on each input entity : it can be rejected, taken for output, or to explore. If the maximum level has not yet been attained, or if no max level is specified, entities to be explored are themselves used as if they were input.

Implements IFSelect_Selection.

Reimplemented in STEPSelections_SelectInstances.


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