summaryrefslogtreecommitdiff
path: root/inc/ShapeProcess_Context.hxx
blob: 8700a88a49723f6bee86c2fb35a4980d6b9606b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _ShapeProcess_Context_HeaderFile
#define _ShapeProcess_Context_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_ShapeProcess_Context_HeaderFile
#include <Handle_ShapeProcess_Context.hxx>
#endif

#ifndef _Handle_Resource_Manager_HeaderFile
#include <Handle_Resource_Manager.hxx>
#endif
#ifndef _Handle_TColStd_HSequenceOfHAsciiString_HeaderFile
#include <Handle_TColStd_HSequenceOfHAsciiString.hxx>
#endif
#ifndef _Handle_Message_Messenger_HeaderFile
#include <Handle_Message_Messenger.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _MMgt_TShared_HeaderFile
#include <MMgt_TShared.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
class Resource_Manager;
class TColStd_HSequenceOfHAsciiString;
class Message_Messenger;
class TCollection_AsciiString;


//! Provides convenient interface to resource file <br>
//!          Allows to load resource file and get values of <br>
//!          attributes starting from some scope, for example <br>
//!          if scope is defined as "ToV4" and requested parameter <br>
//!          is "exec.op", value of "ToV4.exec.op" parameter from <br>
//!          the resource file will be returned <br>
class ShapeProcess_Context : public MMgt_TShared {

public:

  //! Creates an empty tool <br>
  Standard_EXPORT   ShapeProcess_Context();
  //! Creates a new tool and initialises by name of <br>
//!          resource file and (if specified) starting scope <br>
//!          Calls method Init() <br>
  Standard_EXPORT   ShapeProcess_Context(const Standard_CString file,const Standard_CString scope = "");
  //! Initialises a tool by loading resource file and <br>
//!          (if specified) sets starting scope <br>
//!          Returns False if resource file not found <br>
  Standard_EXPORT     Standard_Boolean Init(const Standard_CString file,const Standard_CString scope = "") ;
  //! Loading Resource_Manager object if this object not <br>
//!          equal internal static Resource_Manager object or <br>
//!          internal static Resource_Manager object is null <br>
  Standard_EXPORT     Handle_Resource_Manager LoadResourceManager(const Standard_CString file) ;
  //! Returns internal Resource_Manager object <br>
  Standard_EXPORT    const Handle_Resource_Manager& ResourceManager() const;
  //! Set a new (sub)scope <br>
  Standard_EXPORT     void SetScope(const Standard_CString scope) ;
  //! Go out of current scope <br>
  Standard_EXPORT     void UnSetScope() ;
  //! Returns True if parameter is defined in the resource file <br>
  Standard_EXPORT     Standard_Boolean IsParamSet(const Standard_CString param) const;
  
  Standard_EXPORT     Standard_Boolean GetReal(const Standard_CString param,Standard_Real& val) const;
  
  Standard_EXPORT     Standard_Boolean GetInteger(const Standard_CString param,Standard_Integer& val) const;
  
  Standard_EXPORT     Standard_Boolean GetBoolean(const Standard_CString param,Standard_Boolean& val) const;
  //! Get value of parameter as being of specific type <br>
//!          Returns False if parameter is not defined or has a wrong type <br>
  Standard_EXPORT     Standard_Boolean GetString(const Standard_CString param,TCollection_AsciiString& val) const;
  
  Standard_EXPORT     Standard_Real RealVal(const Standard_CString param,const Standard_Real def) const;
  
  Standard_EXPORT     Standard_Integer IntegerVal(const Standard_CString param,const Standard_Integer def) const;
  
  Standard_EXPORT     Standard_Boolean BooleanVal(const Standard_CString param,const Standard_Boolean def) const;
  //! Get value of parameter as being of specific type <br>
//!          If parameter is not defined or does not have expected <br>
//!          type, returns default value as specified <br>
  Standard_EXPORT     Standard_CString StringVal(const Standard_CString param,const Standard_CString def) const;
  //! Sets Messenger used for outputting messages. <br>
  Standard_EXPORT     void SetMessenger(const Handle(Message_Messenger)& messenger) ;
  //! Returns Messenger used for outputting messages. <br>
  Standard_EXPORT     Handle_Message_Messenger Messenger() const;
  //! Sets trace level used for outputting messages <br>
//!           - 0: no trace at all <br>
//!           - 1: errors <br>
//!           - 2: errors and warnings <br>
//!           - 3: all messages <br>
//!           Default is 1 : Errors traced <br>
  Standard_EXPORT     void SetTraceLevel(const Standard_Integer tracelev) ;
  //! Returns trace level used for outputting messages. <br>
  Standard_EXPORT     Standard_Integer TraceLevel() const;




  DEFINE_STANDARD_RTTI(ShapeProcess_Context)

protected:




private: 


Handle_Resource_Manager myRC;
Handle_TColStd_HSequenceOfHAsciiString myScope;
Handle_Message_Messenger myMessenger;
Standard_Integer myTraceLev;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif