1 -- File: ShapeProcess_Context.cdl
2 -- Created: Mon Aug 21 19:11:11 2000
3 -- Author: Andrey BETENEV
4 -- <abv@nnov.matra-dtv.fr>
5 ---Copyright: Matra Datavision 2000
8 class Context from ShapeProcess inherits TShared from MMgt
10 ---Purpose: Provides convenient interface to resource file
11 -- Allows to load resource file and get values of
12 -- attributes starting from some scope, for example
13 -- if scope is defined as "ToV4" and requested parameter
14 -- is "exec.op", value of "ToV4.exec.op" parameter from
15 -- the resource file will be returned
19 Manager from Resource,
20 AsciiString from TCollection,
21 HSequenceOfHAsciiString from TColStd,
22 Messenger from Message
27 ---Purpose: Creates an empty tool
29 Create (file: CString; scope: CString = "");
30 ---Purpose: Creates a new tool and initialises by name of
31 -- resource file and (if specified) starting scope
32 -- Calls method Init()
34 Init (me: mutable; file: CString; scope: CString = "")
36 ---Purpose: Initialises a tool by loading resource file and
37 -- (if specified) sets starting scope
38 -- Returns False if resource file not found
40 LoadResourceManager(me: mutable; file: CString) returns Manager from Resource;
41 ---Purpose: Loading Resource_Manager object if this object not
42 -- equal internal static Resource_Manager object or
43 -- internal static Resource_Manager object is null
45 ResourceManager (me) returns Manager from Resource;
46 ---Purpose: Returns internal Resource_Manager object
47 ---C++: return const &
49 SetScope (me: mutable; scope: CString);
50 ---Purpose: Set a new (sub)scope
52 UnSetScope (me: mutable);
53 ---Purpose: Go out of current scope
55 IsParamSet (me; param: CString) returns Boolean;
56 ---Purpose: Returns True if parameter is defined in the resource file
58 GetReal (me; param: CString; val: out Real ) returns Boolean;
59 GetInteger (me; param: CString; val: out Integer) returns Boolean;
60 GetBoolean (me; param: CString; val: out Boolean) returns Boolean;
61 GetString (me; param: CString; val: out AsciiString from TCollection) returns Boolean;
62 ---Purpose: Get value of parameter as being of specific type
63 -- Returns False if parameter is not defined or has a wrong type
65 RealVal (me; param: CString; def: Real ) returns Real;
66 IntegerVal (me; param: CString; def: Integer) returns Integer;
67 BooleanVal (me; param: CString; def: Boolean) returns Boolean;
68 StringVal (me; param: CString; def: CString) returns CString;
69 ---Purpose: Get value of parameter as being of specific type
70 -- If parameter is not defined or does not have expected
71 -- type, returns default value as specified
73 SetMessenger (me: mutable; messenger: Messenger from Message);
74 ---Purpose : Sets Messenger used for outputting messages.
76 Messenger (me) returns Messenger from Message;
77 ---Purpose : Returns Messenger used for outputting messages.
79 SetTraceLevel (me: mutable; tracelev: Integer);
80 ---Purpose : Sets trace level used for outputting messages
81 -- - 0: no trace at all
83 -- - 2: errors and warnings
85 -- Default is 1 : Errors traced
87 TraceLevel (me) returns Integer;
88 ---Purpose : Returns trace level used for outputting messages.
92 myRC: Manager from Resource;
93 myScope: HSequenceOfHAsciiString from TColStd;
94 myMessenger: Messenger from Message;