0031687: Draw Harness, ViewerTest - extend command vrenderparams with option updating...
[occt.git] / src / Transfer / Transfer_DispatchControl.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-06-17
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 _Transfer_DispatchControl_HeaderFile
18#define _Transfer_DispatchControl_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Interface_CopyControl.hxx>
24#include <Standard_Boolean.hxx>
25class Transfer_TransientProcess;
26class Interface_InterfaceModel;
27class Interface_InterfaceError;
28class Standard_Transient;
29
30
31class Transfer_DispatchControl;
32DEFINE_STANDARD_HANDLE(Transfer_DispatchControl, Interface_CopyControl)
33
34//! This is an auxiliary class for TransferDispatch, which allows
35//! to record simple copies, as CopyControl from Interface, but
36//! based on a TransientProcess. Hence, it allows in addition
37//! more actions (such as recording results of adaptations)
38class Transfer_DispatchControl : public Interface_CopyControl
39{
40
41public:
42
43
44 //! Creates the DispatchControl, ready for use
45 Standard_EXPORT Transfer_DispatchControl(const Handle(Interface_InterfaceModel)& model, const Handle(Transfer_TransientProcess)& TP);
46
47 //! Returns the content of the DispatchControl : it can be used
48 //! for a direct call, if the basic methods do not suffice
49 Standard_EXPORT const Handle(Transfer_TransientProcess)& TransientProcess() const;
50
51 //! Returns the Model from which the transfer is to be done
52 Standard_EXPORT const Handle(Interface_InterfaceModel)& StartingModel() const;
53
54 //! Clears the List of Copied Results
79104795 55 Standard_EXPORT void Clear() Standard_OVERRIDE;
42cf5bc1 56
57 //! Binds a (Transient) Result to a (Transient) Starting Entity
79104795 58 Standard_EXPORT void Bind (const Handle(Standard_Transient)& ent, const Handle(Standard_Transient)& res) Standard_OVERRIDE;
42cf5bc1 59
60 //! Searches for the Result bound to a Starting Entity
61 //! If Found, returns True and fills <res>
62 //! Else, returns False and nullifies <res>
79104795 63 Standard_EXPORT Standard_Boolean Search (const Handle(Standard_Transient)& ent, Handle(Standard_Transient)& res) const Standard_OVERRIDE;
42cf5bc1 64
65
66
67
92efcf78 68 DEFINE_STANDARD_RTTIEXT(Transfer_DispatchControl,Interface_CopyControl)
42cf5bc1 69
70protected:
71
72
73
74
75private:
76
77
78 Handle(Transfer_TransientProcess) theTP;
79 Handle(Interface_InterfaceModel) themodel;
80
81
82};
83
84
85
86
87
88
89
90#endif // _Transfer_DispatchControl_HeaderFile