b311480e |
1 | -- Created on: 1994-08-26 |
2 | -- Created by: Christian CAILLET |
3 | -- Copyright (c) 1994-1999 Matra Datavision |
973c2be1 |
4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |
b311480e |
5 | -- |
973c2be1 |
6 | -- This file is part of Open CASCADE Technology software library. |
b311480e |
7 | -- |
d5f74e42 |
8 | -- This library is free software; you can redistribute it and/or modify it under |
9 | -- the terms of the GNU Lesser General Public License version 2.1 as published |
973c2be1 |
10 | -- by the Free Software Foundation, with special exception defined in the file |
11 | -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | -- distribution for complete text of the license and disclaimer of any warranty. |
b311480e |
13 | -- |
973c2be1 |
14 | -- Alternatively, this file may be used under the terms of Open CASCADE |
15 | -- commercial license or contractual agreement. |
7fd59977 |
16 | |
17 | class AddFileComment from IGESSelect inherits FileModifier from IGESSelect |
18 | |
19 | ---Purpose : This class allows to add comment lines on writing an IGES File |
20 | -- These lines are added to Start Section, instead of the only |
21 | -- one blank line written by default. |
22 | |
23 | uses CString, AsciiString from TCollection, |
24 | HSequenceOfHAsciiString from TColStd, |
25 | IGESWriter , ContextWrite |
26 | |
27 | is |
28 | |
6e33d3ce |
29 | Create returns AddFileComment; |
7fd59977 |
30 | ---Purpose : Creates a new emoty AddFileComment. Use AddLine to complete it |
31 | |
32 | Clear (me : mutable); |
33 | ---Purpose : Clears the list of file comment lines already stored |
34 | |
35 | AddLine (me : mutable; line : CString); |
36 | ---Purpose : Adds a line for file comment |
37 | -- Remark : Lines are limited to 72 useful char.s . A line of more than |
38 | -- 72 char.s will be splited into several ones of 72 max each. |
39 | |
40 | AddLines (me : mutable; lines : HSequenceOfHAsciiString from TColStd); |
41 | ---Purpose : Adds a list of lines for file comment |
42 | -- Each of them must comply with demand of AddLine |
43 | |
44 | NbLines (me) returns Integer; |
45 | ---Purpose : Returns the count of stored lines |
46 | |
47 | Line (me; num : Integer) returns CString; |
48 | ---Purpose : Returns a stored line given its rank |
49 | |
50 | Lines (me) returns HSequenceOfHAsciiString from TColStd; |
51 | ---Purpose : Returns the complete list of lines in once |
52 | |
53 | Perform (me; ctx : in out ContextWrite; |
54 | writer : in out IGESWriter); |
55 | ---Purpose : Sends the comment lines to the file (Start Section) |
56 | |
57 | Label (me) returns AsciiString from TCollection; |
58 | ---Purpose : Returns specific Label, which is |
59 | -- "Add <nn> Comment Lines (Start Section)" |
60 | |
61 | fields |
62 | |
63 | thelist : HSequenceOfHAsciiString from TColStd; |
64 | |
65 | end AddFileComment; |