0024784: Move documentation in CDL files to proper location
[occt.git] / src / Message / Message_ProgressSentry.cxx
1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #include <Message_ProgressSentry.ixx>
15
16 //=======================================================================
17 //function : Message_ProgressSentry
18 //purpose  : 
19 //=======================================================================
20
21 Message_ProgressSentry::Message_ProgressSentry (const Handle(Message_ProgressIndicator) &progress,
22                                                   const Standard_CString name,
23                                                   const Standard_Real min, 
24                                                   const Standard_Real max, 
25                                                   const Standard_Real step,
26                                                   const Standard_Boolean isInf,
27                                                   const Standard_Real newScopeSpan) :
28        myProgress(progress), myActive(!progress.IsNull())
29 {
30   if ( ! myActive ) return;
31   progress->SetName ( name );
32   progress->SetScale ( min, max, step, isInf );
33   progress->NewScope ( newScopeSpan >0 ? newScopeSpan : step );
34 }
35
36 //=======================================================================
37 //function : Message_ProgressSentry
38 //purpose  : 
39 //=======================================================================
40
41 Message_ProgressSentry::Message_ProgressSentry (const Handle(Message_ProgressIndicator) &progress,
42                                                   const Handle(TCollection_HAsciiString) &name,
43                                                   const Standard_Real min, 
44                                                   const Standard_Real max, 
45                                                   const Standard_Real step,
46                                                   const Standard_Boolean isInf,
47                                                   const Standard_Real newScopeSpan) :
48        myProgress(progress), myActive(!progress.IsNull())
49 {
50   if ( ! myActive ) return;
51   progress->SetName ( name );
52   progress->SetScale ( min, max, step, isInf );
53   progress->NewScope ( newScopeSpan >0 ? newScopeSpan : step );
54 }