Files
OCCT/src/IGESSelect/IGESSelect_AddFileComment.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

72 lines
2.8 KiB
Plaintext
Executable File

-- Created on: 1994-08-26
-- Created by: Christian CAILLET
-- Copyright (c) 1994-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class AddFileComment from IGESSelect inherits FileModifier from IGESSelect
---Purpose : This class allows to add comment lines on writing an IGES File
-- These lines are added to Start Section, instead of the only
-- one blank line written by default.
uses CString, AsciiString from TCollection,
HSequenceOfHAsciiString from TColStd,
IGESWriter , ContextWrite
is
Create returns mutable AddFileComment;
---Purpose : Creates a new emoty AddFileComment. Use AddLine to complete it
Clear (me : mutable);
---Purpose : Clears the list of file comment lines already stored
AddLine (me : mutable; line : CString);
---Purpose : Adds a line for file comment
-- Remark : Lines are limited to 72 useful char.s . A line of more than
-- 72 char.s will be splited into several ones of 72 max each.
AddLines (me : mutable; lines : HSequenceOfHAsciiString from TColStd);
---Purpose : Adds a list of lines for file comment
-- Each of them must comply with demand of AddLine
NbLines (me) returns Integer;
---Purpose : Returns the count of stored lines
Line (me; num : Integer) returns CString;
---Purpose : Returns a stored line given its rank
Lines (me) returns HSequenceOfHAsciiString from TColStd;
---Purpose : Returns the complete list of lines in once
Perform (me; ctx : in out ContextWrite;
writer : in out IGESWriter);
---Purpose : Sends the comment lines to the file (Start Section)
Label (me) returns AsciiString from TCollection;
---Purpose : Returns specific Label, which is
-- "Add <nn> Comment Lines (Start Section)"
fields
thelist : HSequenceOfHAsciiString from TColStd;
end AddFileComment;