0024157: Parallelization of assembly part of BO
[occt.git] / src / XmlObjMgt / XmlObjMgt.cdl
CommitLineData
b311480e 1-- Created on: 2001-07-17
2-- Created by: Julia DOROVSKIKH <jfa@hotdox.nnov.matra-dtv.fr>
3-- Copyright (c) 2001-2012 OPEN CASCADE SAS
4--
5-- The content of this file is subject to the Open CASCADE Technology Public
6-- License Version 6.5 (the "License"). You may not use the content of this file
7-- except in compliance with the License. Please obtain a copy of the License
8-- at http://www.opencascade.org and read it completely before using this file.
9--
10-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12--
13-- The Original Code and all software distributed under the License is
14-- distributed on an "AS IS" basis, without warranty of any kind, and the
15-- Initial Developer hereby disclaims all such warranties, including without
16-- limitation, any warranties of merchantability, fitness for a particular
17-- purpose or non-infringement. Please see the License for the specific terms
18-- and conditions governing the rights and limitations under the License.
19
20--AGV 150202: Add parameter isClearText to SetStringValue()
7fd59977 21
22package XmlObjMgt
23
24---Purpose: This package defines services to manage the storage
25-- grain of data produced by applications and those classes
26-- to manage persistent extern reference.
27
28uses
29 TCollection, TColStd, gp
30
31is
32 class Persistent;
33 ---Purpose: root for XML-persistence
34
35 class GP;
36 ---Purpose: translation of gp objects
37
38 imported DOMString;
39 imported Document;
40 imported Element;
41
42 -- Storage Relocation Table
43 alias SRelocationTable is IndexedMapOfTransient from TColStd;
44
45 -- Retrieval Relocation Table
46 alias RRelocationTable is DataMapOfIntegerTransient from TColStd;
47
48 generic class Array1;
49
50 -- Package methods
51 IdString returns DOMString from XmlObjMgt;
52 ---C++: return const &
53 ---Purpose: Define the name of XMLattribute 'ID' (to be used everywhere)
54
55 SetExtendedString (theElement: in out Element from XmlObjMgt;
56 theString : ExtendedString from TCollection)
57 returns Boolean from Standard;
58 ---Purpose: Add attribute <theElement extstring="theString" ...>
59
60 GetExtendedString (theElement: Element from XmlObjMgt;
61 theString : out ExtendedString from TCollection)
62 returns Boolean from Standard;
63 ---Purpose: Get attribute <theElement extstring="theString" ...>
64
65 GetStringValue (theElement : Element from XmlObjMgt)
66 returns DOMString from XmlObjMgt;
67 ---Purpose: Returns the first child text node
68
69 SetStringValue (theElement : in out Element from XmlObjMgt;
70 theData : DOMString from XmlObjMgt;
71 isClearText: Boolean from Standard = Standard_False);
72 ---Purpose: Add theData as the last child text node to theElement
73 -- isClearText(True) avoids analysis of the string and replacement
74 -- of characters like '<' and '&' during XML file storage.
75 -- Do NEVER set isClearText unless you have a hell of a reason
76
77 GetTagEntryString (theTarget : DOMString from XmlObjMgt;
78 theTagEntry: out AsciiString from TCollection)
79 returns Boolean from Standard;
80 ---Purpose: Convert XPath expression (DOMString) into TagEntry string
81 -- returns False on Error
82
83 SetTagEntryString (theSource : out DOMString from XmlObjMgt;
84 theTagEntry: AsciiString from TCollection);
85 ---Purpose: Convert XPath expression (DOMString) into TagEntry string
86 -- returns False on Error
87
88 FindChildElement (theSource: Element from XmlObjMgt;
89 theObjId : Integer from Standard)
90 returns Element from XmlObjMgt;
91
92 FindChildByRef (theSource : Element from XmlObjMgt;
93 theRefName: DOMString from XmlObjMgt)
94 returns Element from XmlObjMgt;
95
96 FindChildByName (theSource : Element from XmlObjMgt;
97 theName : DOMString from XmlObjMgt)
98 returns Element from XmlObjMgt;
99
100 GetInteger (theString : in out CString from Standard;
101 theValue : in out Integer from Standard)
102 returns Boolean from Standard;
103
104 GetReal (theString : in out CString from Standard;
105 theValue : in out Real from Standard)
106 returns Boolean from Standard;
107
108 GetReal (theString : DOMString from XmlObjMgt;
109 theValue : in out Real from Standard)
110 returns Boolean from Standard;
111
112end XmlObjMgt;