This class gives a frame for Actions which modify the effect of a Dispatch, i.e. : By Selections and Dispatches, an original Model can be split into one or more "target" Models : these Models contain Entities copied from the original one (that is, a part of it). Basically, these dispatched Entities are copied as identical to their original counterparts. Also the copied Models reproduce the Header of the original one. More...
#include <IFSelect_GeneralModifier.hxx>
Public Member Functions | |
| 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_Dispatch > | Dispatch () 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 additional criterium. More... | |
| Handle< IFSelect_Selection > | Selection () 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 Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. 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_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. 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_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 modify the effect of a Dispatch, i.e. : By Selections and Dispatches, an original Model can be split into one or more "target" Models : these Models contain Entities copied from the original one (that is, a part of it). Basically, these dispatched Entities are copied as identical to their original counterparts. Also the copied Models reproduce the Header of the original one.
Modifiers allow to change this copied content : this is the way to be used for any kind of alterations, adaptations ... They are exploited by a ModelCopier, which firstly performs the copy operation described by Dispatches, then invokes the Modifiers to work on the result.
Each GeneralModifier can be attached to :
- all the Models produced
- a Dispatch (it will be applied to all the Models obtained from this Dispatch) designated by its Ident in a ShareOut
- in addition, to a Selection (facultative) : this adds a criterium, the Modifier is invoked on a produced Model only if this Model contains an Entity copied from one of the Entities designated by this Selection. (for special Modifiers from IFAdapt, while they must work on definite Entities, this Selection is mandatory to run)
Remark : this class has no action attached, it only provides a frame to work on criteria. Then, sub-classes will define their kind of action, which can be applied at a precise step of the production of a File : see Modifier, and in the package IFAdapt, EntityModifier and EntityCopier
Constructor & Destructor Documentation
◆ IFSelect_GeneralModifier()
|
protected |
Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to :
- False if this GeneralModifier surely lets the graph of dependencies unchanged (NO edition of any reference, BUT also NO entity added or replaced or removed)
- True if there is a possibility of changing the graph of dependencies when this modifier is applied
Member Function Documentation
◆ Applies()
| Standard_Boolean IFSelect_GeneralModifier::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>
◆ Dispatch()
| Handle< IFSelect_Dispatch > IFSelect_GeneralModifier::Dispatch | ( | ) | const |
Returns the Dispatch to be matched, Null if not set.
◆ HasSelection()
| Standard_Boolean IFSelect_GeneralModifier::HasSelection | ( | ) | const |
Returns True if a Selection is set as an additional criterium.
◆ Label()
|
pure virtual |
Returns a short text which defines the operation performed.
Implemented in StepSelect_FloatFormat, IGESSelect_UpdateLastChange, IGESSelect_UpdateFileName, IGESSelect_UpdateCreationDate, IGESSelect_SetVersion5, IGESSelect_SetLabel, IGESSelect_SetGlobalParameter, IGESSelect_RemoveCurves, IGESSelect_RebuildGroups, IGESSelect_RebuildDrawings, IGESSelect_FloatFormat, IGESSelect_ComputeStatus, IGESSelect_ChangeLevelNumber, IGESSelect_ChangeLevelList, IGESSelect_AutoCorrect, IGESSelect_AddGroup, IGESSelect_AddFileComment, IFSelect_ModifReorder, and IFSelect_ModifEditForm.
◆ MayChangeGraph()
| Standard_Boolean IFSelect_GeneralModifier::MayChangeGraph | ( | ) | const |
Returns True if this modifier may change the graph of dependences (aknowledged at creation time)
◆ ResetSelection()
| void IFSelect_GeneralModifier::ResetSelection | ( | ) |
Resets the Selection : this criterium is not longer active.
◆ Selection()
| Handle< IFSelect_Selection > IFSelect_GeneralModifier::Selection | ( | ) | const |
Returns the Selection, or a Null Handle if not set.
◆ SetDispatch()
| void IFSelect_GeneralModifier::SetDispatch | ( | const Handle< IFSelect_Dispatch > & | disp | ) |
Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)
◆ SetSelection()
| void IFSelect_GeneralModifier::SetSelection | ( | const Handle< IFSelect_Selection > & | sel | ) |
Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection.
The documentation for this class was generated from the following file:
