1 -- Created on: 1998-01-15
2 -- Created by: Denis PASCAL
3 -- Copyright (c) 1998-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
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.
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.
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.
23 class Comment from TDataStd inherits Attribute from TDF
25 ---Purpose: Comment attribute. may be associated to any label
26 -- to store user comment.
28 uses Attribute from TDF,
31 ExtendedString from TCollection,
33 RelocationTable from TDF,
34 AttributeSequence from TDF,
41 ---Purpose: class methods
45 ---C++: return const &
46 ---Purpose: Returns the GUID for comments.
47 returns GUID from Standard;
49 Set (myclass; label : Label from TDF)
50 ---Purpose: Find, or create a Comment attribute. the Comment
51 -- attribute is returned.
52 returns Comment from TDataStd;
54 Set (myclass; label : Label from TDF; string : ExtendedString from TCollection)
55 ---Purpose: Finds, or creates a Comment attribute and sets the string.
56 -- the Comment attribute is returned.
57 returns Comment from TDataStd;
59 ---Purpose: Comment methods
63 returns mutable Comment from TDataStd;
65 Set (me : mutable; S : ExtendedString from TCollection);
69 returns ExtendedString from TCollection;
71 -- Returns the comment attribute.
72 ---C++: return const &
74 ---Category: TDF_Attribute methods
75 -- =====================
78 ---C++: return const &
79 returns GUID from Standard;
81 Restore (me: mutable; with : Attribute from TDF);
84 returns mutable Attribute from TDF;
86 Paste (me; into : mutable Attribute from TDF;
87 RT : mutable RelocationTable from TDF);
89 Dump(me; anOS : in out OStream from Standard)
90 returns OStream from Standard
94 AfterRetrieval(me: mutable;
95 forceIt : Boolean from Standard = Standard_False)
96 returns Boolean from Standard
102 myString : ExtendedString from TCollection;