include/opencascade/IFSelect_Modifier.hxx

0001 // Created on: 1993-08-26
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IFSelect_Modifier_HeaderFile
0018 #define _IFSelect_Modifier_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IFSelect_GeneralModifier.hxx>
0024 class IFSelect_ContextModif;
0025 class Interface_InterfaceModel;
0026 class Interface_Protocol;
0027 class Interface_CopyTool;
0028
0029 //! This class gives a frame for Actions which can work globally
0030 //! on a File once completely defined (i.e. afterwards)
0031 //!
0032 //! Remark : if no Selection is set as criterium, the Modifier is
0033 //! set to work and should consider all the content of the Model
0034 //! produced.
0035 class IFSelect_Modifier : public IFSelect_GeneralModifier
0036 {
0037
0038 public:
0039   //! This deferred method defines the action specific to each class
0040   //! of Modifier. It is called by a ModelCopier, once the Model
0041   //! generated and filled. ModelCopier has already checked the
0042   //! criteria (Dispatch, Model Rank, Selection) before calling it.
0043   //!
0044   //! <ctx> detains information about original data and selection.
0045   //! The result of copying, on which modifications are to be done,
0046   //! is <target>.
0047   //! <TC> allows to run additional copies as required
0048   //!
0049   //! In case of Error, use methods CCheck from the ContextModif
0050   //! to acknowledge an entity Check or a Global Check with messages
0051   Standard_EXPORT virtual void Perform(IFSelect_ContextModif&                       ctx,
0052                                        const occ::handle<Interface_InterfaceModel>& target,
0053                                        const occ::handle<Interface_Protocol>&       protocol,
0054                                        Interface_CopyTool&                          TC) const = 0;
0055
0056   DEFINE_STANDARD_RTTIEXT(IFSelect_Modifier, IFSelect_GeneralModifier)
0057
0058 protected:
0059   //! Calls inherited Initialize, transmits to it the information
0060   //! <maychangegraph>
0061   Standard_EXPORT IFSelect_Modifier(const bool maychangegraph);
0062 };
0063
0064 #endif // _IFSelect_Modifier_HeaderFile