Open CASCADE Technology  7.3.0
Public Member Functions

IFSelect_SelectDeduct Class Reference

A SelectDeduct determines a list of Entities from an Input Selection, by a computation : Output list is not obliged to be a sub-list of Input list (for more specific, see SelectExtract for filtered sub-lists, and SelectExplore for recurcive exploration) More...

#include <IFSelect_SelectDeduct.hxx>

Inheritance diagram for IFSelect_SelectDeduct:
Inheritance graph
[legend]

Public Member Functions

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
virtual Interface_EntityIterator RootResult (const Interface_Graph &G) const =0
 Returns the list of selected entities, computed from Input given as a Graph. Specific to each class of Selection Note that uniqueness of each entity is not required here This method can raise an exception as necessary. More...
 
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...
 
virtual TCollection_AsciiString Label () const =0
 Returns a text which defines the criterium applied by a Selection (can be used to be printed, displayed ...) Specific to each class. 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...
 

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

Detailed Description

A SelectDeduct determines a list of Entities from an Input Selection, by a computation : Output list is not obliged to be a sub-list of Input list (for more specific, see SelectExtract for filtered sub-lists, and SelectExplore for recurcive exploration)

A SelectDeduct may use an alternate input for one shot This allows to use an already existing definition, by overloading the input selection by an alternate list, already defined, for one use : If this alternate list is set, InputResult queries it instead of calling the input selection, then clears it immediately

Member Function Documentation

◆ Alternate()

Handle< IFSelect_SelectPointed >& IFSelect_SelectDeduct::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.

It is exploited by InputResult

◆ FillIterator()

void IFSelect_SelectDeduct::FillIterator ( IFSelect_SelectionIterator iter) const
overridevirtual

Puts in an Iterator the Selections from which "me" depends This list contains one Selection : the InputSelection.

Implements IFSelect_Selection.

◆ HasAlternate()

Standard_Boolean IFSelect_SelectDeduct::HasAlternate ( ) const

Tells if an Alternate List has been set, i.e. : the Alternate Definition is present and set.

◆ HasInput()

Standard_Boolean IFSelect_SelectDeduct::HasInput ( ) const

Returns True if the Input Selection is defined, False else.

◆ Input()

Handle< IFSelect_Selection > IFSelect_SelectDeduct::Input ( ) const

Returns the Input Selection.

◆ InputResult()

Interface_EntityIterator IFSelect_SelectDeduct::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.

If Alternate is set, InputResult takes its definition instead of calling the Input Selection, then clears it

◆ SetInput()

void IFSelect_SelectDeduct::SetInput ( const Handle< IFSelect_Selection > &  sel)

Defines or Changes the Input Selection.


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