Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions
IFSelect_GeneralModifier Class Reference

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
splitted 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 :
More...

#include <IFSelect_GeneralModifier.hxx>

Inheritance diagram for IFSelect_GeneralModifier:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean MayChangeGraph () const
 Returns True if this modifier may change the graph of
dependences (aknowledged 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 additionnal 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

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 :


Detailed Description

      - all the Models produced <br>
      - a Dispatch (it will be applied to all the Models obtained <br>
        from this Dispatch) designated by its Ident in a ShareOut <br>
      - in addition, to a Selection (facultative) : this adds a <br>
        criterium, the Modifier is invoked on a produced Model only <br>
        if this Model contains an Entity copied from one of the <br>
        Entities designated by this Selection. <br>
        (for special Modifiers from IFAdapt, while they must work on <br>
        definite Entities, this Selection is mandatory to run) <br>


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

  • 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

Handle_IFSelect_Dispatch IFSelect_GeneralModifier::Dispatch ( ) const
virtual TCollection_AsciiString IFSelect_GeneralModifier::Label ( ) const [pure virtual]
Handle_IFSelect_Selection IFSelect_GeneralModifier::Selection ( ) const

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