Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
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:
Inheritance graph
[legend]

Public Member Functions

virtual void Perform (IFSelect_ContextModif &ctx, const occ::handle< Interface_InterfaceModel > &target, const occ::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
bool MayChangeGraph () const
 Returns True if this modifier may change the graph of dependences (acknowledged at creation time)
 
void SetDispatch (const occ::handle< IFSelect_Dispatch > &disp)
 Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)
 
occ::handle< IFSelect_DispatchDispatch () const
 Returns the Dispatch to be matched, Null if not set.
 
bool Applies (const occ::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 occ::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.
 
bool HasSelection () const
 Returns True if a Selection is set as an additional criterium.
 
occ::handle< IFSelect_SelectionSelection () 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_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

 IFSelect_Modifier (const bool maychangegraph)
 Calls inherited Initialize, transmits to it the information <maychangegraph>
 
- Protected Member Functions inherited from IFSelect_GeneralModifier
 IFSelect_GeneralModifier (const bool 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 charget_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()

IFSelect_Modifier::IFSelect_Modifier ( const bool maychangegraph)
protected

Calls inherited Initialize, transmits to it the information <maychangegraph>

Member Function Documentation

◆ Perform()

virtual void IFSelect_Modifier::Perform ( IFSelect_ContextModif & ctx,
const occ::handle< Interface_InterfaceModel > & target,
const occ::handle< Interface_Protocol > & protocol,
Interface_CopyTool & TC ) const
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 acknowledge an entity Check or a Global Check with messages

Implemented in IGESSelect_ModelModifier, StepSelect_ModelModifier, IFSelect_ModifEditForm, and IFSelect_ModifReorder.


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