OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    IFSelect_SelectRoots Class Reference

    A SelectRoots sorts the Entities which are local roots of a set of Entities (not shared by other Entities inside this set, even if they are shared by other Entities outside it). More...

    #include <IFSelect_SelectRoots.hxx>

    Inheritance diagram for IFSelect_SelectRoots:

    Public Member Functions

     IFSelect_SelectRoots ()
     Creates a SelectRoots.
    Interface_EntityIterator RootResult (const Interface_Graph &G) const override
     Returns the list of local roots. It is redefined for a purpose of efficiency: calling a Sort routine for each Entity would cost more resources than to work in once using a Map RootResult takes in account the Direct status.
    bool Sort (const int rank, const occ::handle< Standard_Transient > &ent, const occ::handle< Interface_InterfaceModel > &model) const override
     Returns always True, because RootResult has done work.
    TCollection_AsciiString ExtractLabel () const override
     Returns a text defining the criterium : "Local Root Entities".
    Public Member Functions inherited from IFSelect_SelectExtract
    bool IsDirect () const
     Returns True if Sort criterium is Direct, False if Reverse.
    void SetDirect (const bool direct)
     Sets Sort criterium sense to a new value (True : Direct , False : Reverse).
    virtual bool SortInGraph (const int rank, const occ::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).
    Public Member Functions inherited from IFSelect_SelectDeduct
    void SetInput (const occ::handle< IFSelect_Selection > &sel)
     Defines or Changes the Input Selection.
    occ::handle< IFSelect_SelectionInput () 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_Transientoperator= (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_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.
    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.

    Protected Member Functions

    bool HasUniqueResult () const override
     Returns True, because RootResult assures uniqueness.
    Protected Member Functions inherited from IFSelect_SelectExtract
     IFSelect_SelectExtract ()
     Initializes a SelectExtract : enforces the sort to be Direct.

    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.

    Detailed Description

    A SelectRoots sorts the Entities which are local roots of a set of Entities (not shared by other Entities inside this set, even if they are shared by other Entities outside it).

    Constructor & Destructor Documentation

    ◆ IFSelect_SelectRoots()

    IFSelect_SelectRoots::IFSelect_SelectRoots ( )

    Creates a SelectRoots.

    Member Function Documentation

    ◆ ExtractLabel()

    TCollection_AsciiString IFSelect_SelectRoots::ExtractLabel ( ) const
    overridevirtual

    Returns a text defining the criterium : "Local Root Entities".

    Implements IFSelect_SelectExtract.

    ◆ HasUniqueResult()

    bool IFSelect_SelectRoots::HasUniqueResult ( ) const
    overrideprotectedvirtual

    Returns True, because RootResult assures uniqueness.

    Reimplemented from IFSelect_Selection.

    ◆ RootResult()

    Interface_EntityIterator IFSelect_SelectRoots::RootResult ( const Interface_Graph & G) const
    overridevirtual

    Returns the list of local roots. It is redefined for a purpose of efficiency: calling a Sort routine for each Entity would cost more resources than to work in once using a Map RootResult takes in account the Direct status.

    Reimplemented from IFSelect_SelectExtract.

    ◆ Sort()

    bool IFSelect_SelectRoots::Sort ( const int rank,
    const occ::handle< Standard_Transient > & ent,
    const occ::handle< Interface_InterfaceModel > & model ) const
    overridevirtual

    Returns always True, because RootResult has done work.

    Implements IFSelect_SelectExtract.


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