A Selection allows to define a set of Interface Entities. Entities to be put on an output file should be identified in a way as independent from such or such execution as possible. This permits to handle comprehensive criteria, and to replay them when a new variant of an input file has to be processed. More...
#include <IFSelect_Selection.hxx>
Public Member Functions | |
| 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. | |
| 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) | |
| virtual void | FillIterator (IFSelect_SelectionIterator &iter) const =0 |
| Puts in an Iterator the Selections from which "me" depends (there can be zero, or one, or a list). Specific to each class of Selection. | |
| 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. | |
 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 | |
| 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 Selection allows to define a set of Interface Entities. Entities to be put on an output file should be identified in a way as independent from such or such execution as possible. This permits to handle comprehensive criteria, and to replay them when a new variant of an input file has to be processed.
Its input can be, either an Interface Model (the very source), or another-other Selection(s) or any other output. All list computations start from an input Graph (from IFGraph)
Member Function Documentation
◆ CompleteResult()
|
virtual |
Returns the list of entities involved by a Selection, i.e. UniqueResult plus the shared entities (directly or not)
Reimplemented in IFSelect_SelectModelEntities.
◆ FillIterator()
|
pure virtual |
Puts in an Iterator the Selections from which "me" depends (there can be zero, or one, or a list). Specific to each class of Selection.
Implemented in IFSelect_SelectBase, IFSelect_SelectCombine, IFSelect_SelectControl, and IFSelect_SelectDeduct.
◆ HasUniqueResult()
|
protectedvirtual |
Returns True if RootResult guarantees uniqueness for each Entity. Called by UniqueResult. Default answer is False. Can be redefined.
Reimplemented in IFSelect_SelectCombine, IFSelect_SelectDiff, IFSelect_SelectRootComps, IFSelect_SelectRoots, IGESSelect_SelectDrawingFrom, IGESSelect_SelectSingleViewFrom, and STEPSelections_SelectInstances.
◆ Label()
|
pure virtual |
Returns a text which defines the criterium applied by a Selection (can be used to be printed, displayed ...) Specific to each class.
Implemented in IFSelect_SelectAnyList, IFSelect_SelectDiff, IFSelect_SelectEntityNumber, IFSelect_SelectExplore, IFSelect_SelectExtract, IFSelect_SelectIntersection, IFSelect_SelectModelEntities, IFSelect_SelectModelRoots, IFSelect_SelectPointed, IFSelect_SelectShared, IFSelect_SelectSharing, IFSelect_SelectSuite, IFSelect_SelectUnion, IGESSelect_SelectDrawingFrom, IGESSelect_SelectFromDrawing, IGESSelect_SelectFromSingleView, and IGESSelect_SelectSingleViewFrom.
◆ RootResult()
|
pure virtual |
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.
Implemented in IFSelect_SelectAnyList, IFSelect_SelectDiff, IFSelect_SelectEntityNumber, IFSelect_SelectExplore, IFSelect_SelectExtract, IFSelect_SelectFlag, IFSelect_SelectIntersection, IFSelect_SelectModelEntities, IFSelect_SelectModelRoots, IFSelect_SelectPointed, IFSelect_SelectRootComps, IFSelect_SelectRoots, IFSelect_SelectSent, IFSelect_SelectShared, IFSelect_SelectSharing, IFSelect_SelectSuite, IFSelect_SelectUnion, IGESSelect_SelectDrawingFrom, IGESSelect_SelectFromDrawing, IGESSelect_SelectFromSingleView, IGESSelect_SelectSingleViewFrom, STEPSelections_SelectForTransfer, and STEPSelections_SelectInstances.
◆ UniqueResult()
| Interface_EntityIterator IFSelect_Selection::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.
The documentation for this class was generated from the following file:
