0025748: Parallel version of progress indicator
[occt.git] / src / Transfer / Transfer_ActorDispatch.hxx
1 // Created on: 1994-05-24
2 // Created by: Christian CAILLET
3 // Copyright (c) 1994-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 _Transfer_ActorDispatch_HeaderFile
18 #define _Transfer_ActorDispatch_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Transfer_TransferDispatch.hxx>
24 #include <Transfer_ActorOfTransientProcess.hxx>
25 class Interface_InterfaceError;
26 class Interface_InterfaceModel;
27 class Interface_GeneralLib;
28 class Interface_Protocol;
29 class Transfer_ActorOfTransientProcess;
30 class Transfer_TransferDispatch;
31 class Transfer_Binder;
32 class Standard_Transient;
33 class Transfer_TransientProcess;
34
35
36 class Transfer_ActorDispatch;
37 DEFINE_STANDARD_HANDLE(Transfer_ActorDispatch, Transfer_ActorOfTransientProcess)
38
39 //! This class allows to work with a TransferDispatch, i.e. to
40 //! transfer entities from a data set to another one defined by
41 //! the same interface norm, with the following features :
42 //! - ActorDispatch itself acts as a default actor, i.e. it copies
43 //! entities with the general service Copy, as CopyTool does
44 //! - it allows to add other actors for specific ways of transfer,
45 //! which may include data modifications, conversions ...
46 //! - and other features from TransferDispatch (such as mapping
47 //! other than one-one)
48 class Transfer_ActorDispatch : public Transfer_ActorOfTransientProcess
49 {
50
51 public:
52
53   
54   //! Creates an ActorDispatch from a Model. Works with a General
55   //! Service Library, given as an Argument
56   //! This causes TransferDispatch and its TransientProcess to be
57   //! created, with default actor <me>
58   Standard_EXPORT Transfer_ActorDispatch(const Handle(Interface_InterfaceModel)& amodel, const Interface_GeneralLib& lib);
59   
60   //! Same as above, but Library is defined through a Protocol
61   Standard_EXPORT Transfer_ActorDispatch(const Handle(Interface_InterfaceModel)& amodel, const Handle(Interface_Protocol)& protocol);
62   
63   //! Same as above, but works with the Active Protocol
64   Standard_EXPORT Transfer_ActorDispatch(const Handle(Interface_InterfaceModel)& amodel);
65   
66   //! Utility which adds an actor to the default <me> (it calls
67   //! SetActor from the TransientProcess)
68   Standard_EXPORT void AddActor (const Handle(Transfer_ActorOfTransientProcess)& actor);
69   
70   //! Returns the TransferDispatch, which does the work, records
71   //! the intermediate data, etc...
72   //! See TransferDispatch & CopyTool, to see the available methods
73   Standard_EXPORT Transfer_TransferDispatch& TransferDispatch();
74   
75   //! Specific action : it calls the method Transfer from CopyTool
76   //! i.e. the general service Copy, then returns the Binder
77   //! produced by the TransientProcess
78   Standard_EXPORT virtual Handle(Transfer_Binder) Transfer
79                    (const Handle(Standard_Transient)& start,
80                     const Handle(Transfer_TransientProcess)& TP,
81                     const Message_ProgressRange& theProgress = Message_ProgressRange()) Standard_OVERRIDE;
82
83
84
85
86   DEFINE_STANDARD_RTTIEXT(Transfer_ActorDispatch,Transfer_ActorOfTransientProcess)
87
88 protected:
89
90
91
92
93 private:
94
95
96   Transfer_TransferDispatch thetool;
97
98
99 };
100
101
102
103
104
105
106
107 #endif // _Transfer_ActorDispatch_HeaderFile