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 <TCollection_HAsciiString.hxx>
0024 #include <NCollection_Sequence.hxx>
0025 #include <NCollection_HSequence.hxx>
0026 #include <IGESSelect_FileModifier.hxx>
0027 #include <Standard_Integer.hxx>
0028 class IFSelect_ContextWrite;
0029 class IGESData_IGESWriter;
0030 class TCollection_AsciiString;
0031
0032 //! This class allows to add comment lines on writing an IGES File
0033 //! These lines are added to Start Section, instead of the only
0034 //! one blank line written by default.
0035 class IGESSelect_AddFileComment : public IGESSelect_FileModifier
0036 {
0037
0038 public:
0039   //! Creates a new empty AddFileComment. Use AddLine to complete it
0040   Standard_EXPORT IGESSelect_AddFileComment();
0041
0042   //! Clears the list of file comment lines already stored
0043   Standard_EXPORT void Clear();
0044
0045   //! Adds a line for file comment
0046   //! Remark: Lines are limited to 72 useful chars. A line of more than
0047   //! 72 chars will be split into several ones of 72 max each.
0048   Standard_EXPORT void AddLine(const char* const line);
0049
0050   //! Adds a list of lines for file comment
0051   //! Each of them must comply with demand of AddLine
0052   Standard_EXPORT void AddLines(
0053     const occ::handle<NCollection_HSequence<occ::handle<TCollection_HAsciiString>>>& lines);
0054
0055   //! Returns the count of stored lines
0056   Standard_EXPORT int NbLines() const;
0057
0058   //! Returns a stored line given its rank
0059   Standard_EXPORT const char* Line(const int num) const;
0060
0061   //! Returns the complete list of lines in once
0062   Standard_EXPORT occ::handle<NCollection_HSequence<occ::handle<TCollection_HAsciiString>>> Lines()
0063     const;
0064
0065   //! Sends the comment lines to the file (Start Section)
0066   Standard_EXPORT void Perform(IFSelect_ContextWrite& ctx,
0067                                IGESData_IGESWriter&   writer) const override;
0068
0069   //! Returns specific Label, which is
0070   //! "Add <nn> Comment Lines (Start Section)"
0071   Standard_EXPORT TCollection_AsciiString Label() const override;
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESSelect_AddFileComment, IGESSelect_FileModifier)
0074
0075 private:
0076   occ::handle<NCollection_HSequence<occ::handle<TCollection_HAsciiString>>> thelist;
0077 };
0078
0079 #endif // _IGESSelect_AddFileComment_HeaderFile