Open CASCADE Technology  7.3.1.dev
Public Member Functions
IFSelect_SelectControl Class Reference

A SelectControl kind Selection works with two input Selections in a dissymmetric way : the Main Input which gives an input list of Entities, to be processed, and the Second Input which gives another list, to be used to filter the main input. More...

#include <IFSelect_SelectControl.hxx>

Inheritance diagram for IFSelect_SelectControl:
Inheritance graph
[legend]

Public Member Functions

Handle< IFSelect_SelectionMainInput () const
 Returns the Main Input Selection. More...
 
Standard_Boolean HasSecondInput () const
 Returns True if a Control Input is defined Thus, Result can be computed differently if there is a Control Input or if there is none. More...
 
Handle< IFSelect_SelectionSecondInput () const
 Returns the Control Input Selection, or a Null Handle. More...
 
void SetMainInput (const Handle< IFSelect_Selection > &sel)
 Sets a Selection to be the Main Input. More...
 
void SetSecondInput (const Handle< IFSelect_Selection > &sel)
 Sets a Selection to be the Control Input. More...
 
void FillIterator (IFSelect_SelectionIterator &iter) const override
 Puts in an Iterator the Selections from which "me" depends That is to say, the list of Input Selections. 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 SelectControl kind Selection works with two input Selections in a dissymmetric way : the Main Input which gives an input list of Entities, to be processed, and the Second Input which gives another list, to be used to filter the main input.

e.g. : SelectDiff retains the items of the Main Input which are not in the Control Input (which acts as Diff Input) or a specific selection which retains Entities from the Main Input if and only if they are concerned by an entity from the Control Input (such as Views in IGES, etc...)

The way RootResult and Label are produced are at charge of each sub-class

Member Function Documentation

◆ FillIterator()

void IFSelect_SelectControl::FillIterator ( IFSelect_SelectionIterator iter) const
overridevirtual

Puts in an Iterator the Selections from which "me" depends That is to say, the list of Input Selections.

Implements IFSelect_Selection.

◆ HasSecondInput()

Standard_Boolean IFSelect_SelectControl::HasSecondInput ( ) const

Returns True if a Control Input is defined Thus, Result can be computed differently if there is a Control Input or if there is none.

◆ MainInput()

Handle< IFSelect_Selection > IFSelect_SelectControl::MainInput ( ) const

Returns the Main Input Selection.

◆ SecondInput()

Handle< IFSelect_Selection > IFSelect_SelectControl::SecondInput ( ) const

Returns the Control Input Selection, or a Null Handle.

◆ SetMainInput()

void IFSelect_SelectControl::SetMainInput ( const Handle< IFSelect_Selection > &  sel)

Sets a Selection to be the Main Input.

◆ SetSecondInput()

void IFSelect_SelectControl::SetSecondInput ( const Handle< IFSelect_Selection > &  sel)

Sets a Selection to be the Control Input.


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