include/opencascade/IGESSelect_AddFileComment.hxx

0001 // Created on: 1994-08-26
0002 // Created by: Christian CAILLET
0003 // Copyright (c) 1994-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESSelect_AddFileComment_HeaderFile
0018 #define _IGESSelect_AddFileComment_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TColStd_HSequenceOfHAsciiString.hxx>
0024 #include <IGESSelect_FileModifier.hxx>
0025 #include <Standard_Integer.hxx>
0026 class IFSelect_ContextWrite;
0027 class IGESData_IGESWriter;
0028 class TCollection_AsciiString;
0029
0030
0031 class IGESSelect_AddFileComment;
0032 DEFINE_STANDARD_HANDLE(IGESSelect_AddFileComment, IGESSelect_FileModifier)
0033
0034 //! This class allows to add comment lines on writing an IGES File
0035 //! These lines are added to Start Section, instead of the only
0036 //! one blank line written by default.
0037 class IGESSelect_AddFileComment : public IGESSelect_FileModifier
0038 {
0039
0040 public:
0041
0042
0043   //! Creates a new empty AddFileComment. Use AddLine to complete it
0044   Standard_EXPORT IGESSelect_AddFileComment();
0045
0046   //! Clears the list of file comment lines already stored
0047   Standard_EXPORT void Clear();
0048
0049   //! Adds a line for file comment
0050   //! Remark : Lines are limited to 72 useful char.s . A line of more than
0051   //! 72 char.s will be splited into several ones of 72 max each.
0052   Standard_EXPORT void AddLine (const Standard_CString line);
0053
0054   //! Adds a list of lines for file comment
0055   //! Each of them must comply with demand of AddLine
0056   Standard_EXPORT void AddLines (const Handle(TColStd_HSequenceOfHAsciiString)& lines);
0057
0058   //! Returns the count of stored lines
0059   Standard_EXPORT Standard_Integer NbLines() const;
0060
0061   //! Returns a stored line given its rank
0062   Standard_EXPORT Standard_CString Line (const Standard_Integer num) const;
0063
0064   //! Returns the complete list of lines in once
0065   Standard_EXPORT Handle(TColStd_HSequenceOfHAsciiString) Lines() const;
0066
0067   //! Sends the comment lines to the file (Start Section)
0068   Standard_EXPORT void Perform (IFSelect_ContextWrite& ctx, IGESData_IGESWriter& writer) const Standard_OVERRIDE;
0069
0070   //! Returns specific Label, which is
0071   //! "Add <nn> Comment Lines (Start Section)"
0072   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
0073
0074
0075
0076
0077   DEFINE_STANDARD_RTTIEXT(IGESSelect_AddFileComment,IGESSelect_FileModifier)
0078
0079 protected:
0080
0081
0082
0083
0084 private:
0085
0086
0087   Handle(TColStd_HSequenceOfHAsciiString) thelist;
0088
0089
0090 };
0091
0092
0093
0094
0095
0096
0097
0098 #endif // _IGESSelect_AddFileComment_HeaderFile