[occt.git] / src / IFSelect / IFSelect_Modifier.hxx

// Created on: 1993-08-26
// Created by: Christian CAILLET
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _IFSelect_Modifier_HeaderFile
#define _IFSelect_Modifier_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <IFSelect_GeneralModifier.hxx>
#include <Standard_Boolean.hxx>
class IFSelect_ContextModif;
class Interface_InterfaceModel;
class Interface_Protocol;
class Interface_CopyTool;


class IFSelect_Modifier;
DEFINE_STANDARD_HANDLE(IFSelect_Modifier, IFSelect_GeneralModifier)

//! 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.
class IFSelect_Modifier : public IFSelect_GeneralModifier
{

public:

  
  //! 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
  Standard_EXPORT virtual void Perform (IFSelect_ContextModif& ctx, const Handle(Interface_InterfaceModel)& target, const Handle(Interface_Protocol)& protocol, Interface_CopyTool& TC) const = 0;


  DEFINE_STANDARD_RTTIEXT(IFSelect_Modifier,IFSelect_GeneralModifier)

protected:

  
  //! Calls inherited Initialize, transmits to it the information
  //! <maychangegraph>
  Standard_EXPORT IFSelect_Modifier(const Standard_Boolean maychangegraph);


private:


};


#endif // _IFSelect_Modifier_HeaderFile
Commit	Line	Data
42cf5bc1	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	#include <Standard_Boolean.hxx>
	25	class IFSelect_ContextModif;
	26	class Interface_InterfaceModel;
	27	class Interface_Protocol;
	28	class Interface_CopyTool;
	29
	30
	31	class IFSelect_Modifier;
	32	DEFINE_STANDARD_HANDLE(IFSelect_Modifier, IFSelect_GeneralModifier)
	33
	34	//! This class gives a frame for Actions which can work globally
	35	//! on a File once completely defined (i.e. afterwards)
	36	//!
	37	//! Remark : if no Selection is set as criterium, the Modifier is
	38	//! set to work and should consider all the content of the Model
	39	//! produced.
	40	class IFSelect_Modifier : public IFSelect_GeneralModifier
	41	{
	42
	43	public:
	44
	45
	46	//! This deferred method defines the action specific to each class
	47	//! of Modifier. It is called by a ModelCopier, once the Model
	48	//! generated and filled. ModelCopier has already checked the
	49	//! criteria (Dispatch, Model Rank, Selection) before calling it.
	50	//!
	51	//! <ctx> detains informations about original data and selection.
	52	//! The result of copying, on which modifications are to be done,
	53	//! is <target>.
	54	//! <TC> allows to run additional copies as required
	55	//!
	56	//! In case of Error, use methods CCheck from the ContextModif
	57	//! to aknowledge an entity Check or a Global Check with messages
	58	Standard_EXPORT virtual void Perform (IFSelect_ContextModif& ctx, const Handle(Interface_InterfaceModel)& target, const Handle(Interface_Protocol)& protocol, Interface_CopyTool& TC) const = 0;
	59
	60
	61
	62
92efcf78	63	DEFINE_STANDARD_RTTIEXT(IFSelect_Modifier,IFSelect_GeneralModifier)
42cf5bc1	64
	65	protected:
	66
	67
	68	//! Calls inherited Initialize, transmits to it the information
	69	//! <maychangegraph>
	70	Standard_EXPORT IFSelect_Modifier(const Standard_Boolean maychangegraph);
	71
	72
	73
	74	private:
	75
	76
	77
	78
	79	};
	80
	81
	82
	83
	84
	85
	86
	87	#endif // _IFSelect_Modifier_HeaderFile