Open CASCADE Technology  7.1.0.beta
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 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. More...
 
- Public Member Functions inherited from IFSelect_GeneralModifier
Standard_Boolean MayChangeGraph () const
 Returns True if this modifier may change the graph of dependences (aknowledged at creation time) More...
 
void SetDispatch (const Handle< IFSelect_Dispatch > &disp)
 Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch) More...
 
Handle< IFSelect_DispatchDispatch () const
 Returns the Dispatch to be matched, Null if not set. More...
 
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> More...
 
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. More...
 
void ResetSelection ()
 Resets the Selection : this criterium is not longer active. More...
 
Standard_Boolean HasSelection () const
 Returns True if a Selection is set as an additionnal criterium. More...
 
Handle< IFSelect_SelectionSelection () const
 Returns the Selection, or a Null Handle if not set. More...
 
virtual TCollection_AsciiString Label () const =0
 Returns a short text which defines the operation performed. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const override
 Memory deallocator for transient classes. 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 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...
 

Protected Member Functions

 IFSelect_Modifier (const Standard_Boolean maychangegraph)
 Calls inherited Initialize, transmits to it the information <maychangegraph> More...
 
- 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 : 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...
 

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 ( const Standard_Boolean  maychangegraph)
protected

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

Member Function Documentation

virtual void IFSelect_Modifier::Perform ( IFSelect_ContextModif ctx,
const Handle< Interface_InterfaceModel > &  target,
const 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 informations 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_ModifReorder, IFSelect_ModifEditForm, StepSelect_ModelModifier, and IGESSelect_ModelModifier.


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