0024830: Remove redundant keyword 'mutable' in CDL declarations
[occt.git] / src / TDataXtd / TDataXtd_Point.cdl
CommitLineData
b311480e 1-- Created on: 2009-04-06
2-- Created by: Sergey ZARITCHNY
973c2be1 3-- Copyright (c) 2009-2014 OPEN CASCADE SAS
b311480e 4--
973c2be1 5-- This file is part of Open CASCADE Technology software library.
b311480e 6--
d5f74e42 7-- This library is free software; you can redistribute it and/or modify it under
8-- the terms of the GNU Lesser General Public License version 2.1 as published
973c2be1 9-- by the Free Software Foundation, with special exception defined in the file
10-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11-- distribution for complete text of the license and disclaimer of any warranty.
b311480e 12--
973c2be1 13-- Alternatively, this file may be used under the terms of Open CASCADE
14-- commercial license or contractual agreement.
7fd59977 15
16class Point from TDataXtd inherits Attribute from TDF
17
18 ---Purpose:
19 -- The basis to define a point attribute.
20 -- The topological attribute must contain a vertex.
21 -- You use this class to create reference points in a design.
22 --
23 -- Warning: Use TDataXtd_Geometry attribute to retrieve the
24 -- gp_Pnt of the Point attribute
25
26uses Attribute from TDF,
27 Label from TDF,
28 GUID from Standard,
29 Pnt from gp,
30 DataSet from TDF,
31 RelocationTable from TDF
32
33is
34
35
36 ---Purpose: class methods
37 -- =============
38
39 GetID(myclass)
40 ---C++: return const &
41 returns GUID from Standard;
42 ---Purpose:
43 -- Returns the GUID for point attributes.
44
45 Set (myclass ; label : Label from TDF)
46 ---Purpose:
47 -- Sets the label Label as a point attribute.
48 -- If no object is found, a point attribute is created.
49 returns Point from TDataXtd;
50
51 Set (myclass ; label : Label from TDF; P : Pnt from gp)
52 ---Purpose:
53 -- Sets the label Label as a point attribute containing the point P.
54 -- If no object is found, a point attribute is created.
55 returns Point from TDataXtd;
56
57 ---Purpose: Point methods
58 -- =============
59
60 Create
6e33d3ce 61 returns Point from TDataXtd;
7fd59977 62
63 ---Category: TDF_Attribute methods
64 -- =====================
65
66
67 ID (me)
68 ---C++: return const &
69 returns GUID from Standard;
70
71 Restore (me: mutable; With : Attribute from TDF);
72
73 NewEmpty (me)
6e33d3ce 74 returns Attribute from TDF;
7fd59977 75
6e33d3ce 76 Paste (me; Into : Attribute from TDF;
77 RT : RelocationTable from TDF);
7fd59977 78
79 Dump (me; anOS : in out OStream from Standard)
80 returns OStream from Standard
81 is redefined;
82 ---C++: return &
83
84end Point;
85