0023570: Command param in DRAW outputs non-readable symbols
[occt.git] / src / MoniTool / MoniTool_Elem.cdl
CommitLineData
b311480e 1-- Created on: 1994-11-04
2-- Created by: Christian CAILLET
3-- Copyright (c) 1994-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23generic class Elem from MoniTool
24 (TheKey as any;
25 TheHasher as any;
26 TheInfo as any)
27 inherits Element
28
29 ---Purpose : an Elem defines an Element for a specific input class
30 -- its definition includes the value of the Key to be mapped,
31 -- and the HashCoder associated to the class of the Key
32 --
33 -- TheKey defines the class to be keyed
34 -- TheHasher is the associated Hasher
35 -- TheInfo is an additionnal class which helps to provide
36 -- informations on the value (template : see DataInfo)
37
38uses CString
39
40is
41
42 Create (akey : any TheKey) returns mutable Elem;
43 ---Purpose : Creates a Elem with a Value. This Value can then not be
44 -- changed. It is used by the Hasher to compute the HashCode,
45 -- which will then be stored for an immediate reading.
46
47 Value (me) returns any TheKey is static;
48 ---Purpose : Returns the contained value
49 ---C++ : return const &
50
51 Equates (me; other : Element) returns Boolean;
52 ---Purpose : Specific testof equallity : defined as False if <other> has
53 -- not the same true Type, else contents are compared (by
54 -- C++ operator ==)
55
56 ValueType (me) returns Type is redefined;
57 ---Purpose : Returns the Type of the Value. By default, returns the
58 -- DynamicType of <me>, but can be redefined
59
60 ValueTypeName (me) returns CString is redefined;
61 ---Purpose : Returns the name of the Type of the Value. Default is name
62 -- of ValueType, unless it is for a non-handled object
63
64fields
65
66 theval : TheKey;
67
68end Elem;