IFSelect_Modifier Class Referenceabstract
This class gives a frame for Actions which can work globally on a File once completely defined (i.e. afterwards) More...
#include <IFSelect_Modifier.hxx>
Inheritance diagram for IFSelect_Modifier:
Public Member Functions | |
| virtual void | Perform (IFSelect_ContextModif &ctx, const Handle< Interface_InterfaceModel > &target, const Handle< Interface_Protocol > &protocol, Interface_CopyTool &TC) const =0 |
| This deferred method defines the action specific to each class of Modifier. It is called by a ModelCopier, once the Model generated and filled. ModelCopier has already checked the criteria (Dispatch, Model Rank, Selection) before calling it. | |
 Public Member Functions inherited from IFSelect_GeneralModifier | |
| Standard_Boolean | MayChangeGraph () const |
| Returns True if this modifier may change the graph of dependences (acknowledged at creation time) | |
| void | SetDispatch (const Handle< IFSelect_Dispatch > &disp) |
| Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch) | |
| Handle< IFSelect_Dispatch > | Dispatch () const |
| Returns the Dispatch to be matched, Null if not set. | |
| Standard_Boolean | Applies (const Handle< IFSelect_Dispatch > &disp) const |
| Returns True if a Model obtained from the Dispatch <disp> is to be treated (apart from the Selection criterium) If Dispatch(me) is Null, returns True. Else, checks <disp> | |
| void | SetSelection (const Handle< IFSelect_Selection > &sel) |
| Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection. | |
| void | ResetSelection () |
| Resets the Selection : this criterium is not longer active. | |
| Standard_Boolean | HasSelection () const |
| Returns True if a Selection is set as an additional criterium. | |
| Handle< IFSelect_Selection > | Selection () const |
| Returns the Selection, or a Null Handle if not set. | |
| virtual TCollection_AsciiString | Label () const =0 |
| Returns a short text which defines the operation performed. | |
| 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 | |
| IFSelect_Modifier (const Standard_Boolean maychangegraph) | |
| Calls inherited Initialize, transmits to it the information <maychangegraph> | |
| Protected Member Functions inherited from IFSelect_GeneralModifier | |
| IFSelect_GeneralModifier (const Standard_Boolean maychangegraph) | |
| Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to : | |
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
This class gives a frame for Actions which can work globally on a File once completely defined (i.e. afterwards)
Remark : if no Selection is set as criterium, the Modifier is set to work and should consider all the content of the Model produced.
Constructor & Destructor Documentation
◆ IFSelect_Modifier()
|
protected |
Calls inherited Initialize, transmits to it the information <maychangegraph>
Member Function Documentation
◆ Perform()
|
pure virtual |
This deferred method defines the action specific to each class of Modifier. It is called by a ModelCopier, once the Model generated and filled. ModelCopier has already checked the criteria (Dispatch, Model Rank, Selection) before calling it.
<ctx> detains information about original data and selection. The result of copying, on which modifications are to be done, is <target>. <TC> allows to run additional copies as required
In case of Error, use methods CCheck from the ContextModif to aknowledge an entity Check or a Global Check with messages
Implemented in IFSelect_ModifEditForm, IFSelect_ModifReorder, IGESSelect_ModelModifier, and StepSelect_ModelModifier.
The documentation for this class was generated from the following file:
Generated by
1.12.0