src/IFSelect/IFSelect_Modifier.hxx

   1 // Created on: 1993-08-26
   2 // Created by: Christian CAILLET
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IFSelect_Modifier_HeaderFile
  18 #define _IFSelect_Modifier_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <IFSelect_GeneralModifier.hxx>
  24 class IFSelect_ContextModif;
  25 class Interface_InterfaceModel;
  26 class Interface_Protocol;
  27 class Interface_CopyTool;
  28
  29
  30 class IFSelect_Modifier;
  31 DEFINE_STANDARD_HANDLE(IFSelect_Modifier, IFSelect_GeneralModifier)
  32
  33 //! This class gives a frame for Actions which can work globally
  34 //! on a File once completely defined (i.e. afterwards)
  35 //!
  36 //! Remark : if no Selection is set as criterium, the Modifier is
  37 //! set to work and should consider all the content of the Model
  38 //! produced.
  39 class IFSelect_Modifier : public IFSelect_GeneralModifier
  40 {
  41
  42 public:
  43
  44
  45   //! This deferred method defines the action specific to each class
  46   //! of Modifier. It is called by a ModelCopier, once the Model
  47   //! generated and filled. ModelCopier has already checked the
  48   //! criteria (Dispatch, Model Rank, Selection) before calling it.
  49   //!
  50   //! <ctx> detains information about original data and selection.
  51   //! The result of copying, on which modifications are to be done,
  52   //! is <target>.
  53   //! <TC> allows to run additional copies as required
  54   //!
  55   //! In case of Error, use methods CCheck from the ContextModif
  56   //! to aknowledge an entity Check or a Global Check with messages
  57   Standard_EXPORT virtual void Perform (IFSelect_ContextModif& ctx, const Handle(Interface_InterfaceModel)& target, const Handle(Interface_Protocol)& protocol, Interface_CopyTool& TC) const = 0;
  58
  59
  60
  61
  62   DEFINE_STANDARD_RTTIEXT(IFSelect_Modifier,IFSelect_GeneralModifier)
  63
  64 protected:
  65
  66
  67   //! Calls inherited Initialize, transmits to it the information
  68   //! <maychangegraph>
  69   Standard_EXPORT IFSelect_Modifier(const Standard_Boolean maychangegraph);
  70
  71
  72
  73 private:
  74
  75
  76
  77
  78 };
  79
  80
  81
  82
  83
  84
  85
  86 #endif // _IFSelect_Modifier_HeaderFile